GET api/v1/monographs/{cpnum}/interactions?type={type}

Retrieves information om monograph Interactions

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

Body Parameters

None.

Response Information

Resource Description

Content regarding the Interactions

InteractionMonographResponse
NameDescriptionTypeAdditional information
content

Collection of string

None.

terms

Collection of InteractionTerm

None.

references

Collection of Reference

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",
  "content": [
    "sample string 1",
    "sample string 2"
  ],
  "lastUpdate": "2023-02-07T02:41:40.8291727-05:00",
  "terms": [
    {
      "type": 1,
      "rating": 2,
      "term": "sample string 3",
      "name": "sample string 4",
      "termId": 5
    },
    {
      "type": 1,
      "rating": 2,
      "term": "sample string 3",
      "name": "sample string 4",
      "termId": 5
    }
  ],
  "references": [
    {
      "id": 1,
      "title": "sample string 2",
      "pubMedId": 3
    },
    {
      "id": 1,
      "title": "sample string 2",
      "pubMedId": 3
    }
  ]
}

application/xml, text/xml

Sample:
<interactionMonographResponse 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:41:40.8291727-05:00</lastUpdate>
  <references>
    <reference>
      <id>1</id>
      <pubMedId>3</pubMedId>
      <title>sample string 2</title>
    </reference>
    <reference>
      <id>1</id>
      <pubMedId>3</pubMedId>
      <title>sample string 2</title>
    </reference>
  </references>
  <content xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </content>
  <terms>
    <interactionTerm>
      <name>sample string 4</name>
      <termId>5</termId>
      <rating>2</rating>
      <term>sample string 3</term>
      <type>1</type>
    </interactionTerm>
    <interactionTerm>
      <name>sample string 4</name>
      <termId>5</termId>
      <rating>2</rating>
      <term>sample string 3</term>
      <type>1</type>
    </interactionTerm>
  </terms>
</interactionMonographResponse>