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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DrugDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Boca.DrugApi.ServiceModel.Types">
  <Gpi>String</Gpi>
  <Id>String</Id>
  <Name>String</Name>
  <Packages>
    <PackagedDrugDto>
      <AdverseEffects>
        <AdverseEffectDto>
          <EffectTypes xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </EffectTypes>
          <IncidenceLevel>String</IncidenceLevel>
          <Name>String</Name>
          <Onset>String</Onset>
          <Rank>0</Rank>
          <SeverityLevel>String</SeverityLevel>
        </AdverseEffectDto>
      </AdverseEffects>
      <ControlledSubstanceSchedule>
        <Description>String</Description>
        <Id>String</Id>
      </ControlledSubstanceSchedule>
      <DoseForm>String</DoseForm>
      <DrugId>String</DrugId>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <GenericName>String</GenericName>
      <Gpi>String</Gpi>
      <Id>String</Id>
      <ImageId>String</ImageId>
      <IsGeneric>false</IsGeneric>
      <Labeler>
        <Id>String</Id>
        <Name>String</Name>
      </Labeler>
      <Name>String</Name>
      <Ndc>String</Ndc>
      <Packaging>String</Packaging>
      <Route>String</Route>
      <Upc>String</Upc>
    </PackagedDrugDto>
  </Packages>
</DrugDto>