Page Comparison

...

The following are the URLs for this API.

Environment

URL

UAT

GET https://directory-uat.mi-cie.org/v1/services/{id}

GET https://directory-uat.mi-cie.org/v1/services

Production

GET https://directory.mi-cie.org/v1/services/{id}

GET https://directory.mi-cie.org/v1/services/

Swagger Definitions

The following are the URLs for this API.

Environment	URL
UAT	https://directory-uat.mi-cie.org/v1/swagger#/services/get_services https://directory-uat.mi-cie.org/v1/swagger#/services/get_services__serviceId_

Headers

The following will be headers that will need to be supplied

Header	Description
x-api-key	This will be a key that will provided by a community information exchange administrator.
ContentType	application/json
Authorization	This will be the access token that was retrieved using your client id and secret

Request

Note that the person ID passed as a parameter in the URL as documented in the REST URL section.

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

sort_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.

...

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:

Code Block

// Sort from given lat and long
{"lat":"45.8976","lng":"-84.89876"}

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

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

order_by

ASC or DESC. ASC is default value

Response
Anchor
Response
Response

The following will be the response values from the calling of the API. The error responses will conform ]to the following specification. https://tools.ietf.org/html/rfc7807 .

HTTP Status Code	Description	Response Example
200	Successful retrieval of a

person

service record.

Code Block
[ { "

person

id"

{

1,
    "

active

organization_id":

true

 969,
    "

birthDate

location_id":

"19650521"

 970,
    "source_service_id": 1106,
    "

telecom

source_id_programAtSite":

[

 78189075,

{"rank

"source_id_program":

2,"system":"phone","value":"(734)556-1212","use":"home"},

 78143321,
    "source": "icarol",
    "program_id": null,
    "program": "CHILDREN'S ADVOCACY CENTER",
    "name": "COUNSELING SERVICES AND PREVENTION FOR CHILDREN WHO ARE ABUSED",

{

rank

alternate_name":

1,"system

 null,
    "description":

"email","value":"sdoh@yahoo.com","use":""}]

 "Provides forensic interviews for sexually abused children, counseling services for sexually abused children, including adults survivors of child sexual abuse, and prevention education.",
    "url": "www.swmichigancac.org",
    "email": "info@swmichigancac.org",
    "

managingOrganization

status":

"hfhs"

 1,
    "

address

interpretation_services":

{"country

 null,
    "application_process":

"US","city":"RIVERVIEW","use":"home","line":"6329 TEMPLATE","postalCode":"48192","county":"WAYNE","text":"6329 TEMPLATE RIVERVIEW, MI 48192","state":"MI","type":"both"}

 "- Referral required from Child Protective Services or Law Enforcement for forensic interviewing services  - Therapy services available to children and adult survivors of child sexual abuse",
    "wait_time": null,
    "fees": "No fees",
    "schedule_notes": "Mon, Wed 9am-8pm; Tue, Thu-Fri 9am-5pm",
    "accreditations": null,
    "licenses": null,
    "eligibility": "Children and families of suspected child abuse in Southwest Michigan",
    "language": "Translation services available",
    "payment_accepted": "Not applicable",
    "required_document": "Referral information",
    "

name

service_area":

{"given":"ONE","text":"ONE TEMPLIN","family":"TEMPLIN","use":"official","prefix":"TEMPLIN"}

 "Berrien, Cass and Van Buren Counties",
    "area_served_description": "Berrien, Cass and Van Buren Counties",
    "region": "GRYP",
    "address_1": "4938 Niles Road",
    "city": "Saint Joseph",
    "

gender

county": "

male

Berrien",
    "

recordType

postal_code": "

FHIR

49085",
    "

language

state_province": "

English

MI",
    "

personId

organization_name":

"8cb77503-e481-431a-a0d3-c0c156327504"} }

 "CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN",

instance:

347984t9

location_name":

}

"CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN"
  }

403

Request is unauthorized and will not be processed. This will happen if the authorization header does not contain a valid client id and secret.

Code Block
{ "message": "Forbidden" }

400

Request is malformed and will not be processed.

Code Block
{ "type": "cie-directory/

unauthorized

validation-error",
  "title": "

Request is not authorized to perform this operation

Invalid Parameter",
  "detail": "

The x-api-key header may be missing or is invalid", "instance":"4abdf0d4-e934-5575513f6d5" }

400

Request is malformed and will not be processed.

Code Block

parameter per_page was greater then the max allowed for this endpoint. per_page: 10000 max_allowed: 100",
  "instance": "237869a1-67f0-4a68-9500-734b3956517b"
}

500

Internal Server Error

Code Block
{ "type": "cie-directory/

validation

unkown-error",
  "title": "

Your request parameters

There was an error retrieving the services",
  "detail": "{\n\t\"stack\": \"Error: Error message\\n    at ServiceController.GetServicesAllComplete (/var/task/src/services/service-controller.js:214:13)\\n    at processTicksAndRejections (internal/process/task_queues.js:97:5)\\n    at async Runtime.exports.getServicesAllCompleteHandler [as

didn't validate.

handler] (/var/task/src/services/handler.js:73:22)\",\n\t\"message\": \"Error message\"\n}",
  "instance": "

4abdf0d4-e934-5575513f6d5

7a025b91-f1ff-4e4f-be75-42390fb02dd2"
}

Example CURL for this API Call

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'

...

Versions Compared

Old Version 1

New Version Current

Key

Swagger Definitions

Headers

Request

Response
Anchor
Response
Response

Example CURL for this API Call

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Swagger Definitions

Headers

Request

Response AnchorResponseResponse

Example CURL for this API Call

Response
Anchor
Response
Response