GET api/v1/search/ndc?q={q}
Searches for drugs based on the NDC 5, 9, or 11 digit code
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
q |
the NDC code |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
A list of matching drugs
ListResponseOfNDCSearchName | Description | Type | Additional information |
---|---|---|---|
count | integer |
None. |
|
items | Collection of NDCSearch |
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": [ { "productName": "sample string 1", "description": "sample string 2", "cpnum": 3, "productId": 4, "ndc11": "sample string 5", "offMarket": "2024-12-28T01:54:45.4232289-05:00" }, { "productName": "sample string 1", "description": "sample string 2", "cpnum": 3, "productId": 4, "ndc11": "sample string 5", "offMarket": "2024-12-28T01:54:45.4232289-05:00" } ] }
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> <ndc> <cpnum>3</cpnum> <description>sample string 2</description> <ndc11>sample string 5</ndc11> <offMarket>2024-12-28T01:54:45.4232289-05:00</offMarket> <productId>4</productId> <productName>sample string 1</productName> </ndc> <ndc> <cpnum>3</cpnum> <description>sample string 2</description> <ndc11>sample string 5</ndc11> <offMarket>2024-12-28T01:54:45.4232289-05:00</offMarket> <productId>4</productId> <productName>sample string 1</productName> </ndc> </items> </listResponse>