Filtering

Filtering currently exists with the following operators. You can filter any attribute that is available in the entity object, unless specified in that resource documentation. Filters that are invalid will be ignored.

Equals - eq
Not Equals - ne Greater Than - gt Greater Than or Equals - gte Less Than - lt Less Than or Equals - lte Null - is Not Null - is not Like - like In - in Not In - not-in Between - between

Standard OperatorsCopied!

Equals eq

"eq" => "="

GET /api/practitioners?practitioner_id=eq:11

This would retrieve the practitioner object that has an ID of 11.

Not equals ne

"ne" => "!="

GET /api/practitioner?practitioner_id=ne:11

This would retrieve all practitioners who do not have an ID of 11

--

"gt" => ">",
"gte" => ">=",
"lt" => "<",
"lte" => "<=",
// special NULL operators
"null" => "IS",
"not-null" => "IS NOT",
// string matching
"like" => "LIKE",

Special Operators & String MatchingCopied!

ListsCopied!

In in

/api/appointments?id=in:11,12

Retrieves all appointments in the array provided (in this case with id's of 11 and 12).

Not In not-in

/api/appointments?id=not-in:11,12

Retrieves all appointments except for those in the array provided (in this case with id's of 11 and 12).

Between between

/api/appointments?id=between:11,100

Retrieves all appointments with ids in between the array provided (in this case between 11 and 100). This is inclusive, so will include appointments with ID of 11 and 100.