SOAP API method reference

Description

The emailings that will be processed can be filtered by several things. You can filter the type of the emailings, the kind of emailings, the contenttype of the emailings, how to order the emailings, and if the order is ascending or descending. Only the individual mailings will be returned.

Parameters

Parameter 'id' : int: Unique identifier (id) of the object Profile. The method only applies to the profile with this id.
Parameter 'timestamp' : string: The timestamp for the historic profile
Parameter 'test' : string: "test", "normal", "both"
Parameter 'active' : string: 'yes', 'no', 'both'
Parameter 'contenttype' : string: "html", "text", "both"
Parameter 'order' : string: 'id', 'timestamp', 'individual', 'test', 'embedded', 'contenttype', 'personalize', 'subject', 'documentname', 'interval', 'nextstarttime', 'laststarttime'
Parameter 'asc' : boolean
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 'scheduledemailing' : Collection of type 'scheduledemailing'

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

This structure scheduledemailing was mentioned above. This structure has the following properties:

Property 'registerclicks' : string: Will the clicks be registered?.
Property 'id' : int: The ID of the scheduledevent.

SOAP API method Profile_scheduledEmailings