Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Data Element

Description

Default

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

order_by

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

 

Response
Anchor
Response
Response

...

The following is an example CURL for calling this api. Also note that there are sample Referral Id’s that are in the CIE Hub development environment that can be used for testing purposes

 

Code Block
curl -v 
--request GET 'https://directory-uat.mi-cie.org/v1/services' 
--header 'x-api-key: aGZoczo4****2ZDk=' 
--header 'Content-Type: application/json' 
--header 'Authorization: bearer etty****iquerui'
 



...