SOAP API method Rule_createCondition

Back to API references

Description
Create a new condition for this rule. There are some different types of a condition: 'Change','Custom','Date','DoubleField','Email','Fax','Field','Interest', 'LastContact','MiniView','Sms','ToDo','Survey', 'Part', 'ReferView'

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

Return values
Return value 'fieldcondition' : Structure of type 'fieldcondition'
Return value 'smscondition' : Structure of type 'smscondition'
Return value 'emailcondition' : Structure of type 'emailcondition'
Return value 'faxcondition' : Structure of type 'faxcondition'
Return value 'todocondition' : Structure of type 'todocondition'
Return value 'changecondition' : Structure of type 'changecondition'
Return value 'surveycondition' : Structure of type 'surveycondition'
Return value 'miniviewcondition' : Structure of type 'miniviewcondition'
Return value 'lastcontactcondition' : Structure of type 'lastcontactcondition'
Return value 'doublefieldcondition' : Structure of type 'doublefieldcondition'
Return value 'referviewcondition' : Structure of type 'referviewcondition'
Return value 'exportcondition' : Structure of type 'exportcondition'
Return value 'partcondition' : Structure of type 'partcondition'
Return value 'interestcondition' : Structure of type 'interestcondition'
Return value 'datecondition' : Structure 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 'comparison' : string
The comparison type of the fieldcondition.
Property 'value' : string
The value that the field is compared with.
Property 'numericComparison' : boolean
Is the comparison done numeric or not
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.
Property 'disabled' : boolean
Is this condition disabled?

Structure 'smscondition'
This structure smscondition was mentioned above. This structure has the following properties:
Property 'matchmode' : string
The matchmode of the mailingcondition.
Property 'requireddestination' : string
The required destination of the condition.
Property 'documentname' : string
The name of the document of the condition.
Property 'aftertime' : timestamp
The 'after' time of the condition.
Property 'aftermutation' : DateMutation
Change the variable time before which the mailing should have been sent.
Property 'beforetime' : timestamp
The 'before' time of the condition.
Property 'beforemutation' : DateMutation
The variable time before which the mailing should have been sent.
Property 'number' : int
The required number of messages that are received.
Property 'operator' : string
The operator to compare the number of messages with the number of received messages by the profile/subprofile.
Property 'templatename' : string
The name of the template of the condition.
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.
Property 'disabled' : boolean
Is this condition disabled?

Structure 'emailcondition'
This structure emailcondition was mentioned above. This structure has the following properties:
Property 'requiredresult' : string
The emailings certain result.
Property 'clickedurl' : string
The URL that must be clicked.
Property 'requirederrors' : Array
These errors trigger the condition, used in comination of the 'error' result.
Property 'matchmode' : string
The matchmode of the mailingcondition.
Property 'requireddestination' : string
The required destination of the condition.
Property 'documentname' : string
The name of the document of the condition.
Property 'aftertime' : timestamp
The 'after' time of the condition.
Property 'aftermutation' : DateMutation
Change the variable time before which the mailing should have been sent.
Property 'beforetime' : timestamp
The 'before' time of the condition.
Property 'beforemutation' : DateMutation
The variable time before which the mailing should have been sent.
Property 'number' : int
The required number of messages that are received.
Property 'operator' : string
The operator to compare the number of messages with the number of received messages by the profile/subprofile.
Property 'templatename' : string
The name of the template of the condition.
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.
Property 'disabled' : boolean
Is this condition disabled?

Structure 'faxcondition'
This structure faxcondition was mentioned above. This structure has the following properties:
Property 'matchmode' : string
The matchmode of the mailingcondition.
Property 'requireddestination' : string
The required destination of the condition.
Property 'documentname' : string
The name of the document of the condition.
Property 'aftertime' : timestamp
The 'after' time of the condition.
Property 'aftermutation' : DateMutation
Change the variable time before which the mailing should have been sent.
Property 'beforetime' : timestamp
The 'before' time of the condition.
Property 'beforemutation' : DateMutation
The variable time before which the mailing should have been sent.
Property 'number' : int
The required number of messages that are received.
Property 'operator' : string
The operator to compare the number of messages with the number of received messages by the profile/subprofile.
Property 'templatename' : string
The name of the template of the condition.
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.
Property 'disabled' : boolean
Is this condition disabled?

Structure 'todocondition'
This structure todocondition was mentioned above. This structure has the following properties:
Property 'matchtype' : string
The match type of the to do condition.
Property 'matchmode' : string
The matchmode of the to do condition.
Property 'contacttype' : ContactType
The contacttype of the to do condition.
Property 'minopencontacts' : int
The minimum number of items that should be on the todo list.
Property 'maxopencontacts' : int
The maximum number of items that should be on the todo list.
Property 'aftertime' : timestamp
The aftertime of the todo condition.
Property 'aftermutation' : DateMutation
The aftermutation of the todo condition.
Property 'beforetime' : timestamp
The beforetime of the todo condition.
Property 'beforemutation' : DateMutation
The beforemutation of the todo condition.
Property 'beforeinterval' : DateMutation
Set the beforemutation of the todo condition.
Property 'priority' : string
Get the priority of the selected todo's.
Property 'contains' : string
Get the search string for the todo contents
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.
Property 'disabled' : boolean
Is this condition disabled?

Structure 'changecondition'
This structure changecondition was mentioned above. This structure has the following properties:
Property 'changetype' : string
The changetype of the changecondition.
Property 'aftertime' : timestamp
The aftertime of the changecondition.
Property 'aftermutation' : DateMutation
The aftermutation of the changecondition.
Property 'beforetime' : timestamp
The beforetime of the changecondition.
Property 'beforeinterval' : DateMutation
The before mutation of the changecondition.
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.
Property 'disabled' : boolean
Is this condition disabled?

Structure 'surveycondition'
This structure surveycondition was mentioned above. This structure has the following properties:
Property 'submitter' : string
The required submitter of the survey.
Property 'surveyname' : string
The name of the survey that must have been filled in.
Property 'aftertime' : string
The 'after' time of the condition.
Property 'aftermutation' : DateMutation
The variable time AFTER which the survey must be submitted.
Property 'beforetime' : string
The 'before' time of the condition.
Property 'beforemutation' : DateMutation
The variable time BEFORE which the survey must be submitted.
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.
Property 'disabled' : boolean
Is this condition disabled?

Structure 'miniviewcondition'
This structure miniviewcondition was mentioned above. This structure has the following properties:
Property 'minsubprofiles' : int
The minimum number of subprofiles that should exists in the miniview.
Property 'maxsubprofiles' : int
The maximum number of subprofiles that should exists in the miniview.
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.
Property 'disabled' : boolean
Is this condition disabled?

Structure 'lastcontactcondition'
This structure lastcontactcondition was mentioned above. This structure has the following properties:
Property 'matchtype' : string
The match type of the lastcontactcondition.
Property 'matchmode' : string
The matchmode of the lastcontactcondition.
Property 'contacttype' : ContactType
The type of contact that we recently had (or did not have).
Property 'minclosedcontacts' : int
The minimum number of items that should be on the todo list.
Property 'maxclosedcontacts' : int
The maximum number of items that should be on the contast list.
Property 'aftertime' : timestamp
The aftertime of the last contact condition.
Property 'aftermutation' : DateMutation
The aftermutation of the last contact condition.
Property 'beforetime' : timestamp
The beforetime of the last contact condition.
Property 'beforemutation' : DateMutation
The beforemutation of the last contact condition.
Property 'beforeinterval' : DateMutation
Set the before mutation of the last contact condition.
Property 'priority' : string
Get the priority of the selected contacts
Property 'contains' : string
Get the search string for the contact report contents
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.
Property 'disabled' : boolean
Is this condition disabled?

Structure 'doublefieldcondition'
This structure doublefieldcondition was mentioned above. This structure has the following properties:
Property 'matchmode' : string
The matchmode of the doublefieldcondition.
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.
Property 'disabled' : boolean
Is this condition disabled?

Structure 'referviewcondition'
This structure referviewcondition was mentioned above. This structure has the following properties:
Property 'checktype' : string
Should a profile be present in the other view or not.
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.
Property 'disabled' : boolean
Is this condition disabled?

Structure 'exportcondition'
This structure exportcondition was mentioned above. This structure has the following properties:
Property 'includeneverexportedprofiles' : boolean
When this is true the condition also includes the profiles that weren't exported before.
Property 'aftertime' : timestamp
The aftertime of the exportcondition.
Property 'aftermutation' : DateMutation
The aftermutation of the exportcondition.
Property 'beforetime' : timestamp
The beforetime of the exportcondition.
Property 'beforemutation' : DateMutation
The before mutation of the exportcondition.
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.
Property 'disabled' : boolean
Is this condition disabled?

Structure 'partcondition'
This structure partcondition was mentioned above. This structure has the following properties:
Property 'random' : boolean
Whether or not the results are ordered randomly
Property 'begin' : string
The first selected profile from the parent, ordered by the fields
Property 'length' : string
The number of selected profiles. This value can be a number or a percentage.
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.
Property 'disabled' : boolean
Is this condition disabled?

Structure 'interestcondition'
This structure interestcondition was mentioned above. This structure has the following properties:
Property 'matchmode' : string
The matchmode of the interestcondition.
Property 'interestgroup' : string
The interestgroup of the condition.
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.
Property 'disabled' : boolean
Is this condition disabled?

Structure 'datecondition'
This structure datecondition was mentioned above. This structure has the following properties:
Property 'aftertime' : timestamp
The 'after' time of the date condition.
Property 'aftermutation' : DateMutation
The variable time after which the chosen field must be.
Property 'beforetime' : timestamp
The 'before' time of the date condition.
Property 'beforemutation' : DateMutation
The variable time before which the chosen field must be.
Property 'comparemode' : string
The compare mode of the datecondition.
Property 'id' : int
The ID of the condition.
Property 'type' : string
The type of the condition.
Property 'disabled' : boolean
Is this condition disabled?