| GET | /drugs/{Id} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Name | form | string | No | |
| Packages | form | PackagedDrugDto[] | No | |
| Gpi | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| DrugId | form | string | No | |
| Ndc | form | string | No | |
| Upc | form | string | No | |
| Name | form | string | No | |
| GenericName | form | string | No | |
| IsGeneric | form | bool | No | |
| Route | form | string | No | |
| DoseForm | form | string | No | |
| Packaging | form | string | No | |
| ImageId | form | string | No | |
| Gpi | form | string | No | |
| Labeler | form | LabelerDto | No | |
| ControlledSubstanceSchedule | form | ControlledSubstanceScheduleDto | No | |
| AdverseEffects | form | AdverseEffectDto[] | No | |
| EndDate | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Name | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Description | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| EffectTypes | form | string[] | No | |
| IncidenceLevel | form | string | No | |
| SeverityLevel | form | string | No | |
| Onset | form | string | No | |
| Rank | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /drugs/{Id} HTTP/1.1
Host: drugapi.alisonline.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
id: String,
name: String,
packages:
[
{
id: String,
drugId: String,
ndc: String,
upc: String,
name: String,
genericName: String,
route: String,
doseForm: String,
packaging: String,
imageId: String,
gpi: String,
labeler:
{
id: String,
name: String
},
controlledSubstanceSchedule:
{
id: String,
description: String
},
adverseEffects:
[
{
name: String,
effectTypes:
[
String
],
incidenceLevel: String,
severityLevel: String,
onset: String
}
],
endDate: "0001-01-01 00:00:00Z"
}
],
gpi: String
}