SOAP API method WebDocument_image
Description
A single image of the document.
Parameters
- Parameter 'id' : int
- Unique identifier (id) of the object WebDocument. The method only applies to the webdocument with this id.
- Parameter 'personalize_profile' : int
- Profile ID for which the object should be personalized
- Parameter 'personalize_subprofile' : int
- Subprofile ID for which the object should be personalized
- Parameter 'personalize_timestamp' : string
- The timestamp for the personalization
- Parameter 'identifier' : string
- Parameter 'login' : Structure of type 'login'
- Optional login data
Return values
- Return value 'emailingdocumentimage' : Structure of type 'emailingdocumentimage'
- Return value 'webdocumentimage' : Structure of type 'webdocumentimage'
Structure 'login'
This structure login was mentioned above. This structure has the following properties:
- Property 'username' : string
- The username of the login attempt
- Property 'account' : string
- The account name of the login attempt
- Property 'password' : string
- The password for the login attempt
Structure 'emailingdocumentimage'
This structure emailingdocumentimage was mentioned above. This structure has the following properties:
- Property 'id' : int
- The ID of the image.
- Property 'name' : string
- The filename of the image.
- Property 'extension' : string
- The extension of this image.
- Property 'width' : int
- The width of the image.
- Property 'height' : int
- The height of the image.
- Property 'hashcode' : string
- Expose the data hashcode
- Property 'data' : binary
- The data of the image. The data is base64 encoded.
- Property 'mimetype' : string
- The mime type of the image.
- Property 'thumbwidth' : int
- The width of the thumbnail of the image.
- Property 'thumbheight' : int
- The height of the thumbnail of the image.
- Property 'thumbdata' : binary
- The data of the thumnail of the image. The data is base64 encoded.
Structure 'webdocumentimage'
This structure webdocumentimage was mentioned above. This structure has the following properties:
- Property 'id' : int
- The ID of the image.
- Property 'name' : string
- The filename of the image.
- Property 'extension' : string
- The extension of this image.
- Property 'width' : int
- The width of the image.
- Property 'height' : int
- The height of the image.
- Property 'hashcode' : string
- Expose the data hashcode
- Property 'data' : binary
- The data of the image. The data is base64 encoded.
- Property 'mimetype' : string
- The mime type of the image.
- Property 'thumbwidth' : int
- The width of the thumbnail of the image.
- Property 'thumbheight' : int
- The height of the thumbnail of the image.
- Property 'thumbdata' : binary
- The data of the thumnail of the image. The data is base64 encoded.