SOAP API methode WebTemplate_documents

Beschrijving

All the documents of the template.

Parameters

Naam	Type	Beschrijving
id *	int	Unique identifier (id) of the object WebTemplate. The method only applies to the webtemplate with this id.
show	string	Optional parameter to show 'all', only 'archived', or only 'active' documents. This acts as a shortcut for setting the 'archive' option. It is mainly here for legacy reasons. Default is 'all'.
options	Collection of type 'options'	Optional associative array of options with at least the following options: - order: The field that should be ordered. - ascending: Should we sort in ascending order?
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.
* verplichte parameters

Resultaat

Naam	Type	Beschrijving
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
pdfdocument	Collection of type 'pdfdocument'
webdocument	Collection of type 'webdocument'
emailingdocument	Collection of type 'emailingdocument'
smsdocument	Collection of type 'smsdocument'

Structuur 'pair'

Naam	Type	Beschrijving
key	string
value	string

Structuur 'options'

Naam	Type	Beschrijving
pair	Structure of type 'pair'

Structuur 'login'

Naam	Type	Beschrijving
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

Structuur 'pdfdocument'

Naam	Type	Beschrijving
id	int	The ID of the document.
templateID	int	The template ID of the document
name	string	The name of the document.

Structuur 'webdocument'

Naam	Type	Beschrijving
id	int	The ID of the document.
templateID	int	The template ID of the document
name	string	The name of the document.

Structuur 'emailingdocument'

Naam	Type	Beschrijving
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.

Structuur 'smsdocument'

Naam	Type	Beschrijving
id	int	The ID of the document.
templateID	int	The template ID of the document
name	string	The name of the document.