SOAP API method EmailingDocumentSnapshotLink_object

Back to API references

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
Parameter 'id' : int
Unique identifier (id) of the object EmailingDocumentSnapshotLink. The method only applies to the emailingdocumentsnapshotlink 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 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'pdfdocument' : Structure of type 'pdfdocument'
Return value 'file' : Structure of type 'file'
Return value 'image' : Structure of type 'image'

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 'pdfdocument'
This structure pdfdocument was mentioned above. This structure has the following properties:
Property 'status' : string
Status of the document.
Property 'pagecount' : int
The number of pages in the document.
Property 'size' : int
The size of the document.
Property 'faxheader' : string
The headerline above the fax.
Property 'temporary' : boolean
Is this document set as a temporary document. The document will be removed when there are no
Property 'id' : int
The ID of the document.
Property 'templateID' : int
The template ID of the document
Property 'name' : string
The name of the document.
Property 'description' : string
The description of the document.
Property 'archived' : boolean
Is this an archived document?.
Property 'created' : timestamp
The date and time when the document was created.
Property 'modified' : timestamp
The date and time when the document was last modified.
Property 'language' : string
The language of the document.
Property 'timezone' : string
Get the time zone of the document. If the timezone is not set, it returns

Structure 'file'
This structure file was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the file.
Property 'mimetype' : string
The mimetype of the file.
Property 'hashcode' : string
Expose the file hashcode
Property 'data' : binary
The data of the file. The data is base64 encoded.
Property 'name' : string
The filename of the file.
Property 'size' : int
The size of the file.

Structure 'image'
This structure image 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.