SOAP API method MiniRule_miniCondition

Back to API references

Description
A single minicondition of this minirule.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object MiniRule. The method only applies to the minirule with this id.
Parameter 'type' : string
There are some different types of a minicondition: 'Date','Field','Change','Email', 'Sms', 'Fax', 'Part', 'DoubleField', 'Survey', 'Refer'
Parameter 'identifier' : int
ID of the minicondition
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'doublefieldminicondition' : Structure of type 'doublefieldminicondition'
Return value 'fieldminicondition' : Structure of type 'fieldminicondition'
Return value 'exportminicondition' : Structure of type 'exportminicondition'
Return value 'surveyminicondition' : Structure of type 'surveyminicondition'
Return value 'faxminicondition' : Structure of type 'faxminicondition'
Return value 'smsminicondition' : Structure of type 'smsminicondition'
Return value 'emailminicondition' : Structure of type 'emailminicondition'
Return value 'changeminicondition' : Structure of type 'changeminicondition'
Return value 'partminicondition' : Structure of type 'partminicondition'
Return value 'referminicondition' : Structure of type 'referminicondition'
Return value 'dateminicondition' : Structure of type 'dateminicondition'

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 'doublefieldminicondition'
This structure doublefieldminicondition was mentioned above. This structure has the following properties:
Property 'matchmode' : string
The matchmode of the doublefieldminicondition.
Property 'context' : string
The context for the condition.
Property 'id' : int
The ID of the minicondition.
Property 'type' : string
The type of the minicondition.
Property 'disabled' : boolean
Is this minicondition disabled?

Structure 'fieldminicondition'
This structure fieldminicondition was mentioned above. This structure has the following properties:
Property 'comparison' : string
The comparison type of the fieldminicondition.
Property 'value' : string
The value t
Property 'numericComparison' : boolean
Is the comparison done numeric or not
Property 'id' : int
The ID of the minicondition.
Property 'type' : string
The type of the minicondition.
Property 'disabled' : boolean
Is this minicondition disabled?

Structure 'exportminicondition'
This structure exportminicondition was mentioned above. This structure has the following properties:
Property 'includeneverexportedsubprofiles' : 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 minicondition.
Property 'type' : string
The type of the minicondition.
Property 'disabled' : boolean
Is this minicondition disabled?

Structure 'surveyminicondition'
This structure surveyminicondition 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 minicondition.
Property 'type' : string
The type of the minicondition.
Property 'disabled' : boolean
Is this minicondition disabled?

Structure 'faxminicondition'
This structure faxminicondition was mentioned above. This structure has the following properties:
Property 'matchmode' : string
The matchmode of the mailingminicondition.
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 mini 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 minicondition.
Property 'id' : int
The ID of the minicondition.
Property 'type' : string
The type of the minicondition.
Property 'disabled' : boolean
Is this minicondition disabled?

Structure 'smsminicondition'
This structure smsminicondition was mentioned above. This structure has the following properties:
Property 'matchmode' : string
The matchmode of the mailingminicondition.
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 mini 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 minicondition.
Property 'id' : int
The ID of the minicondition.
Property 'type' : string
The type of the minicondition.
Property 'disabled' : boolean
Is this minicondition disabled?

Structure 'emailminicondition'
This structure emailminicondition 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 mailingminicondition.
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 mini 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 minicondition.
Property 'id' : int
The ID of the minicondition.
Property 'type' : string
The type of the minicondition.
Property 'disabled' : boolean
Is this minicondition disabled?

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

Structure 'partminicondition'
This structure partminicondition was mentioned above. This structure has the following properties:
Property 'begin' : string
The first selected subprofile from the collection, ordered by the fields
Property 'length' : string
The number of selected subprofiles. This value can be a number or a percentage.
Property 'context' : string
The context for the condition.
Property 'id' : int
The ID of the minicondition.
Property 'type' : string
The type of the minicondition.
Property 'disabled' : boolean
Is this minicondition disabled?

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

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