SOAP API method EmailingDocumentSnapshotLink_object
Description
environent, like a PDF document, an Image or a File. If that is the case, this method returns the object that the link refers to. Otherwise, this object returns NULL
Parameters
| Name | Type | Description |
|---|---|---|
| id * | int | Unique identifier (id) of the object EmailingDocumentSnapshotLink. The method only applies to the emailingdocumentsnapshotlink 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 |
| login | Structure of type 'login' | Optional login data (soon deprecated) |
| access_token | string | Optional api access token |
| * required parameters | ||
Return values
| Name | Type | Description |
|---|---|---|
| pdfdocument | Structure of type 'pdfdocument' | |
| file | Structure of type 'file' | |
| image | Structure of type 'image' |
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 'pdfdocument'
| Name | Type | Description |
|---|---|---|
| status | string | Status of the document. |
| pagecount | int | The number of pages in the document. |
| size | int | The size of the document. |
| faxheader | string | The headerline above the fax. |
| temporary | boolean | Is this document set as a temporary document. The document will be removed when there are no |
| id | int | The ID of the document. |
| templateID | int | The template ID of the document |
| name | string | The name of the document. |
| description | string | The description of the document. |
| archived | boolean | Is this an archived document?. |
| created | timestamp | The date and time when the document was created. |
| modified | timestamp | The date and time when the document was last modified. |
| language | string | The language of the document. |
| timezone | string | Get the time zone of the document. If the timezone is not set, it returns |
Structure 'file'
| Name | Type | Description |
|---|---|---|
| id | int | The ID of the file. |
| mimetype | string | The mimetype of the file. |
| hashcode | string | Expose the file hashcode |
| data | binary | The data of the file. The data is base64 encoded. |
| name | string | The filename of the file. |
| size | int | The size of the file. |
Structure 'image'
| 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. |