Back to API references

SOAP API method CollectionConstraintRule_condition

Description

A single condition of this constraint rule.

Parameters

Name Type Description
id * int Unique identifier (id) of the object CollectionConstraintRule. The method only applies to the collectionconstraintrule with this id.
type * string Type of condition
identifier * int ID of the condition
login Structure of type 'login' Optional login data
access_token string Optional api access token
* required parameters

Return values

Name Type Description
constraintrulenondoublecondition Structure of type 'constraintrulenondoublecondition'
constraintrulevaluecondition Structure of type 'constraintrulevaluecondition'
databaseconstraintrulevaluecondition Structure of type 'databaseconstraintrulevaluecondition'

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

Name Type Description
id int The ID of the condition.
type string The type of the condition.

Structure 'constraintrulevaluecondition'

Name Type Description
field string The field this condition operates on
value string The value the field must match
matchMode string Get the match mode of the condition
numericComparison boolean Is the comparison done numeric or not
id int The ID of the condition.
type string The type of the condition.

Structure 'databaseconstraintrulevaluecondition'

Name Type Description
id int The ID of the condition.
type string The type of the condition.