Home

DrugQuery

GET api/Clinical/{systemID}/CompoundQuery?compoundName={compoundName}&bShowActiveOnly={bShowActiveOnly}

Retrieves list of compound drugs matching the compound name.

Request Information

Parameters

NameDescriptionAdditional information
systemID 
The SystemID of the pharmacy system.

Define this parameter in the request URI.
compoundName 
Compound name (partials allowed up to 25 characters)

Define this parameter in the request URI.
bShowActiveOnly 
True - only show active compounds, False - show active and inactive drugs (default is true)

Define this parameter in the request URI.
    

Response Codes

    
  • OK (200)
  • BadRequest (400)
  • NotFound (404)
  • InternalServerError (500)
    •     

Response Information

Response body formats

application/json, text/json

Sample: 
[
  {
    "CompoundName": "sample string 1",
    "CompoundID": "sample string 2",
    "CompoundStatus": "sample string 3",
    "CompoundType": "sample string 4",
    "CompoundQuantity": "sample string 5",
    "CompoundUnits": "sample string 6"
  },
  {
    "CompoundName": "sample string 1",
    "CompoundID": "sample string 2",
    "CompoundStatus": "sample string 3",
    "CompoundType": "sample string 4",
    "CompoundQuantity": "sample string 5",
    "CompoundUnits": "sample string 6"
  },
  {
    "CompoundName": "sample string 1",
    "CompoundID": "sample string 2",
    "CompoundStatus": "sample string 3",
    "CompoundType": "sample string 4",
    "CompoundQuantity": "sample string 5",
    "CompoundUnits": "sample string 6"
  }
]

text/javascript

Sample: 
[{"CompoundName":"sample string 1","CompoundID":"sample string 2","CompoundStatus":"sample string 3","CompoundType":"sample string 4","CompoundQuantity":"sample string 5","CompoundUnits":"sample string 6"},{"CompoundName":"sample string 1","CompoundID":"sample string 2","CompoundStatus":"sample string 3","CompoundType":"sample string 4","CompoundQuantity":"sample string 5","CompoundUnits":"sample string 6"},{"CompoundName":"sample string 1","CompoundID":"sample string 2","CompoundStatus":"sample string 3","CompoundType":"sample string 4","CompoundQuantity":"sample string 5","CompoundUnits":"sample string 6"}]

application/xml, text/xml

Sample: 
<ArrayOfCompoundDrug xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <CompoundDrug>
    <CompoundID>sample string 2</CompoundID>
    <CompoundName>sample string 1</CompoundName>
    <CompoundQuantity>sample string 5</CompoundQuantity>
    <CompoundStatus>sample string 3</CompoundStatus>
    <CompoundType>sample string 4</CompoundType>
    <CompoundUnits>sample string 6</CompoundUnits>
  </CompoundDrug>
  <CompoundDrug>
    <CompoundID>sample string 2</CompoundID>
    <CompoundName>sample string 1</CompoundName>
    <CompoundQuantity>sample string 5</CompoundQuantity>
    <CompoundStatus>sample string 3</CompoundStatus>
    <CompoundType>sample string 4</CompoundType>
    <CompoundUnits>sample string 6</CompoundUnits>
  </CompoundDrug>
  <CompoundDrug>
    <CompoundID>sample string 2</CompoundID>
    <CompoundName>sample string 1</CompoundName>
    <CompoundQuantity>sample string 5</CompoundQuantity>
    <CompoundStatus>sample string 3</CompoundStatus>
    <CompoundType>sample string 4</CompoundType>
    <CompoundUnits>sample string 6</CompoundUnits>
  </CompoundDrug>
</ArrayOfCompoundDrug>