Home

Pharmacy

GET api/Pharmacy/{systemID}/PricePlans?Description={Description}&BIN={BIN}&PCN={PCN}

[Price Plan Query] Retrieves price plans from the QS/1 pharmacy system (Insurance). *At least one filter/parameter must be specified.*

Request Information

Parameters

NameDescriptionAdditional information
systemID 
The SystemID of the pharmacy system.

Define this parameter in the request URI.
Description 
Insurance Provider Name (optional - partials allowed)

Define this parameter in the request URI.
BIN 
Insurance Bank Identification Number (optional)

Define this parameter in the request URI.
PCN 
Insurance Processor Control Number (optional - can only be used in conjunction with description or BIN)

Define this parameter in the request URI.
    

Response Codes

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

Response Information

List of Price Plans

Response body formats

application/json, text/json

Sample: 
[
  {
    "PlanID": "sample string 1",
    "Description": "sample string 2",
    "PlanBIN": "sample string 3",
    "PlanPCN": "sample string 4"
  },
  {
    "PlanID": "sample string 1",
    "Description": "sample string 2",
    "PlanBIN": "sample string 3",
    "PlanPCN": "sample string 4"
  },
  {
    "PlanID": "sample string 1",
    "Description": "sample string 2",
    "PlanBIN": "sample string 3",
    "PlanPCN": "sample string 4"
  }
]

text/javascript

Sample: 
[{"PlanID":"sample string 1","Description":"sample string 2","PlanBIN":"sample string 3","PlanPCN":"sample string 4"},{"PlanID":"sample string 1","Description":"sample string 2","PlanBIN":"sample string 3","PlanPCN":"sample string 4"},{"PlanID":"sample string 1","Description":"sample string 2","PlanBIN":"sample string 3","PlanPCN":"sample string 4"}]

application/xml, text/xml

Sample: 
<ArrayOfPricePlan xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <PricePlan>
    <Description>sample string 2</Description>
    <PlanBIN>sample string 3</PlanBIN>
    <PlanID>sample string 1</PlanID>
    <PlanPCN>sample string 4</PlanPCN>
  </PricePlan>
  <PricePlan>
    <Description>sample string 2</Description>
    <PlanBIN>sample string 3</PlanBIN>
    <PlanID>sample string 1</PlanID>
    <PlanPCN>sample string 4</PlanPCN>
  </PricePlan>
  <PricePlan>
    <Description>sample string 2</Description>
    <PlanBIN>sample string 3</PlanBIN>
    <PlanID>sample string 1</PlanID>
    <PlanPCN>sample string 4</PlanPCN>
  </PricePlan>
</ArrayOfPricePlan>