Versions Compared

Version Old Version 1 New Version Current
Changes made by

Jonathan Draugelis

Jonathan Draugelis

Saved on

Key

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

Introduction

This API will allow the use to query for header information on services. The API can be called without passing a ID parameter in the

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.

...

Info

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

organizations/{id}

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

services

organizations

Production

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

services

organizations/{id}

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

services

organizations/

Swagger Definitions

The following are the URLs for this API.

Environment

URL

UAT

https://directory-uat.mi-cie.org/v1/swagger#/

services

organizations/

get

{organization_

services

id}

https://directory-uat.mi-cie.org/v1/swagger#/

services/get_services__serviceId_

organizations

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

organization id of the requested record in the directory.

*Please note that this is only needed if you want to get a specific

service

organization payload for a ID.

Query String

query

A query parameter that will filter out the

services

organizations 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

1580269590/

services#Common

organizations#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 examples that can be passed in

Code Block// By a given lat and long {"lat":"45.8976","lng":"-84.89876"} // By the middle of a city {"type":"city","name":"Grand Rapids"} // By the middle of a zipcode {"type":"zipcode","name":"49505"}

DESC or ASC default is ASC

sort_by

Can be sorted by any root field.

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 service record.

 

Code Block
[
  {
    "id":
1,
"organization_id": 
969,
    "
location_id": 970, "source_service_id
name": "
1106", "program_id": 2048, "program": "
CHILDREN'S ADVOCACY CENTER
",
 OF SOUTHWEST
"name": "COUNSELING SERVICES AND PREVENTION FOR CHILDREN WHO ARE ABUSED"
MICHIGAN",
    "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.
"BERRIEN COUNTY COUNCIL FOR CHILDREN, CHILDRENS ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
    "
url
organization_type":
null, "email": null, "status": 1
"Nonprofit - Incorporated",
    "
interpretation
source_
services
id":
null
78135838,
    "
application_process
source": "
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.
icarol",
    "
wait_time
description":
null, 
 "
fees": "No fees", "accreditations": null, "licenses": null, "eligibility": "Children and families of suspected child abuse in Southwest Michigan
Supports children through a coordinated response to child abuse that includes prevention, assessment and intervention.",
    "
language
email": "
Interpretation services available
info@swmichigancac.org",
    "
payment_accepted
url": "
Not applicable
www.swmichigancac.org",
    "
required
tax_
document
status":
"Referral information"
null,
    "
service
tax_
area
id": "
Berrien, Cass and Van Buren Counties
38-2265793",
    "
area
schedule_
served_description
notes": "
Berrien
Mon,
Cass and Van Buren Counties", "region": "GRYP
Wed 9am-8pm; Tue, Thu-Fri 9am-5pm",
    "
address
year_
1
incorporated": "
4938 Niles Road
1986",
    "
city": "Saint Joseph", "county": "Berrien", "postal_code
legal_status":
"49085"
null,
    "
organization_name
contact":
"CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN"
null,
    "
location_name
region": "
CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN
GRYP"
  }
]

 

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

The following is an example CURL for calling this api.

...