GET \services\areas

Introduction

The directory allows for searching for services that are served in an area. An area can be a city, county, or a zip code. The following API returns all the possible areas that can searched for. Notice that it includes the spilt zips that fall into different counties.

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

Environment	URL
UAT	GET https://directory-uat.mi-cie.org/v1/services/areas
Production	GET https://directory.mi-cie.org/v1/services/areas

Swagger Definitions

The following are the URLs for this API.

Environment	URL

Environment	URL
UAT

Headers

The following will be headers that will need to be supplied

Header	Description

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

Data Element	Description	Default
Query String
`query`	A query parameter that will filter out the services that will be returned.
`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

Response

The following will be the response values from the calling of the API. The error responses will conform ]to the following specification. RFC 7807: Problem Details for HTTP APIs .

HTTP Status Code	Description	Response Example

HTTP Status Code

Description

Response Example

200

Successful retrieval of a person record.

	
[
  {
    "id": 1,
    "type": "zipcode",
    "name": "48001"
  },
  {
    "id": 2,
    "type": "zipcode",
    "name": "48002"
  },
  {
    "id": 3,
    "type": "zipcode",
    "name": "48003"
  },
  {
    "id": 4,
    "type": "zipcode",
    "name": "48004"
  },
  {
    "id": 5,
    "type": "zipcode",
    "name": "48005"
  },
  {
    "id": 6,
    "type": "zipcode",
    "name": "48006"
  },
  {
    "id": 7,
    "type": "zipcode",
    "name": "48007"
  },
  {
    "id": 8,
    "type": "zipcode",
    "name": "48009"
  },
  {
    "id": 9,
    "type": "zipcode",
    "name": "48012"
  },
  {
    "id": 10,
    "type": "zipcode",
    "name": "48014-Lapeer"
  }
]

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/areas' 
--header 'x-api-key: aGZoczo4****2ZDk=' 
--header 'Content-Type: application/json' 
--header 'Authorization: bearer etty****iquerui'