GET api/v1/reports/clinical-comparison/terms?cpnums={cpnums}

Returns lists of terms matching the requested cpnums

Request Information

URI Parameters

Name	Description	Type	Additional information
cpnums	A comma delimeted list of cpnums	string	Required

Body Parameters

None.

Response Information

Resource Description

ClinicalComparisonTermResponse

Name	Type	Additional information
indications	Collection of GsTerm	None.
contraindications	Collection of GsTerm	None.
adverseReactions	Collection of GsTerm	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:

{
  "indications": [
    {
      "name": "sample string 1",
      "termId": 2
    },
    {
      "name": "sample string 1",
      "termId": 2
    }
  ],
  "contraindications": [
    {
      "name": "sample string 1",
      "termId": 2
    },
    {
      "name": "sample string 1",
      "termId": 2
    }
  ],
  "adverseReactions": [
    {
      "name": "sample string 1",
      "termId": 2
    },
    {
      "name": "sample string 1",
      "termId": 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:

<clinicalComparisonTermsResponse 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>
  <adverseReactions>
    <term>
      <name>sample string 1</name>
      <termId>2</termId>
    </term>
    <term>
      <name>sample string 1</name>
      <termId>2</termId>
    </term>
  </adverseReactions>
  <contraindications>
    <term>
      <name>sample string 1</name>
      <termId>2</termId>
    </term>
    <term>
      <name>sample string 1</name>
      <termId>2</termId>
    </term>
  </contraindications>
  <indications>
    <term>
      <name>sample string 1</name>
      <termId>2</termId>
    </term>
    <term>
      <name>sample string 1</name>
      <termId>2</termId>
    </term>
  </indications>
</clinicalComparisonTermsResponse>