SOAP API method ProcessedSmsMailing_destinations

Back to API references

Description
With the result parameter it is possible to filter the destinations by result. Example: if the parameter result is set to 'error', only the destinations that have result 'error' are returned. Each destination has at most one main result, so the sum of the number of destination for each possible result equals the total number of destinations.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object ProcessedSmsMailing. The method only applies to the processedsmsmailing with this id.
Parameter 'result' : string
The required result for the destination, possible values are 'error', 'success' or 'none'. Specify false if the result does not matter. There IS a difference between 'none' and false: 'none' returns all destinations with an unknown result, false returns all destinations, no matter the result. Specific mailings may also define additional results
Parameter 'mergecurrent' : boolean
Should the destinations be merged with current profiles or subprofiles? If the merge is performed, this method only returns destination objects for (sub)profiles that still exist
Parameter 'order' : string
The order for the destinations. Possible value are 'timestamp' and 'id'. You can also specify all possible fields from the fields of the (sub)profiles
Parameter 'asc' : boolean
Order in ascending or descending 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 'faxmailingdestination' : Collection of type 'faxmailingdestination'
Return value 'emailingdestination' : Collection of type 'emailingdestination'
Return value 'smsmailingdestination' : Collection of type 'smsmailingdestination'

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

Structure 'emailingdestination'
This structure emailingdestination was mentioned above. This structure has the following properties:
Property 'id' : string
The ID of the destination.

Structure 'smsmailingdestination'
This structure smsmailingdestination was mentioned above. This structure has the following properties:
Property 'id' : string
The ID of the destination.