SOAP API method WebDocument_createImage
Description
This method will add an image that is linked to the document directly.
Parameters
| Name | Type | Description |
|---|---|---|
| id * | int | Unique identifier (id) of the object WebDocument. The method only applies to the webdocument with this id. |
| personalize_profile | int | Profile ID for which the object should be personalized |
| personalize_subprofile | int | Subprofile ID for which the object should be personalized |
| personalize_timestamp | string | The timestamp for the personalization |
| filedata * | Structure of type 'filedata' | |
| metadata * | Collection of type 'metadata' | |
| login | Structure of type 'login' | Optional login data (soon deprecated) |
| access_token | string | Optional api access token |
| * required parameters | ||
Return values
| Name | Type | Description |
|---|---|---|
| webdocumentimage | Structure of type 'webdocumentimage' | |
| emailingdocumentimage | Structure of type 'emailingdocumentimage' |
Structure 'filedata'
| Name | Type | Description |
|---|---|---|
| name | string | The name of the data of the file. |
| mimetype | string | The mimetype of the data of the file. |
| data | binary | The data of the file. The data is base64 encoded. |
Structure 'pair'
| Name | Type | Description |
|---|---|---|
| key | string | |
| value | string |
Structure 'metadata'
| Name | Type | Description |
|---|---|---|
| pair | Structure of type 'pair' |
Structure 'login'
| Name | Type | Description |
|---|---|---|
| username | string | The username of the login attempt |
| account | string | The account name of the login attempt |
| password | string | The password for the login attempt |
Structure 'webdocumentimage'
| Name | Type | Description |
|---|---|---|
| id | int | The ID of the image. |
| name | string | The filename of the image. |
| extension | string | The extension of this image. |
| width | int | The width of the image. |
| height | int | The height of the image. |
| size | int | The size of the image. |
| hashcode | string | Expose the data hashcode |
| data | binary | The data of the image. The data is base64 encoded. |
| mimetype | string | The mime type of the image. |
| thumbwidth | int | The width of the thumbnail of the image. |
| thumbheight | int | The height of the thumbnail of the image. |
| thumbdata | binary | The data of the thumbnail of the image. The data is base64 encoded. |
Structure 'emailingdocumentimage'
| Name | Type | Description |
|---|---|---|
| id | int | The ID of the image. |
| name | string | The filename of the image. |
| extension | string | The extension of this image. |
| width | int | The width of the image. |
| height | int | The height of the image. |
| size | int | The size of the image. |
| hashcode | string | Expose the data hashcode |
| data | binary | The data of the image. The data is base64 encoded. |
| mimetype | string | The mime type of the image. |
| thumbwidth | int | The width of the thumbnail of the image. |
| thumbheight | int | The height of the thumbnail of the image. |
| thumbdata | binary | The data of the thumbnail of the image. The data is base64 encoded. |