SOAP API method WebDocument_file
Description
A single file of the document.
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 |
identifier * | string | |
login | Structure of type 'login' | Optional login data (soon deprecated) |
access_token | string | Optional api access token |
* required parameters |
Return values
Name | Type | Description |
---|---|---|
webdocumentfile | Structure of type 'webdocumentfile' | |
emailingdocumentfile | Structure of type 'emailingdocumentfile' |
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 'webdocumentfile'
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 'emailingdocumentfile'
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. |