SOAP API method Account_smsDocuments

Back to API references

Description
A smsdocument is for sending a sms message to a mobile phone. This method will return all the smsdocuments in this account.

Parameters
Parameter 'order' : string
The order in which the documents should be sorted
Parameter 'asc' : boolean
Order in ascending order?
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 'smsdocument' : Collection of type 'smsdocument'

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 'smsdocument'
This structure smsdocument was mentioned above. This structure has the following properties:
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.