GET api/v1/reports/adverse-reaction/report?cpnums={cpnums}&sort={sort}

Gets data for an adverse reaction report

Request Information

URI Parameters

Name	Description	Type	Additional information
cpnums	a comma separated list of cpnums	string	Required
sort	How to sort the report (Alphabetical or Frequency)"	AdverseReactionSort	Default value is Alphabetical

Body Parameters

None.

Response Information

Resource Description

Returns data for an adverse reaction report

AdverseReactionReport

Name	Type	Additional information
sortType	AdverseReactionSort	None.
items	Collection of AdverseReactionReportItem	None.
groups	Collection of AdverseReactionGroup	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:

{
  "sortType": 0,
  "items": [
    {
      "drugs": [
        {
          "name": "sample string 1",
          "cpnum": 2
        },
        {
          "name": "sample string 1",
          "cpnum": 2
        }
      ],
      "gsTermId": 1,
      "name": "sample string 2"
    },
    {
      "drugs": [
        {
          "name": "sample string 1",
          "cpnum": 2
        },
        {
          "name": "sample string 1",
          "cpnum": 2
        }
      ],
      "gsTermId": 1,
      "name": "sample string 2"
    }
  ],
  "groups": [
    {
      "drugCount": 1,
      "count": 2,
      "items": [
        {
          "drugs": [
            {
              "name": "sample string 1",
              "cpnum": 2
            },
            {
              "name": "sample string 1",
              "cpnum": 2
            }
          ],
          "gsTermId": 1,
          "name": "sample string 2"
        },
        {
          "drugs": [
            {
              "name": "sample string 1",
              "cpnum": 2
            },
            {
              "name": "sample string 1",
              "cpnum": 2
            }
          ],
          "gsTermId": 1,
          "name": "sample string 2"
        }
      ]
    },
    {
      "drugCount": 1,
      "count": 2,
      "items": [
        {
          "drugs": [
            {
              "name": "sample string 1",
              "cpnum": 2
            },
            {
              "name": "sample string 1",
              "cpnum": 2
            }
          ],
          "gsTermId": 1,
          "name": "sample string 2"
        },
        {
          "drugs": [
            {
              "name": "sample string 1",
              "cpnum": 2
            },
            {
              "name": "sample string 1",
              "cpnum": 2
            }
          ],
          "gsTermId": 1,
          "name": "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:

<adverseReactionReport 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>
  <groups>
    <group>
      <count>2</count>
      <drugCount>1</drugCount>
      <items>
        <item>
          <drugs>
            <drug>
              <cpnum>2</cpnum>
              <name>sample string 1</name>
            </drug>
            <drug>
              <cpnum>2</cpnum>
              <name>sample string 1</name>
            </drug>
          </drugs>
          <gsTermId>1</gsTermId>
          <name>sample string 2</name>
        </item>
        <item>
          <drugs>
            <drug>
              <cpnum>2</cpnum>
              <name>sample string 1</name>
            </drug>
            <drug>
              <cpnum>2</cpnum>
              <name>sample string 1</name>
            </drug>
          </drugs>
          <gsTermId>1</gsTermId>
          <name>sample string 2</name>
        </item>
      </items>
    </group>
    <group>
      <count>2</count>
      <drugCount>1</drugCount>
      <items>
        <item>
          <drugs>
            <drug>
              <cpnum>2</cpnum>
              <name>sample string 1</name>
            </drug>
            <drug>
              <cpnum>2</cpnum>
              <name>sample string 1</name>
            </drug>
          </drugs>
          <gsTermId>1</gsTermId>
          <name>sample string 2</name>
        </item>
        <item>
          <drugs>
            <drug>
              <cpnum>2</cpnum>
              <name>sample string 1</name>
            </drug>
            <drug>
              <cpnum>2</cpnum>
              <name>sample string 1</name>
            </drug>
          </drugs>
          <gsTermId>1</gsTermId>
          <name>sample string 2</name>
        </item>
      </items>
    </group>
  </groups>
  <items>
    <item>
      <drugs>
        <drug>
          <cpnum>2</cpnum>
          <name>sample string 1</name>
        </drug>
        <drug>
          <cpnum>2</cpnum>
          <name>sample string 1</name>
        </drug>
      </drugs>
      <gsTermId>1</gsTermId>
      <name>sample string 2</name>
    </item>
    <item>
      <drugs>
        <drug>
          <cpnum>2</cpnum>
          <name>sample string 1</name>
        </drug>
        <drug>
          <cpnum>2</cpnum>
          <name>sample string 1</name>
        </drug>
      </drugs>
      <gsTermId>1</gsTermId>
      <name>sample string 2</name>
    </item>
  </items>
  <sortType>Alphabetical</sortType>
</adverseReactionReport>