GET api/v1/monographs/{cpnum}/ivcompatibility?ivProductId={ivProductId}&type={type}
Retrieves IV Compatibility content for the monograph
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| cpnum |
The CpNum of the monograph |
integer |
Required |
| ivProductId |
The IV Compatibility Product ID to use for the report |
integer |
Default value is 0 |
| type |
The type of monograph (General or Pediatric). |
MonographType |
Default value is General |
Body Parameters
None.
Response Information
Resource Description
A list of IV Compatibilities
IVCompatibilityResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| products | Collection of IVCompatibilityProduct |
None. |
|
| compatibilityProduct | IVCompatibilityProduct |
None. |
|
| count | integer |
None. |
|
| compatibilities | Collection of IVCompatibility |
None. |
|
| legend | Collection of IVCompatibilityLegendItem |
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
| 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:
{
"cpnum": 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"
}
],
"type": 0,
"mini": true,
"name": "sample string 4",
"lastUpdate": "2024-12-28T01:35:01.909157-05:00",
"products": [
{
"ivProductId": 1,
"productName": "sample string 2"
},
{
"ivProductId": 1,
"productName": "sample string 2"
}
],
"compatibilityProduct": {
"ivProductId": 1,
"productName": "sample string 2"
},
"count": 1,
"compatibilities": [
{
"productId": "sample string 1",
"name": "sample string 2",
"results": [
{
"type": "sample string 1",
"compatibility": "sample string 2",
"resultIds": [
1,
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"
}
]
},
{
"type": "sample string 1",
"compatibility": "sample string 2",
"resultIds": [
1,
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"
}
]
}
]
},
{
"productId": "sample string 1",
"name": "sample string 2",
"results": [
{
"type": "sample string 1",
"compatibility": "sample string 2",
"resultIds": [
1,
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"
}
]
},
{
"type": "sample string 1",
"compatibility": "sample string 2",
"resultIds": [
1,
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"
}
]
}
]
}
],
"legend": [
{
"symbol": "sample string 1",
"description": "sample string 2"
},
{
"symbol": "sample string 1",
"description": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<ivCompatibilityResponse 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>2</cpnum>
<type>General</type>
<mini>true</mini>
<name>sample string 4</name>
<lastUpdate>2024-12-28T01:35:01.909157-05:00</lastUpdate>
<products>
<product>
<ivProductId>1</ivProductId>
<productName>sample string 2</productName>
</product>
<product>
<ivProductId>1</ivProductId>
<productName>sample string 2</productName>
</product>
</products>
<compatibilityProduct>
<ivProductId>1</ivProductId>
<productName>sample string 2</productName>
</compatibilityProduct>
<count>1</count>
<compatibilities>
<ivCompatibility>
<name>sample string 2</name>
<productId>sample string 1</productId>
<results>
<ivCompatibilityResult>
<_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>
<compatibility>sample string 2</compatibility>
<resultIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:int>1</d6p1:int>
<d6p1:int>2</d6p1:int>
</resultIds>
<type>sample string 1</type>
</ivCompatibilityResult>
<ivCompatibilityResult>
<_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>
<compatibility>sample string 2</compatibility>
<resultIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:int>1</d6p1:int>
<d6p1:int>2</d6p1:int>
</resultIds>
<type>sample string 1</type>
</ivCompatibilityResult>
</results>
</ivCompatibility>
<ivCompatibility>
<name>sample string 2</name>
<productId>sample string 1</productId>
<results>
<ivCompatibilityResult>
<_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>
<compatibility>sample string 2</compatibility>
<resultIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:int>1</d6p1:int>
<d6p1:int>2</d6p1:int>
</resultIds>
<type>sample string 1</type>
</ivCompatibilityResult>
<ivCompatibilityResult>
<_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>
<compatibility>sample string 2</compatibility>
<resultIds xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:int>1</d6p1:int>
<d6p1:int>2</d6p1:int>
</resultIds>
<type>sample string 1</type>
</ivCompatibilityResult>
</results>
</ivCompatibility>
</compatibilities>
<legend>
<item>
<description>sample string 2</description>
<symbol>sample string 1</symbol>
</item>
<item>
<description>sample string 2</description>
<symbol>sample string 1</symbol>
</item>
</legend>
</ivCompatibilityResponse>