GET api/v1/drugidentification?imprint1={imprint1}&imprint2={imprint2}&colorIds={colorIds}&shapeId={shapeId}&scoring={scoring}&dosage={dosage}&size={size}&page={page}
Performs a search for Drug Identifications. This method is meant for human/browser interactive testing. For application code, please use the POST method of the same end point
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| imprint1 |
Specify a value to search for side 1 imprint |
string |
None. |
| imprint2 |
Specify a value to search for side 2 imprint |
string |
None. |
| colorIds |
Specify one or more color ids to match |
string |
None. |
| shapeId |
Specify the id of a shape to match |
integer |
None. |
| scoring |
Specify a scoring value to match (0 = All, 1 = Scored, 2 = Unscored |
integer |
None. |
| dosage |
Specify a dosage form to match (0 = All, 1 = Tablets, 2 = Capsules, 3 = Both Tablets and Capsules) |
integer |
None. |
| size | integer |
Default value is 50 |
|
| page | integer |
Default value is 0 |
Body Parameters
None.
Response Information
Resource Description
Response containing matching Drug Identifications
DrugIdentificationResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| drugs | Collection of DrugIdentificationModel |
None. |
|
| count | integer |
None. |
|
| totalItems | integer |
None. |
|
| page | integer |
None. |
|
| pageSize | integer |
None. |
|
| items | Collection of DrugIdentificationModel |
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,
"totalItems": 2,
"page": 3,
"pageSize": 4,
"drugs": [
{
"cpnum": 1,
"gpcId": 1,
"name": "sample string 1",
"productId": 2,
"product": "sample string 3",
"manufacturer": "sample string 4",
"offMarketDate": "2024-09-19T03:52:18.497969-04:00",
"description": "sample string 5",
"itemPhotos": null,
"packagePhotos": null,
"scoring": "sample string 6",
"colors": null,
"shape": "sample string 7",
"dosage": "sample string 8",
"ingredients": null,
"hasMedCounselor": true,
"_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"
}
]
},
{
"cpnum": 1,
"gpcId": 1,
"name": "sample string 1",
"productId": 2,
"product": "sample string 3",
"manufacturer": "sample string 4",
"offMarketDate": "2024-09-19T03:52:18.497969-04:00",
"description": "sample string 5",
"itemPhotos": null,
"packagePhotos": null,
"scoring": "sample string 6",
"colors": null,
"shape": "sample string 7",
"dosage": "sample string 8",
"ingredients": null,
"hasMedCounselor": true,
"_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"
}
]
}
],
"items": [
{
"cpnum": 1,
"gpcId": 1,
"name": "sample string 1",
"productId": 2,
"product": "sample string 3",
"manufacturer": "sample string 4",
"offMarketDate": "2024-09-19T03:52:18.497969-04:00",
"description": "sample string 5",
"itemPhotos": null,
"packagePhotos": null,
"scoring": "sample string 6",
"colors": null,
"shape": "sample string 7",
"dosage": "sample string 8",
"ingredients": null,
"hasMedCounselor": true,
"_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"
}
]
},
{
"cpnum": 1,
"gpcId": 1,
"name": "sample string 1",
"productId": 2,
"product": "sample string 3",
"manufacturer": "sample string 4",
"offMarketDate": "2024-09-19T03:52:18.497969-04:00",
"description": "sample string 5",
"itemPhotos": null,
"packagePhotos": null,
"scoring": "sample string 6",
"colors": null,
"shape": "sample string 7",
"dosage": "sample string 8",
"ingredients": null,
"hasMedCounselor": true,
"_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:
<drugidentificationResponse 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>
<totalItems>2</totalItems>
<page>3</page>
<pageSize>4</pageSize>
<items>
<drugIdentification>
<_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>
<colors i:nil="true" />
<cpnum>1</cpnum>
<description>sample string 5</description>
<dosage>sample string 8</dosage>
<gpcId>1</gpcId>
<hasMedCounselor>true</hasMedCounselor>
<ingredients i:nil="true" />
<itemPhotos i:nil="true" />
<manufacturer>sample string 4</manufacturer>
<name>sample string 1</name>
<offMarketDate>2024-09-19T03:52:18.497969-04:00</offMarketDate>
<packagePhotos i:nil="true" />
<product>sample string 3</product>
<productId>2</productId>
<scoring>sample string 6</scoring>
<shape>sample string 7</shape>
</drugIdentification>
<drugIdentification>
<_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>
<colors i:nil="true" />
<cpnum>1</cpnum>
<description>sample string 5</description>
<dosage>sample string 8</dosage>
<gpcId>1</gpcId>
<hasMedCounselor>true</hasMedCounselor>
<ingredients i:nil="true" />
<itemPhotos i:nil="true" />
<manufacturer>sample string 4</manufacturer>
<name>sample string 1</name>
<offMarketDate>2024-09-19T03:52:18.497969-04:00</offMarketDate>
<packagePhotos i:nil="true" />
<product>sample string 3</product>
<productId>2</productId>
<scoring>sample string 6</scoring>
<shape>sample string 7</shape>
</drugIdentification>
</items>
<drugs>
<drugIdentification>
<_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>
<colors i:nil="true" />
<cpnum>1</cpnum>
<description>sample string 5</description>
<dosage>sample string 8</dosage>
<gpcId>1</gpcId>
<hasMedCounselor>true</hasMedCounselor>
<ingredients i:nil="true" />
<itemPhotos i:nil="true" />
<manufacturer>sample string 4</manufacturer>
<name>sample string 1</name>
<offMarketDate>2024-09-19T03:52:18.497969-04:00</offMarketDate>
<packagePhotos i:nil="true" />
<product>sample string 3</product>
<productId>2</productId>
<scoring>sample string 6</scoring>
<shape>sample string 7</shape>
</drugIdentification>
<drugIdentification>
<_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>
<colors i:nil="true" />
<cpnum>1</cpnum>
<description>sample string 5</description>
<dosage>sample string 8</dosage>
<gpcId>1</gpcId>
<hasMedCounselor>true</hasMedCounselor>
<ingredients i:nil="true" />
<itemPhotos i:nil="true" />
<manufacturer>sample string 4</manufacturer>
<name>sample string 1</name>
<offMarketDate>2024-09-19T03:52:18.497969-04:00</offMarketDate>
<packagePhotos i:nil="true" />
<product>sample string 3</product>
<productId>2</productId>
<scoring>sample string 6</scoring>
<shape>sample string 7</shape>
</drugIdentification>
</drugs>
</drugidentificationResponse>