Introduction
This API will allow the user to query for complete information on services. The API can be called without passing a ID parameter in the path to get a specific service. Please note that if you are searching for a list of services and don’t need all the information the \services call will be faster.
Authorization
The authorization will contain an API key and also will use an OAuth2 access token. An API key will be provided to each client that intends to consume this API. A development key and also a separate production key will be provided. If this key is not included then an authorization error will be returned.
The process for getting an OAuth2 token can be found here Authorization
Scope Needed For This API - mi-cie.hub/read
Rest URL
The following are the URLs for this API.
Environment | URL |
|---|---|
UAT | GET https://directory-uat.mi-cie.org/v1/services/complete/{id} GET https://directory-uat.mi-cie.org/v1/services/complete/ |
Production | GET https://directory.mi-cie.org/v1/services/complete/{id} GET https://directory.mi-cie.org/v1/services/complete |
Swagger Definitions
The following are the URLs for this API.
Environment | URL |
|---|---|
UAT | https://directory-uat.mi-cie.org/v1/swagger#/services/get_services_complete https://directory-uat.mi-cie.org/v1/swagger#/services/get_services_complete__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 | ||
| 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 | ||
| 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 |
|
| This will be which page of data that the user wants to be returned. | Default to Page 1 |
| This will be the number of records that can be queried at a time. The maximum that can be queried is 30. | Default to 10 |
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 record.
| [
{
"id": 1,
"organization_id": 969,
"location_id": 970,
"source_service_id": "1106",
"program_id": 2048,
"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,
"email": null,
"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",
"accreditations": null,
"licenses": null,
"eligibility": "Children and families of suspected child abuse in Southwest Michigan",
"language": "Interpretation 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",
"contacts": [
{
"id": "2048",
"organization_id": "969",
"location_id": "970",
"service_id": "1",
"service_at_location_id": "",
"name": "",
"title": "",
"department": "",
"email": "",
"hasPhone": "1"
}
],
"regular_schedule": [
{
"id": "9212",
"organization_id": "",
"service_id": "1",
"service_at_location_id": "",
"weekday": "",
"opens_at": "",
"closes_at": "",
"administrative_hours": "",
"service_hours": "Mon and Wed 8:30am-8pm; Tue and Thu 8:30am-5pm; Fri 8:30am-4pm",
"site_hours": ""
}
],
"phones": [
{
"id": "18427",
"organization_id": "",
"service_id": "1",
"service_at_location_id": "",
"number": "2695569640",
"extension": "",
"phone_type_hierarchy": "1",
"type": "Main",
"department": "",
"language": "",
"description": ""
}
],
"service_taxonomy": [
{
"id": "8192",
"service_id": "1",
"taxonomy_id": "FN-1500.1900-150",
"taxonomy_detail": "Child Abuse Prevention",
"category": "",
"subcategory": ""
},
{
"id": "8193",
"service_id": "1",
"taxonomy_id": "RP-1400.8000-020.15",
"taxonomy_detail": "Child Abuse Counseling",
"category": "Mental Health Evalua",
"subcategory": "Abuse Counseling"
},
{
"id": "8194",
"service_id": "1",
"taxonomy_id": "RP-1400.8000-800",
"taxonomy_detail": "Sexual Assault Counseling",
"category": "Mental Health Evalua",
"subcategory": "Counseling Services"
}
],
"physical_address": [
{
"id": "5362",
"organization_id": "",
"location_id": "970",
"attention": "",
"address_1": "4938 Niles Road",
"address_2": "",
"address_3": "",
"address_4": "",
"city": "Saint Joseph",
"county": "Berrien",
"region": "",
"state_province": "MI",
"postal_code": "49085",
"country": "USA"
}
],
"locations": [
{
"id": "970",
"organization_id": "969",
"organization_name": "CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
"name": "CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
"alternate_name": "",
"url": "www.swmichigancac.org",
"description": "Located on Old US 31 near intersection of Marquette Woods Road and US-31",
"accessibility_for_disabilities": "",
"transportation": "No public transportation available",
"latitude": "42.0225356",
"longitude": "86.4205098"
}
],
"service_area_served": [
{
"id": "23308",
"service_id": "1",
"type": "county",
"name": "Berrien"
},
{
"id": "23309",
"service_id": "1",
"type": "county",
"name": "Cass"
},
{
"id": "23310",
"service_id": "1",
"type": "county",
"name": "Van Buren"
}
]
}
]
|
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.
|
{
"message": "Forbidden"
}
|
400 | Request is malformed and will not be processed.
| {
"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"
}
|
Example CURL for this API Call
The following is an example CURL for calling this api.
curl -v --request GET 'https://directory-uat.mi-cie.org/v1/services/complete' --header 'x-api-key: aGZoczo4****2ZDk=' --header 'Content-Type: application/json' --header 'Authorization: bearer etty****iquerui'
0 Comments