SOAP API method Rule_conditions

Description

All the conditions of the rule.

Parameters

Name	Type	Description
id *	int	Unique identifier (id) of the object Rule. The method only applies to the rule with this id.
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
fieldcondition	Collection of type 'fieldcondition'
referviewcondition	Collection of type 'referviewcondition'
changecondition	Collection of type 'changecondition'
exportcondition	Collection of type 'exportcondition'
partcondition	Collection of type 'partcondition'
lastcontactcondition	Collection of type 'lastcontactcondition'
miniviewcondition	Collection of type 'miniviewcondition'
surveycondition	Collection of type 'surveycondition'
interestcondition	Collection of type 'interestcondition'
datecondition	Collection of type 'datecondition'
todocondition	Collection of type 'todocondition'
doublefieldcondition	Collection of type 'doublefieldcondition'
smscondition	Collection of type 'smscondition'
faxcondition	Collection of type 'faxcondition'
emailcondition	Collection of type 'emailcondition'

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

Name	Type	Description
id	int	The ID of the condition.
type	string	The type of the condition.

Structure 'referviewcondition'

Name	Type	Description
id	int	The ID of the condition.
type	string	The type of the condition.

Structure 'changecondition'

Name	Type	Description
id	int	The ID of the condition.
type	string	The type of the condition.

Structure 'exportcondition'

Name	Type	Description
id	int	The ID of the condition.
type	string	The type of the condition.

Structure 'partcondition'

Name	Type	Description
id	int	The ID of the condition.
type	string	The type of the condition.

Structure 'lastcontactcondition'

Name	Type	Description
id	int	The ID of the condition.
type	string	The type of the condition.

Structure 'miniviewcondition'

Name	Type	Description
id	int	The ID of the condition.
type	string	The type of the condition.

Structure 'surveycondition'

Name	Type	Description
id	int	The ID of the condition.
type	string	The type of the condition.

Structure 'interestcondition'

Name	Type	Description
id	int	The ID of the condition.
type	string	The type of the condition.

Structure 'datecondition'

Name	Type	Description
id	int	The ID of the condition.
type	string	The type of the condition.

Structure 'todocondition'

Name	Type	Description
id	int	The ID of the condition.
type	string	The type of the condition.

Structure 'doublefieldcondition'

Name	Type	Description
id	int	The ID of the condition.
type	string	The type of the condition.

Structure 'smscondition'

Name	Type	Description
id	int	The ID of the condition.
type	string	The type of the condition.

Structure 'faxcondition'

Name	Type	Description
id	int	The ID of the condition.
type	string	The type of the condition.

Structure 'emailcondition'

Name	Type	Description
id	int	The ID of the condition.
type	string	The type of the condition.