GET api/v1/interactions/under-development-cpnum?cpnums={cpnums}

Returns the interaction development status for the input monograph CpNum identifier(s).

Request Information

URI Parameters

NameDescriptionTypeAdditional information
cpnums

A comma delimited list of CpNums (1,2,3)

string

Required

Body Parameters

None.

Response Information

Resource Description

InteractionsUnderDevelopmentResponseCPNUM
NameDescriptionTypeAdditional information
developmentStatusCPNUM

Collection of DrugInteractionDevelopmentStatusCPNUM

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:
{
  "developmentStatusCPNUM": [
    {
      "cpNum": 1,
      "interactionsUnderDevelopment": 0,
      "interactionsMessage": "sample string 2"
    },
    {
      "cpNum": 1,
      "interactionsUnderDevelopment": 0,
      "interactionsMessage": "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"
    }
  ]
}

application/xml, text/xml

Sample:
<interactionsUnderDevelopmentResponseCPNUM 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>
  <developmentStatusCPNUM>
    <interactionDevelopmentStatusCPNUM>
      <cpNum>1</cpNum>
      <interactionsUnderDevelopment>False</interactionsUnderDevelopment>
      <interactionsMessage>sample string 2</interactionsMessage>
    </interactionDevelopmentStatusCPNUM>
    <interactionDevelopmentStatusCPNUM>
      <cpNum>1</cpNum>
      <interactionsUnderDevelopment>False</interactionsUnderDevelopment>
      <interactionsMessage>sample string 2</interactionsMessage>
    </interactionDevelopmentStatusCPNUM>
  </developmentStatusCPNUM>
</interactionsUnderDevelopmentResponseCPNUM>