Query Guide

Query Types

simple - queries a field containing a value

$like - queries a field containing a like value. Values are searched by the LIKE condition. LIKE condition is case insensitive and will match any string/number containing the searched for value.

$not - queries a field not containing a value.

$in - queries a field containing multiple values. ANY condition must be true.

$nin - (not in) queries a field not containing multiple values. ALL conditions must be true.

$or - queries multiple fields containing multiple values. ANY condition must be true.

$and - queries multiple fields containing multiple values. ALL conditions must be true.

$and:like - queries multiple fields containing multiple values. ALL conditions must be true. Values are searched by the LIKE condition. LIKE condition is case insensitive and will match any string/number containing the searched for value.

$table.field - queries joined data fields for multiple values. ALL conditions must be true.

$table.field:like - queries joined data fields for multiple values. ALL conditions must be true. Values are searched by the LIKE condition. LIKE condition is case insensitive and will match any string/number containing the searched for value.

$table.field - MULTIPLE VALUES - Executes like other table.field queries but will return all results exactly matching any of the given values. Executes like sql IN(value1,value2,value3)

$table.field:like - MULTIPLE VALUES - Executes like other table.field queries but will return all results including any of the given values. Executes a sql regex expression.

$area queries are only available for services and services/complete endpoints
$area - queries services that exist within geographical areas.

$area:like - queries services that exist within geographical areas. It will match on any LIKE area ‘name’ value.

$area - $table.field - queries services that exist within geographical areas. $table.field is an optional search parameter that allows added filtering by taxonomy terms. This can be used with area:like as well.

$area - $table.field:like - queries services that exist within geographical areas. $table.field is an optional search parameter that allows added filtering by taxonomy terms. This can be used with area:like as well.

$area - $in - queries services that exist within geographical areas. $table.field is an optional search parameter that allows added filtering by taxonomy terms. This can be used with area:like as well.

$area - $in:like - queries services that exist within geographical areas. $table.field is an optional search parameter that allows added filtering by taxonomy terms. This can be used with area:like as well.

distance_info - this is a subquery of $table.field, $table.field:like, $area, $area:like
This query is only available for services/complete
This will return distance information of the services location relative to the center of the input location
the distance_info accepts three options.

1. {“type“:”city”, ”name”:”detroit”}

2. {“type“:”zipcode”, ”name”:”49999”}

3. {“lat“:”44.99999”, ”lng”:”-82.99999”}

distance_info for table.field queries.

distance_info for area queries.

Query Errors

Each query type will return a detailed message designed to help create a valid query.

Example:
API: locations/
Query Type: simple: {"field" : "value"}
Query: {"fail":"1"}
Error Description: In the detail section of the error message it will provide the invalid input, in this case ‘fail’ and also provide all the valid fields that could have been used in place of ‘fail’.
Sample Error message:

Query Specific Examples

Call: locations/
Note: All API calls (organizations, services, locations, contacts) will be similar to this example.
Response:

Each root field can be queried using: simple, $not, $in, $nin, $or, $and
The root fields in the above response are: id, organiazation, name, alternate_name, description, transportation, latitude, longitude, region

simple: return only locations with id 969
query: {"id" : "969"}

$not: return all location with region not equal to “GRYP”
query: {"region" : {"$not" : "GRYP"}}

$in: return all only locations with id 969 and 970
query: {"id" : {"$in" : ["969", "971", "973"]}}

$nin: return all locations with id not equal to 969 and 970
query: {"id" : {"$in" : ["969", "971", "973"]}}

$or: return all locations with region equal to GRYP OR transportation equal to 0
query: {"$or": [{"region": "GRYP"}, {"transportation": "0"}]}

$and: return all locations with region equal to GRYP AND transportation equal to 0
query: {"$and": [{"region": "GRYP"}, {"transportation": "0"}]}

Query Specific Example ‘table.field’

NOTE: Joined field querying can be non-performant and so is restricted to specific calls and specific joined fields. Currently this query is only available for locations/complete.
NOTE: If a desired query is not supported please request that it be added to the query white list.

Call: locations/complete

Response:

Fields within joined tables can be queried using: $table.field
Joined tables in the above response are: postal_address, physical_address, phones, services, accessibility_for_disabilities
Fields within the joined table physical_address are: id, location_id, attention, address_1, city, region, state_province, postal_code, country
NOTE: Joined fields need to be white listed to be available for query.

$table.field: return all locations with physical_address.region equal to Berrien AND service.name equal to NUTRITION EDUCATION
query: {"$table.field":[{"physical_address.region": "Berrien"},{"service.name":"NUTRITION EDUCATION"}]}

Query Detailed Descriptions