Some GoFormz API's support a filtering syntax that is similar to OData. The filtering syntax is supported when a "filter" query string parameter is described in the endpoint documentation.
Logical Operators
Note: The logical operators are Case-Sensitive
| Operator | Definition | Description |
|---|---|---|
| eq | Equals | The eq operator returns true if the left operand is equal to the right operand, otherwise it returns false. |
| ne | Not Equals | The ne operator returns true if the left operand is not equal to the right operand, otherwise it returns false. |
| gt | Greater Than | The gt operator returns true if the left operand is greater than the right operand, otherwise it returns false. |
| ge | Greater Than or Equal | The ge operator returns true if the left operand is greater than or equal to the right operand, otherwise it returns false. |
| lt | Less Than | The lt operator returns true if the left operand is less than the right operand, otherwise it returns false. |
| le | Less Than or Equal | The le operator returns true if the left operand is less than or equal to the right operand, otherwise it returns false. |
| and | And | The and operator returns true if both the left and right operands evaluate to true, otherwise it returns false. |
| or | Or | The or operator returns false if both the left and right operands both evaluate to false, otherwise it returns true. |
Logical Operator Examples
Dates
Dates will use Coordinated Universal Time (UTC), eg. 2021-12-08T08:00:00Z
- Include timezone offset, if necessary.
// all forms with a lastUpdatedDate greater than January 1st, 2015 (00:00 UTC time)
https://api.goformz.com/v2/formz?filter=lastupdateddate gt 2015-01-01
// all forms with a lastUpdatedDate greater than January 1st, 2015
// indcluding time
https://api.goformz.com/v2/formz?filter=lastupdateddate gt 2015-01-01T03:01:01
// all forms with a lastUpdatedDate greater than January 1st, 2015
// in PST timezone (-08:00 offset)
https://api.goformz.com/v2/formz?filter=lastupdateddate gt 2015-01-01T08:00:00
// all forms with a lastUpdatedDate greater than January 1st, 2015
// and a lastUpdatedDate less than January 1st, 2016
https://api.goformz.com/v2/formz?filter=lastupdateddate gt 2015-01-01 and lastupdateddate lt 2015-01-01
//This will kept all forms for January 1, 2015 on PST time (-8:00 offset)
https://api.goformz.com/v2/formz?filter=lastupdateddate gt 2015-01-01T08:00:00Z and lastupdateddate lt 2015-01-01T08:00:00Z