| Table of Contents |
|---|
Introduction
This API will return social services data in one of four categories:
organizations, locations, services, contactsThe Social Services Directory is a repository of social services managed and curated by Michigan 211 that can be searched. The API was built on the Open Referral Specification. Here is a link to the website https://openreferral.org/ .
The API consists of four different entities that can be queried.
Entity | Description |
|---|---|
Organizations | The organization record is used to provide basic description and details about each organization delivering services. Each service should be linked to the organization responsible for its delivery. One organization may deliver many services. |
Contacts | The contact table contains details of the named contacts for services and organizations. Note that in the Human Services Data Specification (HSDS) http://docs.openreferral.org/en/latest/hsds/ data package format, if an individual is the contact for multiple services, their details may be duplicated multiple times in this table, each time with a new identifier, and with the rows containing different service ids. |
Services | Services are the specific types of assistance provided by organizations to a range of different constituents. |
Locations | Locations are the physical or virtual locations and associated details where organizations operate. Locations may be virtual, and one organization may have many locations. |
Testing out the API
A swagger page is available for testing purposes: /wiki/spaces/CDF/pages/1058340865
...
| Info |
|---|
Scope Needed For This API SouthEast Michigan Social Services Directory - semimi-cie.directory/read Michigan Social Services Directory - cie.directory/read |
Base Rest URL
The following are the URLs for this API. Please note that base url for the region you are looking for can be found here Community of Information Exchange Hub Region URL
Environment | URL |
|---|---|
Development | POST https://directory-dev.{mi-cie-region}.org/v1/ |
UAT | POST https://directory-uat.{mi-cie-region}.org/v1/ |
Production | POST https://directory.{mi-cie-region}.org/v1/ |
Headers
...
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 |
...