SOAP API method WebForm_triggeredFollowUps

Description

All the followups that were triggered by this webform, the following options are available:

Parameters

Name	Type	Description
id *	int	Unique identifier (id) of the object WebForm. The method only applies to the webform with this id.
followups	Collection of type 'followups'	If this parameter is set, only triggered follow ups of this type are returned. The supplied array must be an array of followup-ID's that are associated with the snapshot of this mailing. This parameter can also be an array of followups
mergecurrent	boolean	Set this to true if only (sub)profiles should be returned that still exist or show only the triggerdfollowups by the given profile or subprofile.
profile	Structure of type 'profile'	Set this to true if only (sub)profiles should be returned that still exist or show only the triggerdfollowups by the given profile or subprofile.
subprofile	Structure of type 'subprofile'	Set this to true if only (sub)profiles should be returned that still exist or show only the triggerdfollowups by the given profile or subprofile.
done	string	show all|processed|scheduled triggered followups.
order	string	Possible values are 'triggertime' and 'exectime' and any of the fields of the (sub)profiles.
asc	boolean	order by ascending (true) or descending (false).
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
webformtriggeredfollowup	Collection of type 'webformtriggeredfollowup'

Structure 'pair'

Name	Type	Description
key	string
value	string

Structure 'followups'

Name	Type	Description
pair	Structure of type 'pair'

Structure 'profile'

Name	Type	Description
id	int	The ID of the profile.
code	string	The code of the profile.
extra	string	The extra data of the profile.
created	timestamp	The timestamp when the profile was created.
modified	timestamp	The timestamp when the profile was last modified.
lastexport	timestamp	The last timestamp when the profile was exported.
fields	Map	Map of all fields of the profile, this property is only returned when the parameter 'allproperties' is set to true
interests	Map	Map of all interests of the profile, this property is only returned when the parameter 'allproperties' is set to true

Structure 'subprofile'

Name	Type	Description
id	int	The ID of the subprofile.
code	string	The code of the subprofile.
created	timestamp	The timestamp when the subprofile was created.
modified	timestamp	The timestamp when the subprofile was last modified.
lastexport	timestamp	The last timestamp when the subprofile was exported.
fields	Map	Map of all fields of the subprofile, this property is only returned when the parameter 'allproperties' is set to true

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

Name	Type	Description
id	int	The ID of the follow up.