Back to API references

SOAP API method MiniRule_miniCondition

Description

A single minicondition of this minirule.

Parameters

Name	Type	Description
id *	int	Unique identifier (id) of the object MiniRule. The method only applies to the minirule with this id.
type *	string	There are some different types of a minicondition: 'Date','Field','Change','Email', 'Sms', 'Fax', 'Part', 'DoubleField', 'Survey', 'Refer', 'Logs'
identifier *	int	ID of the minicondition
login	Structure of type 'login'	Optional login data (soon deprecated)
access_token	string	Optional api access token
* required parameters

Return values

Name	Type	Description
doublefieldminicondition	Structure of type 'doublefieldminicondition'
partminicondition	Structure of type 'partminicondition'
dateminicondition	Structure of type 'dateminicondition'
surveyminicondition	Structure of type 'surveyminicondition'
exportminicondition	Structure of type 'exportminicondition'
referminicondition	Structure of type 'referminicondition'
fieldminicondition	Structure of type 'fieldminicondition'
changeminicondition	Structure of type 'changeminicondition'
emailminicondition	Structure of type 'emailminicondition'
faxminicondition	Structure of type 'faxminicondition'
smsminicondition	Structure of type 'smsminicondition'

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

Name	Type	Description
matchmode	string	The matchmode of the doublefieldminicondition.
context	string	The context for the condition.
id	int	The ID of the minicondition.
type	string	The type of the minicondition.
disabled	boolean	Is this minicondition disabled?

Structure 'partminicondition'

Name	Type	Description
begin	string	The first selected subprofile from the collection, ordered by the fields
length	string	The number of selected subprofiles. This value can be a number or a percentage.
context	string	The context for the condition.
id	int	The ID of the minicondition.
type	string	The type of the minicondition.
disabled	boolean	Is this minicondition disabled?

Structure 'dateminicondition'

Name	Type	Description
aftertime	timestamp	The 'after' time of the date minicondition.
aftermutation	DateMutation	Change the variable time before which the chosen field must be.
beforetime	timestamp	The 'before' time of the date minicondition.
beforemutation	DateMutation	The variable time before which the chosen field must be.
comparemode	string	The compare mode of the dateminicondition.
id	int	The ID of the minicondition.
type	string	The type of the minicondition.
disabled	boolean	Is this minicondition disabled?

Structure 'surveyminicondition'

Name	Type	Description
submitter	string	The required submitter of the survey.
surveyname	string	The name of the survey that must have been filled in.
aftertime	string	The 'after' time of the condition.
aftermutation	DateMutation	The variable time AFTER which the survey must be submitted.
beforetime	string	The 'before' time of the condition.
beforemutation	DateMutation	The variable time BEFORE which the survey must be submitted.
id	int	The ID of the minicondition.
type	string	The type of the minicondition.
disabled	boolean	Is this minicondition disabled?

Structure 'exportminicondition'

Name	Type	Description
includeneverexportedsubprofiles	boolean	When this is true the condition also includes the profiles that weren't exported before.
aftertime	timestamp	The aftertime of the exportcondition.
aftermutation	DateMutation	The aftermutation of the exportcondition.
beforetime	timestamp	The beforetime of the exportcondition.
beforemutation	DateMutation	The before mutation of the exportcondition.
id	int	The ID of the minicondition.
type	string	The type of the minicondition.
disabled	boolean	Is this minicondition disabled?

Structure 'referminicondition'

Name	Type	Description
checktype	string	Should a subprofile be present in the other miniview or not.
id	int	The ID of the minicondition.
type	string	The type of the minicondition.
disabled	boolean	Is this minicondition disabled?

Structure 'fieldminicondition'

Name	Type	Description
comparison	string	The comparison type, valid values are: 'equals', 'not equals', 'contains',
value	string	The value t
numericComparison	boolean	Is the comparison done numeric or not
id	int	The ID of the minicondition.
type	string	The type of the minicondition.
disabled	boolean	Is this minicondition disabled?

Structure 'changeminicondition'

Name	Type	Description
changetype	string	The changetype of the changecondition.
aftertime	timestamp	The aftertime of the changeminicondition.
aftermutation	DateMutation	The aftermutation of the changeminicondition.
beforetime	timestamp	The beforetime of the changeminicondition.
beforemutation	DateMutation	The before mutation of the changeminicondition.
id	int	The ID of the minicondition.
type	string	The type of the minicondition.
disabled	boolean	Is this minicondition disabled?

Structure 'emailminicondition'

Name	Type	Description
requiredresult	string	The emailings certain result.
clickedurl	string	The URL that must be clicked.
requirederrors	Array	These errors trigger the condition, used in comination of the 'error' result.
matchmode	string	The matchmode of the mailingminicondition.
requireddestination	string	The required destination of the condition.
documentname	string	The name of the document of the condition.
aftertime	timestamp	The 'after' time of the mini condition.
aftermutation	DateMutation	Change the variable time before which the mailing should have been sent.
beforetime	timestamp	The 'before' time of the condition.
beforemutation	DateMutation	The variable time before which the mailing should have been sent.
number	int	The required number of messages that are received.
operator	string	The operator to compare the number of messages with the number of received messages by the profile/subprofile.
templatename	string	The name of the template of the minicondition.
id	int	The ID of the minicondition.
type	string	The type of the minicondition.
disabled	boolean	Is this minicondition disabled?

Structure 'faxminicondition'

Name	Type	Description
matchmode	string	The matchmode of the mailingminicondition.
requireddestination	string	The required destination of the condition.
documentname	string	The name of the document of the condition.
aftertime	timestamp	The 'after' time of the mini condition.
aftermutation	DateMutation	Change the variable time before which the mailing should have been sent.
beforetime	timestamp	The 'before' time of the condition.
beforemutation	DateMutation	The variable time before which the mailing should have been sent.
number	int	The required number of messages that are received.
operator	string	The operator to compare the number of messages with the number of received messages by the profile/subprofile.
templatename	string	The name of the template of the minicondition.
id	int	The ID of the minicondition.
type	string	The type of the minicondition.
disabled	boolean	Is this minicondition disabled?

Structure 'smsminicondition'

Name	Type	Description
matchmode	string	The matchmode of the mailingminicondition.
requireddestination	string	The required destination of the condition.
documentname	string	The name of the document of the condition.
aftertime	timestamp	The 'after' time of the mini condition.
aftermutation	DateMutation	Change the variable time before which the mailing should have been sent.
beforetime	timestamp	The 'before' time of the condition.
beforemutation	DateMutation	The variable time before which the mailing should have been sent.
number	int	The required number of messages that are received.
operator	string	The operator to compare the number of messages with the number of received messages by the profile/subprofile.
templatename	string	The name of the template of the minicondition.
id	int	The ID of the minicondition.
type	string	The type of the minicondition.
disabled	boolean	Is this minicondition disabled?

This website uses cookies on your computer to help us recognize your device and preferences. We use this information to customize our website and improve your browsing experience. You can read more about the cookies we use in our privacy policy .

If you decline the cookies you will not be tracked on our website. A single cookie will be stored in your browser to remember your preference not to be tracked.