ALIS Production Drug API v8.4.0.0

<back to all web services

GetDrug

Requires Authentication
The following routes are available for this service:
GET/drugs/{Id}
GetDrug Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
DrugDto Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
PackagesformPackagedDrugDto[]No
GpiformstringNo
PackagedDrugDto Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
DrugIdformstringNo
NdcformstringNo
UpcformstringNo
NameformstringNo
GenericNameformstringNo
IsGenericformboolNo
RouteformstringNo
DoseFormformstringNo
PackagingformstringNo
ImageIdformstringNo
GpiformstringNo
LabelerformLabelerDtoNo
ControlledSubstanceScheduleformControlledSubstanceScheduleDtoNo
AdverseEffectsformAdverseEffectDto[]No
EndDateformDateTime?No
LabelerDto Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
ControlledSubstanceScheduleDto Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
DescriptionformstringNo
AdverseEffectDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
EffectTypesformstring[]No
IncidenceLevelformstringNo
SeverityLevelformstringNo
OnsetformstringNo
RankformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
}