GET api/v1/monographs/{cpnum}/howsupplied?type={type}
Retrieves information regarding how the drug is supplied
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
cpnum |
The CpNum of the monograph |
integer |
Required |
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
HowSuppliedResponseName | Description | Type | Additional information |
---|---|---|---|
count | integer |
None. |
|
products | Collection of ProductItem |
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-28T02:02:50.3653189-05:00", "count": 1, "products": [ { "productId": 1, "genericProductName": "sample string 2", "productName": "sample string 3", "offMarketDate": "2024-12-28T02:02:50.3653189-05:00", "manufacturer": "sample string 4", "NDC9": "sample string 5", "drugPhotos": null, "packagePhotos": null }, { "productId": 1, "genericProductName": "sample string 2", "productName": "sample string 3", "offMarketDate": "2024-12-28T02:02:50.3653189-05:00", "manufacturer": "sample string 4", "NDC9": "sample string 5", "drugPhotos": null, "packagePhotos": null } ] }
application/xml, text/xml
Sample:
<howSuppliedResponse 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-28T02:02:50.3653189-05:00</lastUpdate> <count>1</count> <products> <product> <NDC9>sample string 5</NDC9> <drugPhotos i:nil="true" /> <genericProductName>sample string 2</genericProductName> <manufacturer>sample string 4</manufacturer> <offMarketDate>2024-12-28T02:02:50.3653189-05:00</offMarketDate> <packagePhotos i:nil="true" /> <productId>1</productId> <productName>sample string 3</productName> </product> <product> <NDC9>sample string 5</NDC9> <drugPhotos i:nil="true" /> <genericProductName>sample string 2</genericProductName> <manufacturer>sample string 4</manufacturer> <offMarketDate>2024-12-28T02:02:50.3653189-05:00</offMarketDate> <packagePhotos i:nil="true" /> <productId>1</productId> <productName>sample string 3</productName> </product> </products> </howSuppliedResponse>