SOAP API method Collection_processedFaxMailings

Description

The faxmailings that where processed can be filtered by several things. You can filter the type of the faxmailings, the kind of faxmailings, how to order the faxmailings, and if the order is ascending or descending.

Parameters

Name	Type	Description
id *	int	Unique identifier (id) of the object Collection. The method only applies to the collection with this id.
type	string	type "individual", "mass", "both"
test	string	test "test", "normal", "both"
archived	string	The possible values are "yes", "no", "both"
followups	string	The possible values are "yes", "no", "both"
order	string	The possible values are 'id', 'timestamp', 'individual', 'test', 'personalize'
asc	boolean	Order 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.
* 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
processedfaxmailing	Collection of type 'processedfaxmailing'

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

Name	Type	Description
destinationcount	int	The number of destinations of the faxmailing.
id	int	Get the ID of the mailing.