View.AddCriteria

June 19, 2017

Description

Adds a criteria item to a view.

Required parameters

ViewID
Operator (Contains, Equals, EndsWith, DoesNotContain, etc.)
FieldName
Value (Note: Value is not required for some operators, such as ‘Is After Today’ and ‘Is Empty’)

Optional Parameters

AndOr (valid options are And’, ‘Or’, and ‘None’. Default is None)

Returns

Message specifying whether or not the criteria was successfully added to the view.

Example request url

https://api.mozenda.com/rest?WebServiceKey=3FE7221C-9097-4B64-AED6-0950F675F377&Service=Mozenda10&Operation=View.AddCriteria&ViewID=1103&Operator=Contains&FieldName=Price&Value=2

Example response

<ApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Result>Success</Result>
</ApiResponse>

Valid Operators by Field Type

Text Field
Equals
Does Not Equal
Contains
Does Not Contain
Is Empty
Is Not Empty
Begins With
Does Not Begin With
Ends With
Does Not End With

DateTime Field
Equals
Does Not Equal
Is Today
Is After
Is After Now
Is After Today
Is Before
Is Before Now
Is Before Today
Is Empty
Is Not Empty

Number Field
Equals
Does Not Equal
Is Greater Than
Is Less Than
Is Greater Than Or Equal
Is Less Than Or Equal
Is Empty
Is Not Empty