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

Returns a list of drug names used outside the US, grouped by country.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
cpnum

The CpNum of the monograph.

integer

Required

Body Parameters

None.

Response Information

Resource Description

A list of countries and the drug names used in each.

GlobalDrugNameResponse
NameDescriptionTypeAdditional information
count

integer

None.

total

integer

None.

countries

Collection of GlobalDrugNameCountry

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,
  "total": 2,
  "countries": [
    {
      "countryName": "sample string 1",
      "drugs": [
        {
          "brand": "sample string 1",
          "manufacturer": "sample string 2"
        },
        {
          "brand": "sample string 1",
          "manufacturer": "sample string 2"
        }
      ]
    },
    {
      "countryName": "sample string 1",
      "drugs": [
        {
          "brand": "sample string 1",
          "manufacturer": "sample string 2"
        },
        {
          "brand": "sample string 1",
          "manufacturer": "sample string 2"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<globalDrugnameResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ElsevierGSContentServices.Models.Monographs">
  <_languages xmlns="">
    <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 xmlns="">
    <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>
  <total>2</total>
  <countries>
    <country xmlns="">
      <countryName>sample string 1</countryName>
      <drugs>
        <drug>
          <brand>sample string 1</brand>
          <manufacturer>sample string 2</manufacturer>
        </drug>
        <drug>
          <brand>sample string 1</brand>
          <manufacturer>sample string 2</manufacturer>
        </drug>
      </drugs>
    </country>
    <country xmlns="">
      <countryName>sample string 1</countryName>
      <drugs>
        <drug>
          <brand>sample string 1</brand>
          <manufacturer>sample string 2</manufacturer>
        </drug>
        <drug>
          <brand>sample string 1</brand>
          <manufacturer>sample string 2</manufacturer>
        </drug>
      </drugs>
    </country>
  </countries>
</globalDrugnameResponse>