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

Retrieves BEERS Criteria for a specified monograph

Request Information

URI Parameters

NameDescriptionTypeAdditional information
cpnum

The CpNum of the monograph

integer

Required

Body Parameters

None.

Response Information

Resource Description

A list of BEERS Criteria for the monograph

BeersResponse
NameDescriptionTypeAdditional information
count

integer

None.

beers

Collection of BeersCriteria

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,
  "beers": [
    {
      "tableId": 1,
      "title": "sample string 2",
      "description": "sample string 3",
      "category": "sample string 4",
      "diseaseSyndrome": "sample string 5",
      "drugName": "sample string 6",
      "avoidCaution": "sample string 7",
      "rationale": "sample string 8",
      "qualityOfEvidence": "sample string 9",
      "strengthOfRecommendation": "sample string 10",
      "professionalNotes": "sample string 11"
    },
    {
      "tableId": 1,
      "title": "sample string 2",
      "description": "sample string 3",
      "category": "sample string 4",
      "diseaseSyndrome": "sample string 5",
      "drugName": "sample string 6",
      "avoidCaution": "sample string 7",
      "rationale": "sample string 8",
      "qualityOfEvidence": "sample string 9",
      "strengthOfRecommendation": "sample string 10",
      "professionalNotes": "sample string 11"
    }
  ]
}

application/xml, text/xml

Sample:
<beersResponse 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>
  <beers>
    <criteria>
      <avoidCaution>sample string 7</avoidCaution>
      <category>sample string 4</category>
      <description>sample string 3</description>
      <diseaseSyndrome>sample string 5</diseaseSyndrome>
      <drugName>sample string 6</drugName>
      <professionalNotes>sample string 11</professionalNotes>
      <qualityOfEvidence>sample string 9</qualityOfEvidence>
      <rationale>sample string 8</rationale>
      <strengthOfRecommendation>sample string 10</strengthOfRecommendation>
      <tableId>1</tableId>
      <title>sample string 2</title>
    </criteria>
    <criteria>
      <avoidCaution>sample string 7</avoidCaution>
      <category>sample string 4</category>
      <description>sample string 3</description>
      <diseaseSyndrome>sample string 5</diseaseSyndrome>
      <drugName>sample string 6</drugName>
      <professionalNotes>sample string 11</professionalNotes>
      <qualityOfEvidence>sample string 9</qualityOfEvidence>
      <rationale>sample string 8</rationale>
      <strengthOfRecommendation>sample string 10</strengthOfRecommendation>
      <tableId>1</tableId>
      <title>sample string 2</title>
    </criteria>
  </beers>
</beersResponse>