SOAP API method Account_emailingDocuments

Back to API references

Description
This function gives access to the documents belonging to this account

Parameters
Parameter 'order' : string
orderby, documentfields
Parameter 'asc' : boolean
asc, default true
Parameter 'options' : Collection of type 'options'
Array with search options where the following fields are allowed: The following fields are allowed: - archive: show only documents that are or are not in the archive - modifiedfromdate: string date in mysql format to show all templates modified from this date - modifiedtodate: string date in mysql format to show all templates modified to this date
Parameter 'login' : Structure of type 'login'
Optional login data
Parameter 'start' : int (optional)
Optional parameter that specifies the first element in the collection to be returned. If this parameter is omitted, the first entry in the collection is also the first entry that is returned. Use this parameter is you only want to retrieve a part of the collection.
Parameter 'length' : int (optional)
Optional parameter that can be used to limit the number of returned elements of this method. If this parameter is omitted, all entries in the collection are returned. If you specify a length, this method will not return more than the specified number of entries.
Parameter 'allproperties' : boolean (optional)
Optional parameter that specifies if only a limited number of properties of the requested objects are returned or, when this parameter is set to true, whether all properties of the objects are returned.

Return values
Return value 'start' : int
The first element of the collection
Return value 'length' : int
The number of elements that are returned
Return value 'total' : int
The total available elements of the collection
Return value 'allproperties' : int
When this element is available in the return value, the objects in the collection are fully filled, otherwise only a limited number of fields from the objects are filled
Return value 'emailingdocument' : Collection of type 'emailingdocument'

Structure 'pair'
This structure pair was mentioned above. This structure has the following properties:
Property 'key' : string
Property 'value' : string

Structure 'options'
This structure options was mentioned above. This structure has the following properties:
Property 'pair' : Structure of type 'pair'

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 'emailingdocument'
This structure emailingdocument was mentioned above. This structure has the following properties:
Property 'subject' : string
The subject of the emailingdocument.
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.