GET \taxonomy

Introduction

This API will allow the use to query and retrieve a list of the taxonomy codes that are being tagged by the services.

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/taxonomy
Production	GET https://directory.mi-cie.org/v1/taxonomy

Swagger Definitions

The following are the URLs for this API.

Environment	URL

Environment	URL
UAT	https://directory-uat.mi-cie.org/v1/swagger#/taxonomy/get_taxonomy

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. This is an json object and
`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,
    "taxonomy_id": "B",
    "parent_id": null,
    "name": "Basic Needs",
    "description": "Programs that furnish survival level resources including food, housing, material goods, transportation and utilities for individuals with low or fixed incomes, people who are homeless, older adults and/or people with disabilities who are otherwise unable to adequately provide for themselves and their families. Also included are related services that are available to the community at large.",
    "vocabulary": "AIRS",
    "language": "English"
  },
  {
    "id": 2,
    "taxonomy_id": "BD",
    "parent_id": "B",
    "name": "Food",
    "description": "Programs that seek to meet the basic nutritional needs of the community by providing access to food products.",
    "vocabulary": "AIRS",
    "language": "English"
  },
  {
    "id": 3,
    "taxonomy_id": "BD-1800",
    "parent_id": "BD",
    "name": "Emergency Food",
    "description": "Programs that provide a limited amount of food for individuals or families during times of personal crisis, or for people who have no food or cannot afford to purchase food at retail costs.",
    "vocabulary": "AIRS",
    "language": "English"
  },
  {
    "id": 4,
    "taxonomy_id": "BD-1800.1000",
    "parent_id": "BD-1800",
    "name": "Brown Bag Food Programs",
    "description": "Programs offered by senior centers or other community organizations, generally outside the food pantry network, that pack shopping bags (or other containers) with a supply of nutritional donated and surplus food for distribution to low-income individuals or families, students or older adults to supplement their meals at home.",
    "vocabulary": "AIRS",
    "language": "English"
  },
  {
    "id": 5,
    "taxonomy_id": "BD-1800.1500",
    "parent_id": "BD-1800",
    "name": "Commodity Supplemental Food Program",
    "description": "A federally funded program that works to improve the health of elderly people age 60 and older who meet income eligibility requirements by supplementing their diets with nutritious USDA commodity foods. The program provides food and administrative funds to states, typically departments of health, social services, education or agriculture. The state agencies store CSFP food and distribute it to local public and private, nonprofit organizations that determine the eligibility of applicants, distrib",
    "vocabulary": "AIRS",
    "language": "English"
  },
  {
    "id": 6,
    "taxonomy_id": "BD-1800.1900",
    "parent_id": "BD-1800",
    "name": "Food Lines",
    "description": "Food programs that provide boxes or bags of food on a first come, first served basis for eligible people who line up, usually on a designated date at a specified time, to receive service.",
    "vocabulary": "AIRS",
    "language": "English"
  },
  {
    "id": 7,
    "taxonomy_id": "BD-1800.2000",
    "parent_id": "BD-1800",
    "name": "Food Pantries",
    "description": "Programs that acquire food products through donations, canned food drives, food bank programs or direct purchase and distribute the food to people who are in emergency situations. Some pantries deliver food to people whose disabilities or illnesses make it difficult for them to leave home.",
    "vocabulary": "AIRS",
    "language": "English"
  },
  {
    "id": 8,
    "taxonomy_id": "BD-1800.2000-620",
    "parent_id": "BD-1800.2000",
    "name": "Occasional Emergency Food Assistance",
    "description": "Food pantries that provide a box or bag of groceries on a one-time only or other limited basis for people who are unable to provide food for themselves or their families. Included are programs that provide enough food for an entire balanced meal or series of meals and those that provide a supplemental supply of groceries. Some programs deliver food to people whose disabilities or illnesses make it difficult for them to leave home.",
    "vocabulary": "AIRS",
    "language": "English"
  },
  {
    "id": 9,
    "taxonomy_id": "BD-1800.2000-640",
    "parent_id": "BD-1800.2000",
    "name": "Ongoing Emergency Food Assistance",
    "description": "Programs that provide an ongoing supply of groceries, usually once a month, for people whose income is not sufficient to meet their needs. Included are programs that provide enough food for an entire balanced meal or series of meals and those that provide a supplemental supply of groceries. Some programs deliver food to people whose disabilities or illnesses make it difficult for them to leave home.",
    "vocabulary": "AIRS",
    "language": "English"
  },
  {
    "id": 10,
    "taxonomy_id": "BD-1800.2250",
    "parent_id": "BD-1800",
    "name": "Food Vouchers",
    "description": "Programs that supply food coupons which can be exchanged in designated grocery stores, supermarkets and/or farmers markets for food products. The vouchers are generally provided to low income individuals and families on an occasional or ongoing basis, but may also be available to other specified populations; and may be issued in paper or electronic formats.",
    "vocabulary": "AIRS",
    "language": "English"
  }
]

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.