POST api/v1/reports/clinical-comparison/report

Runs the Clinical Comparison reports

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
cpnums	Collection of integer	None.
indications	Collection of integer	None.
contraIndications	Collection of integer	None.
adverseReactions	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "cpnums": [
    1,
    2
  ],
  "indications": [
    1,
    2
  ],
  "contraIndications": [
    1,
    2
  ],
  "adverseReactions": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<clinicalComparisonRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <adverseReactions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </adverseReactions>
  <contraIndications xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </contraIndications>
  <cpnums xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </cpnums>
  <indications xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </indications>
</clinicalComparisonRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ListResponseOfClinicalComparisonTermRow

Name	Type	Additional information
count	integer	None.
items	Collection of ClinicalComparisonTermRow	None.
_links	Collection of Link	None.
_languages	Collection of LanguagesLink	None.

Response Codes

Code	Description	Additional information
200	OK	The request returned without error
204	No Content	The request was successful but no results were returned
400	Bad Request	A parameter was missing or invalid
404	Not Found	The 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,
  "items": [
    {
      "id": 1,
      "name": "sample string 2",
      "type": "sample string 3",
      "drugs": [
        {
          "cpnum": 1,
          "name": "sample string 2",
          "value": "sample string 3",
          "offLabel": true,
          "absolute": true,
          "blackBox": true
        },
        {
          "cpnum": 1,
          "name": "sample string 2",
          "value": "sample string 3",
          "offLabel": true,
          "absolute": true,
          "blackBox": true
        }
      ]
    },
    {
      "id": 1,
      "name": "sample string 2",
      "type": "sample string 3",
      "drugs": [
        {
          "cpnum": 1,
          "name": "sample string 2",
          "value": "sample string 3",
          "offLabel": true,
          "absolute": true,
          "blackBox": true
        },
        {
          "cpnum": 1,
          "name": "sample string 2",
          "value": "sample string 3",
          "offLabel": true,
          "absolute": true,
          "blackBox": true
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<listResponse 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>
  <items xmlns:d2p1="http://schemas.datacontract.org/2004/07/ElsevierGSContentServices.Models.Reports.ClinicalComparison">
    <d2p1:row>
      <d2p1:drugs>
        <drug>
          <absolute>true</absolute>
          <blackBox>true</blackBox>
          <cpnum>1</cpnum>
          <name>sample string 2</name>
          <offLabel>true</offLabel>
          <value>sample string 3</value>
        </drug>
        <drug>
          <absolute>true</absolute>
          <blackBox>true</blackBox>
          <cpnum>1</cpnum>
          <name>sample string 2</name>
          <offLabel>true</offLabel>
          <value>sample string 3</value>
        </drug>
      </d2p1:drugs>
      <d2p1:id>1</d2p1:id>
      <d2p1:name>sample string 2</d2p1:name>
      <d2p1:type>sample string 3</d2p1:type>
    </d2p1:row>
    <d2p1:row>
      <d2p1:drugs>
        <drug>
          <absolute>true</absolute>
          <blackBox>true</blackBox>
          <cpnum>1</cpnum>
          <name>sample string 2</name>
          <offLabel>true</offLabel>
          <value>sample string 3</value>
        </drug>
        <drug>
          <absolute>true</absolute>
          <blackBox>true</blackBox>
          <cpnum>1</cpnum>
          <name>sample string 2</name>
          <offLabel>true</offLabel>
          <value>sample string 3</value>
        </drug>
      </d2p1:drugs>
      <d2p1:id>1</d2p1:id>
      <d2p1:name>sample string 2</d2p1:name>
      <d2p1:type>sample string 3</d2p1:type>
    </d2p1:row>
  </items>
</listResponse>