Back to SuperOfficeUpdate the Blob that describes the given contact's picture.
The actual bitmap is accessible via /api/v1/contact/123/image.
Input
type: object
properties:
parameters:
type: object
properties:
contactId:
type: string
description: Contact id
imageInfo:
description: "Carrier object for BlobEntity.\r\nServices for the BlobEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IBLOBAgent\">BLOB Agent</see>."
type: object
properties:
BlobId:
format: int32
description: Primary key
type: integer
BlobSize:
format: int32
description: >-
The length, in bytes, of the binary data AS STORED after any
encryption and/or zipping. Important to get right, since some
databases will not tell us just based on the blob itself!
type: integer
Description:
description: A description that is entered by the user, and visible to the user
type: string
ExtraInfo:
description: >-
Extra information, spare field, can be used for anything that
makes sense. Should not refer to any particular context, that is
something for the BinaryObjectLInk
type: string
IsEncrypted:
description: Has the data been encrypted.
type: boolean
IsZipped:
description: Has the data been zipped.
type: boolean
MimeType:
description: Mime type, describing the technical type (image/jpeg) of the data
type: string
OriginalSize:
format: int32
description: >-
Original size of the binary data, before encryption and/or
zipping. This is what the ultimate client will get
type: integer
CreatedDate:
format: date-time
description: Registered when in UTC.
type: string
UpdatedDate:
format: date-time
description: Last updated when in UTC.
type: string
CreatedBy:
description: >-
The person that first created the document. The property is
read-only.
type: object
properties:
AssociateId:
format: int32
description: Primary key
type: integer
Name:
description: Initials, also login name, possibly database user name
type: string
PersonId:
format: int32
description: "Owning person record \r\n<para>Use MDO List name \"person\" to get list items.</para>"
type: integer
Rank:
format: int32
description: Rank order
type: integer
Tooltip:
description: Tooltip or other description
type: string
Type:
description: >-
User type - 1 = internal user, 2 = resource, 3 = external
user, 4 = anonymous, 5 = system
enum:
- Unknown
- InternalAssociate
- ResourceAssociate
- ExternalAssociate
- AnonymousAssociate
- SystemAssociate
type: string
GroupIdx:
format: int32
description: >-
Primary group membership, see UserGroupLink for secondary
memberships
type: integer
FullName:
description: >-
The associate's culture formatted fullname (firstname,
middleName and lastname)
type: string
FormalName:
description: >-
The associate's culture formatted formalname (firstname,
middleName and lastname, title, mrmrs)
type: string
Deleted:
description: >-
If true, the user is retired and should have no rights, not
appear in lists, etc.
type: boolean
EjUserId:
format: int32
description: >-
ID of the ej user record corresponding to this associate; 0
for associates that are not ej users
type: integer
UserName:
description: User name
type: string
TableRight:
type: object
properties:
Mask:
enum:
- None
- Select
- Update
- Insert
- Delete
- Filtering
- RestrictedUpdate
- Unused1
- Uninitialized
- FULL
- WRITE
- URU
- UDR
- UR
- URI
- R
- RI
- RF
- F
- FI
type: string
Reason:
type: string
FieldProperties:
type: object
additionalProperties:
type: object
properties:
FieldRight:
type: object
properties:
Mask:
enum:
- None
- Read
- Write
- Update
- Unused1
- Unused2
- Unused3
- Unused4
- Nullable
- UIHintMandatory
- UIHintReadOnly
- FULL
- UIHints
type: string
Reason:
type: string
FieldType:
type: string
FieldLength:
format: int32
type: integer
UpdatedBy:
description: The person that last updated the appointment.
type: object
properties:
AssociateId:
format: int32
description: Primary key
type: integer
Name:
description: Initials, also login name, possibly database user name
type: string
PersonId:
format: int32
description: "Owning person record \r\n<para>Use MDO List name \"person\" to get list items.</para>"
type: integer
Rank:
format: int32
description: Rank order
type: integer
Tooltip:
description: Tooltip or other description
type: string
Type:
description: >-
User type - 1 = internal user, 2 = resource, 3 = external
user, 4 = anonymous, 5 = system
enum:
- Unknown
- InternalAssociate
- ResourceAssociate
- ExternalAssociate
- AnonymousAssociate
- SystemAssociate
type: string
GroupIdx:
format: int32
description: >-
Primary group membership, see UserGroupLink for secondary
memberships
type: integer
FullName:
description: >-
The associate's culture formatted fullname (firstname,
middleName and lastname)
type: string
FormalName:
description: >-
The associate's culture formatted formalname (firstname,
middleName and lastname, title, mrmrs)
type: string
Deleted:
description: >-
If true, the user is retired and should have no rights, not
appear in lists, etc.
type: boolean
EjUserId:
format: int32
description: >-
ID of the ej user record corresponding to this associate; 0
for associates that are not ej users
type: integer
UserName:
description: User name
type: string
TableRight:
type: object
properties:
Mask:
enum:
- None
- Select
- Update
- Insert
- Delete
- Filtering
- RestrictedUpdate
- Unused1
- Uninitialized
- FULL
- WRITE
- URU
- UDR
- UR
- URI
- R
- RI
- RF
- F
- FI
type: string
Reason:
type: string
FieldProperties:
type: object
additionalProperties:
type: object
properties:
FieldRight:
type: object
properties:
Mask:
enum:
- None
- Read
- Write
- Update
- Unused1
- Unused2
- Unused3
- Unused4
- Nullable
- UIHintMandatory
- UIHintReadOnly
- FULL
- UIHints
type: string
Reason:
type: string
FieldType:
type: string
FieldLength:
format: int32
type: integer
ConceptualType:
description: >-
The type, for instance PHOTO, PERSONPHOTO, or whatever, that is
descriptive of what kind of image or data this is
type: string
TableRight:
type: object
properties:
Mask:
enum:
- None
- Select
- Update
- Insert
- Delete
- Filtering
- RestrictedUpdate
- Unused1
- Uninitialized
- FULL
- WRITE
- URU
- UDR
- UR
- URI
- R
- RI
- RF
- F
- FI
type: string
Reason:
type: string
FieldProperties:
type: object
additionalProperties:
type: object
properties:
FieldRight:
type: object
properties:
Mask:
enum:
- None
- Read
- Write
- Update
- Unused1
- Unused2
- Unused3
- Unused4
- Nullable
- UIHintMandatory
- UIHintReadOnly
- FULL
- UIHints
type: string
Reason:
type: string
FieldType:
type: string
FieldLength:
format: int32
type: integer
Accept-Language:
type: string
description: >-
Convert string references and multi-language values into a specified
language (iso2) code.
SO-Language:
type: string
description: >-
Convert string references and multi-language values into a specified
language (iso2) code. Overrides Accept-Language value.
SO-Culture:
type: string
description: >-
Number, date formatting in a specified culture (iso2 language) code.
Partially overrides SO-Language/Accept-Language value. Ignored if no
Language set.
SO-TimeZone:
type: string
description: >-
Specify the timezone code that you would like date/time responses
converted to.
SO-AppToken:
type: string
description: >-
The application token that identifies the partner app. Used when
calling Online WebAPI from a server.
required:
- contactId
- imageInfo
title: Parameters