SOAP API method Database_triggeredFollowUps

Back to API references

Description
All the followups that were triggered by this database, the following options are available: - done => boolean should we show the done or not done triggered followups? when not given at all, both will be returned.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object Database. The method only applies to the database with this id.
Parameter '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
Parameter '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.
Parameter '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.
Parameter '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.
Parameter 'done' : string
show all|processed|scheduled triggered followups.
Parameter 'order' : string
Possible values are 'triggertime' and 'exectime' and any of the fields of the (sub)profiles.
Parameter 'asc' : boolean
order by ascending (true) or descending (false).
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 'databasetriggeredfollowup' : Collection of type 'databasetriggeredfollowup'

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

Structure 'profile'
This structure profile was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the profile.
Property 'code' : string
The code of the profile.
Property 'extra' : string
The extra data of the profile.
Property 'created' : timestamp
The timestamp when the profile was created.
Property 'modified' : timestamp
The timestamp when the profile was last modified.
Property 'lastexport' : timestamp
The last timestamp when the profile was exported.
Property 'fields' : Map
Map of all fields of the profile, this property is only returned when the parameter 'allproperties' is set to true
Property 'interests' : Map
Map of all interests of the profile, this property is only returned when the parameter 'allproperties' is set to true

Structure 'subprofile'
This structure subprofile was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the subprofile.
Property 'code' : string
The code of the subprofile.
Property 'created' : timestamp
The timestamp when the subprofile was created.
Property 'modified' : timestamp
The timestamp when the subprofile was last modified.
Property 'lastexport' : timestamp
The last timestamp when the subprofile was exported.
Property 'fields' : Map
Map of all fields of the subprofile, this property is only returned when the parameter 'allproperties' is set to true

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