SOAP API method Account_emailingDocuments

Description

This function gives access to the documents belonging to this account

Parameters

Name	Type	Description
order	string	orderby, documentfields
asc	boolean	asc, default true
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 - keyword: search documents by keyword (non strict)
login	Structure of type 'login'	Optional login data (soon deprecated)
access_token	string	Optional api access token
start	int	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.
length	int	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.
allproperties	boolean	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.
* required parameters

Return values

Name	Type	Description
start	int	The first element of the collection
length	int	The number of elements that are returned
total	int	The total available elements of the collection
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
emailingdocument	Collection of type 'emailingdocument'

Structure 'pair'

Name	Type	Description
key	string
value	string

Structure 'options'

Name	Type	Description
pair	Structure of type 'pair'

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 'emailingdocument'

Name	Type	Description
subject	string	The subject of the emailingdocument.
id	int	The ID of the document.
templateID	int	The template ID of the document
name	string	The name of the document.