SOAP API methode Rule_condition

Terug naar de indexpagina

Beschrijving
A single condition of this rule.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object Rule. The method only applies to the rule with this id.
Parameter 'type' : string
Type of condition, the possibilities: 'Change','Date','DoubleField','Email','Fax','Field','Interest', 'LastContact','MiniView','Sms','ToDo','Survey', 'Part', 'ReferView'
Parameter 'identifier' : int
ID of the condition
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'referviewcondition' : Structure of type 'referviewcondition'
Return value 'faxcondition' : Structure of type 'faxcondition'
Return value 'emailcondition' : Structure of type 'emailcondition'
Return value 'smscondition' : Structure of type 'smscondition'
Return value 'interestcondition' : Structure of type 'interestcondition'
Return value 'exportcondition' : Structure of type 'exportcondition'
Return value 'todocondition' : Structure of type 'todocondition'
Return value 'miniviewcondition' : Structure of type 'miniviewcondition'
Return value 'fieldcondition' : Structure of type 'fieldcondition'
Return value 'lastcontactcondition' : Structure of type 'lastcontactcondition'
Return value 'doublefieldcondition' : Structure of type 'doublefieldcondition'
Return value 'surveycondition' : Structure of type 'surveycondition'
Return value 'changecondition' : Structure of type 'changecondition'
Return value 'datecondition' : Structure of type 'datecondition'
Return value 'partcondition' : Structure of type 'partcondition'

Structuur 'login'
De structuur 'login' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'username' : string
The username of the login attempt
Eigenschap 'account' : string
The account name of the login attempt
Eigenschap 'password' : string
The password for the login attempt

Structuur 'referviewcondition'
De structuur 'referviewcondition' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'checktype' : string
Should a profile be present in the other view or not.
Eigenschap 'id' : int
The ID of the condition.
Eigenschap 'type' : string
The type of the condition.
Eigenschap 'disabled' : boolean
Is this condition disabled?

Structuur 'faxcondition'
De structuur 'faxcondition' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'matchmode' : string
The matchmode of the mailingcondition.
Eigenschap 'requireddestination' : string
The required destination of the condition.
Eigenschap 'documentname' : string
The name of the document of the condition.
Eigenschap 'aftertime' : timestamp
The 'after' time of the condition.
Eigenschap 'aftermutation' : DateMutation
Change the variable time before which the mailing should have been sent.
Eigenschap 'beforetime' : timestamp
The 'before' time of the condition.
Eigenschap 'beforemutation' : DateMutation
The variable time before which the mailing should have been sent.
Eigenschap 'number' : int
The required number of messages that are received.
Eigenschap 'operator' : string
The operator to compare the number of messages with the number of received messages by the profile/subprofile.
Eigenschap 'templatename' : string
The name of the template of the condition.
Eigenschap 'id' : int
The ID of the condition.
Eigenschap 'type' : string
The type of the condition.
Eigenschap 'disabled' : boolean
Is this condition disabled?

Structuur 'emailcondition'
De structuur 'emailcondition' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'requiredresult' : string
The emailings certain result.
Eigenschap 'clickedurl' : string
The URL that must be clicked.
Eigenschap 'requirederrors' : Array
These errors trigger the condition, used in comination of the 'error' result.
Eigenschap 'matchmode' : string
The matchmode of the mailingcondition.
Eigenschap 'requireddestination' : string
The required destination of the condition.
Eigenschap 'documentname' : string
The name of the document of the condition.
Eigenschap 'aftertime' : timestamp
The 'after' time of the condition.
Eigenschap 'aftermutation' : DateMutation
Change the variable time before which the mailing should have been sent.
Eigenschap 'beforetime' : timestamp
The 'before' time of the condition.
Eigenschap 'beforemutation' : DateMutation
The variable time before which the mailing should have been sent.
Eigenschap 'number' : int
The required number of messages that are received.
Eigenschap 'operator' : string
The operator to compare the number of messages with the number of received messages by the profile/subprofile.
Eigenschap 'templatename' : string
The name of the template of the condition.
Eigenschap 'id' : int
The ID of the condition.
Eigenschap 'type' : string
The type of the condition.
Eigenschap 'disabled' : boolean
Is this condition disabled?

Structuur 'smscondition'
De structuur 'smscondition' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'matchmode' : string
The matchmode of the mailingcondition.
Eigenschap 'requireddestination' : string
The required destination of the condition.
Eigenschap 'documentname' : string
The name of the document of the condition.
Eigenschap 'aftertime' : timestamp
The 'after' time of the condition.
Eigenschap 'aftermutation' : DateMutation
Change the variable time before which the mailing should have been sent.
Eigenschap 'beforetime' : timestamp
The 'before' time of the condition.
Eigenschap 'beforemutation' : DateMutation
The variable time before which the mailing should have been sent.
Eigenschap 'number' : int
The required number of messages that are received.
Eigenschap 'operator' : string
The operator to compare the number of messages with the number of received messages by the profile/subprofile.
Eigenschap 'templatename' : string
The name of the template of the condition.
Eigenschap 'id' : int
The ID of the condition.
Eigenschap 'type' : string
The type of the condition.
Eigenschap 'disabled' : boolean
Is this condition disabled?

Structuur 'interestcondition'
De structuur 'interestcondition' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'matchmode' : string
The matchmode of the interestcondition.
Eigenschap 'interestgroup' : string
The interestgroup of the condition.
Eigenschap 'id' : int
The ID of the condition.
Eigenschap 'type' : string
The type of the condition.
Eigenschap 'disabled' : boolean
Is this condition disabled?

Structuur 'exportcondition'
De structuur 'exportcondition' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'includeneverexportedprofiles' : boolean
When this is true the condition also includes the profiles that weren't exported before.
Eigenschap 'aftertime' : timestamp
The aftertime of the exportcondition.
Eigenschap 'aftermutation' : DateMutation
The aftermutation of the exportcondition.
Eigenschap 'beforetime' : timestamp
The beforetime of the exportcondition.
Eigenschap 'beforemutation' : DateMutation
The before mutation of the exportcondition.
Eigenschap 'id' : int
The ID of the condition.
Eigenschap 'type' : string
The type of the condition.
Eigenschap 'disabled' : boolean
Is this condition disabled?

Structuur 'todocondition'
De structuur 'todocondition' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'matchtype' : string
The match type of the to do condition.
Eigenschap 'matchmode' : string
The matchmode of the to do condition.
Eigenschap 'contacttype' : ContactType
The contacttype of the to do condition.
Eigenschap 'minopencontacts' : int
The minimum number of items that should be on the todo list.
Eigenschap 'maxopencontacts' : int
The maximum number of items that should be on the todo list.
Eigenschap 'aftertime' : timestamp
The aftertime of the todo condition.
Eigenschap 'aftermutation' : DateMutation
The aftermutation of the todo condition.
Eigenschap 'beforetime' : timestamp
The beforetime of the todo condition.
Eigenschap 'beforemutation' : DateMutation
The beforemutation of the todo condition.
Eigenschap 'beforeinterval' : DateMutation
Set the beforemutation of the todo condition.
Eigenschap 'priority' : string
Get the priority of the selected todo's.
Eigenschap 'contains' : string
Get the search string for the todo contents
Eigenschap 'id' : int
The ID of the condition.
Eigenschap 'type' : string
The type of the condition.
Eigenschap 'disabled' : boolean
Is this condition disabled?

Structuur 'miniviewcondition'
De structuur 'miniviewcondition' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'minsubprofiles' : int
The minimum number of subprofiles that should exists in the miniview.
Eigenschap 'maxsubprofiles' : int
The maximum number of subprofiles that should exists in the miniview.
Eigenschap 'id' : int
The ID of the condition.
Eigenschap 'type' : string
The type of the condition.
Eigenschap 'disabled' : boolean
Is this condition disabled?

Structuur 'fieldcondition'
De structuur 'fieldcondition' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'comparison' : string
The comparison type of the fieldcondition.
Eigenschap 'value' : string
The value that the field is compared with.
Eigenschap 'numericComparison' : boolean
Is the comparison done numeric or not
Eigenschap 'id' : int
The ID of the condition.
Eigenschap 'type' : string
The type of the condition.
Eigenschap 'disabled' : boolean
Is this condition disabled?

Structuur 'lastcontactcondition'
De structuur 'lastcontactcondition' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'matchtype' : string
The match type of the lastcontactcondition.
Eigenschap 'matchmode' : string
The matchmode of the lastcontactcondition.
Eigenschap 'contacttype' : ContactType
The type of contact that we recently had (or did not have).
Eigenschap 'minclosedcontacts' : int
The minimum number of items that should be on the todo list.
Eigenschap 'maxclosedcontacts' : int
The maximum number of items that should be on the contast list.
Eigenschap 'aftertime' : timestamp
The aftertime of the last contact condition.
Eigenschap 'aftermutation' : DateMutation
The aftermutation of the last contact condition.
Eigenschap 'beforetime' : timestamp
The beforetime of the last contact condition.
Eigenschap 'beforemutation' : DateMutation
The beforemutation of the last contact condition.
Eigenschap 'beforeinterval' : DateMutation
Set the before mutation of the last contact condition.
Eigenschap 'priority' : string
Get the priority of the selected contacts
Eigenschap 'contains' : string
Get the search string for the contact report contents
Eigenschap 'id' : int
The ID of the condition.
Eigenschap 'type' : string
The type of the condition.
Eigenschap 'disabled' : boolean
Is this condition disabled?

Structuur 'doublefieldcondition'
De structuur 'doublefieldcondition' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'matchmode' : string
The matchmode of the doublefieldcondition.
Eigenschap 'id' : int
The ID of the condition.
Eigenschap 'type' : string
The type of the condition.
Eigenschap 'disabled' : boolean
Is this condition disabled?

Structuur 'surveycondition'
De structuur 'surveycondition' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'submitter' : string
The required submitter of the survey.
Eigenschap 'surveyname' : string
The name of the survey that must have been filled in.
Eigenschap 'aftertime' : string
The 'after' time of the condition.
Eigenschap 'aftermutation' : DateMutation
The variable time AFTER which the survey must be submitted.
Eigenschap 'beforetime' : string
The 'before' time of the condition.
Eigenschap 'beforemutation' : DateMutation
The variable time BEFORE which the survey must be submitted.
Eigenschap 'id' : int
The ID of the condition.
Eigenschap 'type' : string
The type of the condition.
Eigenschap 'disabled' : boolean
Is this condition disabled?

Structuur 'changecondition'
De structuur 'changecondition' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'changetype' : string
The changetype of the changecondition.
Eigenschap 'aftertime' : timestamp
The aftertime of the changecondition.
Eigenschap 'aftermutation' : DateMutation
The aftermutation of the changecondition.
Eigenschap 'beforetime' : timestamp
The beforetime of the changecondition.
Eigenschap 'beforeinterval' : DateMutation
The before mutation of the changecondition.
Eigenschap 'id' : int
The ID of the condition.
Eigenschap 'type' : string
The type of the condition.
Eigenschap 'disabled' : boolean
Is this condition disabled?

Structuur 'datecondition'
De structuur 'datecondition' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'aftertime' : timestamp
The 'after' time of the date condition.
Eigenschap 'aftermutation' : DateMutation
The variable time after which the chosen field must be.
Eigenschap 'beforetime' : timestamp
The 'before' time of the date condition.
Eigenschap 'beforemutation' : DateMutation
The variable time before which the chosen field must be.
Eigenschap 'comparemode' : string
The compare mode of the datecondition.
Eigenschap 'id' : int
The ID of the condition.
Eigenschap 'type' : string
The type of the condition.
Eigenschap 'disabled' : boolean
Is this condition disabled?

Structuur 'partcondition'
De structuur 'partcondition' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'random' : boolean
Whether or not the results are ordered randomly
Eigenschap 'begin' : string
The first selected profile from the parent, ordered by the fields
Eigenschap 'length' : string
The number of selected profiles. This value can be a number or a percentage.
Eigenschap 'id' : int
The ID of the condition.
Eigenschap 'type' : string
The type of the condition.
Eigenschap 'disabled' : boolean
Is this condition disabled?