...
The following are the URLs for this API.
Swagger Definitions
The following are the URLs for this API.
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 |
sort_by
| field sort:
This will allow the data to be 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
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 service record. | | Code Block |
|---|
[
{
"id": 1,
"organization_id": 969,
"location_id": 970,
"source_service_id": 1106,
"source_id_programAtSite": |
|
null78189075,
"source_id_program": 78143321,
"source": "icarol",
"program_id": null,
"program": "CHILDREN'S ADVOCACY CENTER",
"name": "COUNSELING SERVICES AND PREVENTION FOR CHILDREN WHO ARE ABUSED",
"alternate_name": null,
"description": "Provides forensic interviews for sexually abused children, counseling services for sexually abused children, including adults survivors of child sexual abuse, and prevention education.",
"url": |
|
null"www.swmichigancac.org",
"email": |
|
null"info@swmichigancac.org",
"status": 1,
"interpretation_services": null,
"application_process": "- 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": " |
|
InterpretationTranslation services available",
"payment_accepted": "Not applicable",
"required_document": "Referral information",
"service_area": "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",
"county": "Berrien",
"postal_code": "49085",
"state_province": "MI",
"organization_name": "CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
"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/validation-error",
"title": "Invalid Parameter",
"detail": "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/unkown-error",
"title": "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 handler] (/var/task/src/services/handler.js:73:22)\",\n\t\"message\": \"Error message\"\n}",
"instance": "7a025b91-f1ff-4e4f-be75-42390fb02dd2"
}
|
|
Example CURL for this API Call
...