Page Comparison

Path Parameter

id

This will be the service id of the requested record in the directory.

*Please note that this is only needed if you want to get a specific service payload for a ID.

Query String

query

A query parameter that will filter out the services that will be returned. This is an json object and

The following lists commonly used query strings used for this API https://brightstreetgroup.atlassian.net/wiki/spaces/CIEP/pages/1576763393/services#Common-Queries

page

This will be which page of data that the user wants to be returned.

Default to Page 1

per_page

This will be the number of records that can be queried at a time. The maximum that can be queried is 100.

Default to 10

ordersort_by

field sort:
This will allow the data to be returned in a certain order. Currently the only order by that has been implemented is distance from a passed in variable. Here are examples that can be passed inbe sorted by any root field.
examples: id, name, alternate_name, ect…

area sort:
An object can be passed in that will sort the services by their distance from a reference area.
When the area sort is used an additional field will return in the services object. field name: distance_miles
Examples of valid area sort objects:

// BySort afrom given lat and long
{"lat":"45.8976","lng":"-84.89876"}

// BySort from the middle of a city
{"type":"city","name":"Grand Rapids"}

// BySort from the middle of a zipcode
{"type":"zipcode","name":"49505"}

order_by

ASC or DESC. ASC is default value