The Dynamic Health API GET /content/categories endpoint returns a list of categories and hierarchies based on the categoryPath query parameter passed in. The /content/categories endpoint is a good starting point for someone who is not very familiar with the Dynamic Health content set. The endpoint retrieves categories available in Dynamic Health that match the supplied path. The categories can be used to get content or search for the terms against the Dynamic Health content set. The /content/categories endpoint provides two parameters for specifying the search criteria: the category path and shallow. shallow is a boolean and determines if only top level results (true) are returned or if the child paths (false) are returned.

Basic Categories Search

To Perform a Categories Query (example):

Gather the following information for the request:

• An access token. Please see Using the Client Credentials Grant for further information.
• A content path.

Request

https://apis.ebsco.com/medsapi-dynamic-health/v1/content/categories?shallow=true&categoryPath=Skills|Nursing Skills

The request above is for categories for 'Skills|Nursing Skills'. The request specifies to search for categories in Dynamic Health content that fall under this path and to only return the top level results.

Response

 {
  "_metadata": {
    "totalItems": 1,
    "links": [
      {
        "rel": "self",
        "href": "https://apis.ebsco.com/medsapi-dynamic-health/v1/content/categories?shallow=false&categoryPath=Skills%7CNursing%20Skills"
      }
    ]
  },
  "items": [
    {
      "title": "Specialties",
      "categoryPath": "Skills|Nursing Skills|Specialties",
      "hasChildren": true,
      "children": [
        {
          "title": "Cardiovascular Care",
          "categoryPath": "Skills|Nursing Skills|Specialties|Cardiovascular Care",
          "hasChildren": true,
          "children": [
            {
              "title": "EKG",
              "categoryPath": "Skills|Nursing Skills|Specialties|Cardiovascular Care|EKG",
              "hasChildren": false
            }
          ]
        }
      ]
    }
  ]
}

Error Response Codes

The Dynamic Health retrieve a list of categories endpoint can return one of the error response codes.