SOAP API method ProcessedEmailing_errors

Back to API references

Description
All the errors of the mailing. The first parameter contains an array of codes and types that should only be returned

Parameters
Parameter 'id' : int
Unique identifier (id) of the object ProcessedEmailing. The method only applies to the processedemailing with this id.
Parameter 'errors' : Collection of type 'errors'
Error codes or error types to check for, if nothing is specified, all errors are returned
Parameter 'distinct' : boolean
Only return distinct errors, multiple errors from the same profile are ignored
Parameter 'mergecurrent' : boolean
Merge errors with profile data of profiles that still exist. Errors from removed profiles are not returned
Parameter 'order' : string
Possible values are 'timestamp' and any of the fields of the (sub)profiles
Parameter 'asc' : boolean
asc (default true)
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 'emailingerror' : Collection of type 'emailingerror'

Structure 'errors'
This structure errors was mentioned above. This structure has the following properties:
Property '' : string

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