GET api/v1/monographs/{cpnum}/drugclass

Gets a list of drug class overviews

Request Information

URI Parameters

NameDescriptionTypeAdditional information
cpnum

The CpNum of the monograph.

integer

Required

Body Parameters

None.

Response Information

Resource Description

A list of drug class overviews

DrugClassOverviewItemResponse
NameDescriptionTypeAdditional information
count

integer

None.

overviews

Collection of DrugClassOverview

None.

_links

Collection of Link

None.

_languages

Collection of LanguagesLink

None.

Response Codes

CodeDescriptionAdditional information
200OKThe request returned without error
204No ContentThe request was successful but no results were returned
400Bad RequestA parameter was missing or invalid
404Not FoundThe requested resource was not found

Response Formats

application/json, text/json

Sample:
{
  "_links": [
    {
      "rel": "sample string 1",
      "locale": "sample string 4",
      "href": "sample string 2",
      "templated": true
    },
    {
      "rel": "sample string 1",
      "locale": "sample string 4",
      "href": "sample string 2",
      "templated": true
    }
  ],
  "_languages": [
    {
      "rel": "sample string 1",
      "locale": "sample string 3",
      "name": "sample string 4",
      "href": "sample string 2"
    },
    {
      "rel": "sample string 1",
      "locale": "sample string 3",
      "name": "sample string 4",
      "href": "sample string 2"
    }
  ],
  "count": 1,
  "overviews": [
    {
      "structureId": 1,
      "title": "sample string 2"
    },
    {
      "structureId": 1,
      "title": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<drugClassOverviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <_languages>
    <languageslink>
      <rel>sample string 1</rel>
      <locale>sample string 3</locale>
      <name>sample string 4</name>
      <href>sample string 2</href>
    </languageslink>
    <languageslink>
      <rel>sample string 1</rel>
      <locale>sample string 3</locale>
      <name>sample string 4</name>
      <href>sample string 2</href>
    </languageslink>
  </_languages>
  <_links>
    <link>
      <rel>sample string 1</rel>
      <locale>sample string 4</locale>
      <href>sample string 2</href>
      <templated>true</templated>
    </link>
    <link>
      <rel>sample string 1</rel>
      <locale>sample string 4</locale>
      <href>sample string 2</href>
      <templated>true</templated>
    </link>
  </_links>
  <count>1</count>
  <overviews>
    <overview>
      <structureId>1</structureId>
      <title>sample string 2</title>
    </overview>
    <overview>
      <structureId>1</structureId>
      <title>sample string 2</title>
    </overview>
  </overviews>
</drugClassOverviewResponse>