GET api/v1/reports/iv-commpatibility/aliases?q={q}&cpnum={cpnum}&ivProductId={ivProductId}

Gets a list of IV Compatibility Trissel aliases for use in the IVCompatibility report

Request Information

URI Parameters

Name	Description	Type	Additional information
q	An optional search term to narrow your alias search	string	None.
cpnum	An optional cpnum to pass to return only aliases for a specific monograph	integer	None.
ivProductId	An option IV ProductId from the monograph IV Compatibility page	integer	None.

Body Parameters

None.

Response Information

Resource Description

A list of aliases

ListResponseOfIVCompatibilityAlias

Name	Type	Additional information
count	integer	None.
items	Collection of IVCompatibilityAlias	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,
      "alias": "sample string 2",
      "ivProductId": 3,
      "productName": "sample string 4"
    },
    {
      "id": 1,
      "alias": "sample string 2",
      "ivProductId": 3,
      "productName": "sample string 4"
    }
  ]
}

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>
    <alias>
      <alias>sample string 2</alias>
      <id>1</id>
      <ivProductId>3</ivProductId>
      <productName>sample string 4</productName>
    </alias>
    <alias>
      <alias>sample string 2</alias>
      <id>1</id>
      <ivProductId>3</ivProductId>
      <productName>sample string 4</productName>
    </alias>
  </items>
</listResponse>