GET api/v1/monographs/{cpnum}?type={type}&productId={productId}

Rest end point for getting a monograph summary.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
cpnum

The CpNum of the monograph.

integer

Required

type

The type of monograph (General or Pediatric).

MonographType

Default value is General

productId

The id of the product

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

A Monograph Summary

MonographResponse
NameDescriptionTypeAdditional information
flags

MonographFlags

None.

availableTypes

Collection of MonographType

None.

definitions

Collection of MonographDefinition

None.

options

Collection of MonographOption

None.

reports

Collection of MonographOption

None.

medCounselor

Collection of MedCounselorSheet

None.

dischargeInstructions

Collection of DischargeInstructionItem

None.

products

Collection of MonographProduct

None.

cpnum

integer

None.

type

MonographType

None.

mini

boolean

None.

name

string

None.

lastUpdate

date

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:
{
  "cpnum": 1,
  "_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"
    }
  ],
  "type": 0,
  "mini": true,
  "name": "sample string 3",
  "flags": {
    "hasRems": true,
    "hasMedGuides": true,
    "hasConfusedDrugName": true,
    "hasDrugClassOverview": true,
    "hasBlackBox": true,
    "hasBeersCriteria": true,
    "hasIsmpAcuteHighAlert": true,
    "hasIsmpAmbulatoryHighAlert": true,
    "hasNti": true
  },
  "lastUpdate": "2023-02-07T02:51:46.0912907-05:00",
  "availableTypes": [
    0,
    0
  ],
  "definitions": [
    {
      "name": "sample string 1",
      "title": "sample string 2",
      "value": "sample string 3"
    },
    {
      "name": "sample string 1",
      "title": "sample string 2",
      "value": "sample string 3"
    }
  ],
  "options": [
    {
      "description": "sample string 1",
      "key": "sample string 2",
      "_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"
        }
      ]
    },
    {
      "description": "sample string 1",
      "key": "sample string 2",
      "_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"
        }
      ]
    }
  ],
  "reports": [
    {
      "description": "sample string 1",
      "key": "sample string 2",
      "_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"
        }
      ]
    },
    {
      "description": "sample string 1",
      "key": "sample string 2",
      "_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"
        }
      ]
    }
  ],
  "medCounselor": [
    {
      "gpcid": 1,
      "name": "sample string 2",
      "hasEnglish": true,
      "hasSpanish": true
    },
    {
      "gpcid": 1,
      "name": "sample string 2",
      "hasEnglish": true,
      "hasSpanish": true
    }
  ],
  "dischargeInstructions": [
    {
      "id": 1,
      "guid": "sample string 2",
      "name": "sample string 3"
    },
    {
      "id": 1,
      "guid": "sample string 2",
      "name": "sample string 3"
    }
  ],
  "products": [
    {
      "id": 1,
      "name": "sample string 2",
      "manufacturer": "sample string 3",
      "offMarket": "2023-02-07T02:51:46.0912907-05:00"
    },
    {
      "id": 1,
      "name": "sample string 2",
      "manufacturer": "sample string 3",
      "offMarket": "2023-02-07T02:51:46.0912907-05:00"
    }
  ]
}

application/xml, text/xml

Sample:
<monograph 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>
  <cpnum>1</cpnum>
  <type>General</type>
  <mini>true</mini>
  <name>sample string 3</name>
  <lastUpdate>2023-02-07T02:51:46.0912907-05:00</lastUpdate>
  <flags>
    <hasBeersCriteria>true</hasBeersCriteria>
    <hasBlackBox>true</hasBlackBox>
    <hasConfusedDrugName>true</hasConfusedDrugName>
    <hasDrugClassOverview>true</hasDrugClassOverview>
    <hasIsmpAcuteHighAlert>true</hasIsmpAcuteHighAlert>
    <hasIsmpAmbulatoryHighAlert>true</hasIsmpAmbulatoryHighAlert>
    <hasMedGuides>true</hasMedGuides>
    <hasNti>true</hasNti>
    <hasRems>true</hasRems>
  </flags>
  <availableTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/ElsevierGSContentServices.Core">
    <d2p1:MonographType>General</d2p1:MonographType>
    <d2p1:MonographType>General</d2p1:MonographType>
  </availableTypes>
  <definitions>
    <definition>
      <name>sample string 1</name>
      <title>sample string 2</title>
      <value>sample string 3</value>
    </definition>
    <definition>
      <name>sample string 1</name>
      <title>sample string 2</title>
      <value>sample string 3</value>
    </definition>
  </definitions>
  <options>
    <option>
      <_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>
      <description>sample string 1</description>
      <key>sample string 2</key>
    </option>
    <option>
      <_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>
      <description>sample string 1</description>
      <key>sample string 2</key>
    </option>
  </options>
  <reports>
    <option>
      <_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>
      <description>sample string 1</description>
      <key>sample string 2</key>
    </option>
    <option>
      <_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>
      <description>sample string 1</description>
      <key>sample string 2</key>
    </option>
  </reports>
  <medCounselor>
    <sheet>
      <gpcid>1</gpcid>
      <hasEnglish>true</hasEnglish>
      <hasSpanish>true</hasSpanish>
      <name>sample string 2</name>
    </sheet>
    <sheet>
      <gpcid>1</gpcid>
      <hasEnglish>true</hasEnglish>
      <hasSpanish>true</hasSpanish>
      <name>sample string 2</name>
    </sheet>
  </medCounselor>
  <dischargeInstructions>
    <dischargeInstruction>
      <guid>sample string 2</guid>
      <id>1</id>
      <name>sample string 3</name>
    </dischargeInstruction>
    <dischargeInstruction>
      <guid>sample string 2</guid>
      <id>1</id>
      <name>sample string 3</name>
    </dischargeInstruction>
  </dischargeInstructions>
  <products>
    <product>
      <id>1</id>
      <manufacturer>sample string 3</manufacturer>
      <name>sample string 2</name>
      <offMarket>2023-02-07T02:51:46.0912907-05:00</offMarket>
    </product>
    <product>
      <id>1</id>
      <manufacturer>sample string 3</manufacturer>
      <name>sample string 2</name>
      <offMarket>2023-02-07T02:51:46.0912907-05:00</offMarket>
    </product>
  </products>
</monograph>