Versions Compared

Version Old Version 4 New Version Current
Changes made by

Jonathan Draugelis

Jonathan Draugelis

Saved on

Key

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

...

The following are the URLs for this API.

Environment

URL

UAT

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

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

Production

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

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

Swagger Definitions

The following are the URLs for this API.

Environment

URL

UAT

https://directory-uat.mi-cie.org/v1/swagger#/organizations/{organization_id}

https://directory-uat.mi-cie.org/v1/swagger#/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 organization id of the requested record in the directory.

*Please note that this is only needed if you want to get a specific organization payload for a ID.

Query String

query

A query parameter that will filter out the 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/1580269590/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

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": 969,
    "name": "CHILDREN'S ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
    "alternate_name": "BERRIEN COUNTY COUNCIL FOR CHILDREN, CHILDRENS ADVOCACY CENTER OF SOUTHWEST MICHIGAN",
    "organization_type": "Nonprofit - Incorporated",
    "source_id": 78135838,
    "source": "icarol",
    "description":
null
 "Supports children through a coordinated response to child abuse that includes prevention, assessment and intervention.",
    "email": "info@swmichigancac.org",
    "url": "www.swmichigancac.org",
    "tax_status": null,
    "tax_id": "38-2265793",
    "schedule_notes":
null
 "Mon, Wed 9am-8pm; Tue, Thu-Fri 9am-5pm",
    "year_incorporated":
null
"1986",
    "legal_status": null,
    "contact": null,
    "region": "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

...