POST api/v1/drugidentification

Performs a search for Drug Identifications. This method is intended for progromatic use, but can be tested with development tools such as PostMan for Chrome

Request Information

URI Parameters

None.

Body Parameters

DrugIdentificationRequestModel
NameDescriptionTypeAdditional information
imprint1

string

None.

imprint2

string

None.

colorIds

Collection of integer

None.

shapeId

integer

None.

scoring

integer

None.

dosage

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "imprint1": "sample string 1",
  "imprint2": "sample string 2",
  "colorIds": [
    1,
    2
  ],
  "shapeId": 1,
  "scoring": 1,
  "dosage": 1
}

application/xml, text/xml

Sample:
<drugIdentificationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <colorIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </colorIds>
  <dosage>1</dosage>
  <imprint1>sample string 1</imprint1>
  <imprint2>sample string 2</imprint2>
  <scoring>1</scoring>
  <shapeId>1</shapeId>
</drugIdentificationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Response containing shapes

DrugIdentificationResponse
NameDescriptionTypeAdditional 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

CodeDescriptionAdditional information
200OKThe request returned without error
204No ContentThe request was successful but no results were returned
400Bad RequestA parameter was missing or invalid
404Not FoundThe 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": "2023-02-07T04:01:18.5145675-05: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": "2023-02-07T04:01:18.5145675-05: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": "2023-02-07T04:01:18.5145675-05: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": "2023-02-07T04:01:18.5145675-05: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>2023-02-07T04:01:18.5145675-05: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>2023-02-07T04:01:18.5145675-05: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>2023-02-07T04:01:18.5145675-05: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>2023-02-07T04:01:18.5145675-05: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>