SOAP API method Rule_conditions

Back to API references

Description
All the conditions of the rule.

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

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

Structure 'smscondition'
This structure smscondition was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.

Structure 'emailcondition'
This structure emailcondition was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.

Structure 'faxcondition'
This structure faxcondition was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.

Structure 'todocondition'
This structure todocondition was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.

Structure 'changecondition'
This structure changecondition was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.

Structure 'surveycondition'
This structure surveycondition was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.

Structure 'miniviewcondition'
This structure miniviewcondition was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.

Structure 'lastcontactcondition'
This structure lastcontactcondition was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.

Structure 'doublefieldcondition'
This structure doublefieldcondition was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.

Structure 'referviewcondition'
This structure referviewcondition was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.

Structure 'exportcondition'
This structure exportcondition was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.

Structure 'partcondition'
This structure partcondition was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.

Structure 'interestcondition'
This structure interestcondition was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.

Structure 'datecondition'
This structure datecondition was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.