Home

RxRequest

POST api/Orders/{systemID}/RxRequest

Submit one or more prescription refill requests (up to 35).

Special Remarks

Response Codes:
            
            RejectCode:
            [NS] - Rx Not Found; [ES] - Expired Rx; [ER] - Early Refill; [NR] - No Refills

Request Information

Parameters

NameDescriptionAdditional information
systemID 
Unique ID for system

Define this parameter in the request URI.
requests 
List of prescriptions to submit for Refill:
            RxNumber - Unique identifier for a Prescription,
            DeliveryMethod - Pickup, Delivery, etc (10 char max.),
            PickupDate - (YYYYMMDD),
            PickupTime - (HHMM),
            CallBackPhone - (XXX-XXXXXXX),
            AutomaticRefillRequest - (Y/N),
            Notes - (255 char max.),
            PaymentMethodPatientID - PatientID for CardHolder (required if PaymentMethodID specified),
            PaymentMethodID - Backend Identifier for Payment Method (optional),
            PaymentType - [C] - Credit Card, [F] - FSA, [K] - Check, 
                [A] - A/R, [P] - Payroll Deduction (required if PaymentMethodID specified),
            AddressPatientID - PatientID associated with address to use for delivery (required if AddressID specified),
            AddressID - Backend Identifier for Address (optional),
            Extended Notes - (200 char max.),
            ExpediteOrder - (Y/N),
            Source - [I] - IVR, [W] - Web, [M] - Mobile, [K] - Kiosk

Define this parameter in the request body.
    

Response Codes

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

Request body formats

application/json, text/json

Sample: 
[
  {
    "RxNumber": "sample string 1",
    "DeliveryMethod": "sample string 2",
    "PickupDate": "sample string 3",
    "PickupTime": "sample string 4",
    "CallBackPhone": "sample string 5",
    "AutomaticRefillRequest": "sample string 6",
    "Notes": "sample string 7",
    "PaymentMethodPatientID": "sample string 8",
    "PaymentMethodID": "sample string 9",
    "PaymentType": "sample string 10",
    "AddressPatientID": "sample string 11",
    "AddressID": "sample string 12",
    "ExtendedNotes": "sample string 13",
    "Source": "sample string 14",
    "ExpediteOrder": "sample string 15"
  },
  {
    "RxNumber": "sample string 1",
    "DeliveryMethod": "sample string 2",
    "PickupDate": "sample string 3",
    "PickupTime": "sample string 4",
    "CallBackPhone": "sample string 5",
    "AutomaticRefillRequest": "sample string 6",
    "Notes": "sample string 7",
    "PaymentMethodPatientID": "sample string 8",
    "PaymentMethodID": "sample string 9",
    "PaymentType": "sample string 10",
    "AddressPatientID": "sample string 11",
    "AddressID": "sample string 12",
    "ExtendedNotes": "sample string 13",
    "Source": "sample string 14",
    "ExpediteOrder": "sample string 15"
  },
  {
    "RxNumber": "sample string 1",
    "DeliveryMethod": "sample string 2",
    "PickupDate": "sample string 3",
    "PickupTime": "sample string 4",
    "CallBackPhone": "sample string 5",
    "AutomaticRefillRequest": "sample string 6",
    "Notes": "sample string 7",
    "PaymentMethodPatientID": "sample string 8",
    "PaymentMethodID": "sample string 9",
    "PaymentType": "sample string 10",
    "AddressPatientID": "sample string 11",
    "AddressID": "sample string 12",
    "ExtendedNotes": "sample string 13",
    "Source": "sample string 14",
    "ExpediteOrder": "sample string 15"
  }
]

text/javascript

Sample: 
[{"RxNumber":"sample string 1","DeliveryMethod":"sample string 2","PickupDate":"sample string 3","PickupTime":"sample string 4","CallBackPhone":"sample string 5","AutomaticRefillRequest":"sample string 6","Notes":"sample string 7","PaymentMethodPatientID":"sample string 8","PaymentMethodID":"sample string 9","PaymentType":"sample string 10","AddressPatientID":"sample string 11","AddressID":"sample string 12","ExtendedNotes":"sample string 13","Source":"sample string 14","ExpediteOrder":"sample string 15"},{"RxNumber":"sample string 1","DeliveryMethod":"sample string 2","PickupDate":"sample string 3","PickupTime":"sample string 4","CallBackPhone":"sample string 5","AutomaticRefillRequest":"sample string 6","Notes":"sample string 7","PaymentMethodPatientID":"sample string 8","PaymentMethodID":"sample string 9","PaymentType":"sample string 10","AddressPatientID":"sample string 11","AddressID":"sample string 12","ExtendedNotes":"sample string 13","Source":"sample string 14","ExpediteOrder":"sample string 15"},{"RxNumber":"sample string 1","DeliveryMethod":"sample string 2","PickupDate":"sample string 3","PickupTime":"sample string 4","CallBackPhone":"sample string 5","AutomaticRefillRequest":"sample string 6","Notes":"sample string 7","PaymentMethodPatientID":"sample string 8","PaymentMethodID":"sample string 9","PaymentType":"sample string 10","AddressPatientID":"sample string 11","AddressID":"sample string 12","ExtendedNotes":"sample string 13","Source":"sample string 14","ExpediteOrder":"sample string 15"}]

application/xml, text/xml

Sample: 
<ArrayOfRxRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <RxRequest>
    <AddressID>sample string 12</AddressID>
    <AddressPatientID>sample string 11</AddressPatientID>
    <AutomaticRefillRequest>sample string 6</AutomaticRefillRequest>
    <CallBackPhone>sample string 5</CallBackPhone>
    <DeliveryMethod>sample string 2</DeliveryMethod>
    <ExpediteOrder>sample string 15</ExpediteOrder>
    <ExtendedNotes>sample string 13</ExtendedNotes>
    <Notes>sample string 7</Notes>
    <PaymentMethodID>sample string 9</PaymentMethodID>
    <PaymentMethodPatientID>sample string 8</PaymentMethodPatientID>
    <PaymentType>sample string 10</PaymentType>
    <PickupDate>sample string 3</PickupDate>
    <PickupTime>sample string 4</PickupTime>
    <RxNumber>sample string 1</RxNumber>
    <Source>sample string 14</Source>
  </RxRequest>
  <RxRequest>
    <AddressID>sample string 12</AddressID>
    <AddressPatientID>sample string 11</AddressPatientID>
    <AutomaticRefillRequest>sample string 6</AutomaticRefillRequest>
    <CallBackPhone>sample string 5</CallBackPhone>
    <DeliveryMethod>sample string 2</DeliveryMethod>
    <ExpediteOrder>sample string 15</ExpediteOrder>
    <ExtendedNotes>sample string 13</ExtendedNotes>
    <Notes>sample string 7</Notes>
    <PaymentMethodID>sample string 9</PaymentMethodID>
    <PaymentMethodPatientID>sample string 8</PaymentMethodPatientID>
    <PaymentType>sample string 10</PaymentType>
    <PickupDate>sample string 3</PickupDate>
    <PickupTime>sample string 4</PickupTime>
    <RxNumber>sample string 1</RxNumber>
    <Source>sample string 14</Source>
  </RxRequest>
  <RxRequest>
    <AddressID>sample string 12</AddressID>
    <AddressPatientID>sample string 11</AddressPatientID>
    <AutomaticRefillRequest>sample string 6</AutomaticRefillRequest>
    <CallBackPhone>sample string 5</CallBackPhone>
    <DeliveryMethod>sample string 2</DeliveryMethod>
    <ExpediteOrder>sample string 15</ExpediteOrder>
    <ExtendedNotes>sample string 13</ExtendedNotes>
    <Notes>sample string 7</Notes>
    <PaymentMethodID>sample string 9</PaymentMethodID>
    <PaymentMethodPatientID>sample string 8</PaymentMethodPatientID>
    <PaymentType>sample string 10</PaymentType>
    <PickupDate>sample string 3</PickupDate>
    <PickupTime>sample string 4</PickupTime>
    <RxNumber>sample string 1</RxNumber>
    <Source>sample string 14</Source>
  </RxRequest>
</ArrayOfRxRequest>

Response Information

List of Rx Responses

Response body formats

application/json, text/json

Sample: 
[
  {
    "RxNumber": "sample string 1",
    "Status": "sample string 2",
    "RejectCode": "sample string 3"
  },
  {
    "RxNumber": "sample string 1",
    "Status": "sample string 2",
    "RejectCode": "sample string 3"
  },
  {
    "RxNumber": "sample string 1",
    "Status": "sample string 2",
    "RejectCode": "sample string 3"
  }
]

text/javascript

Sample: 
[{"RxNumber":"sample string 1","Status":"sample string 2","RejectCode":"sample string 3"},{"RxNumber":"sample string 1","Status":"sample string 2","RejectCode":"sample string 3"},{"RxNumber":"sample string 1","Status":"sample string 2","RejectCode":"sample string 3"}]

application/xml, text/xml

Sample: 
<ArrayOfRxRequestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <RxRequestResponse>
    <RejectCode>sample string 3</RejectCode>
    <RxNumber>sample string 1</RxNumber>
    <Status>sample string 2</Status>
  </RxRequestResponse>
  <RxRequestResponse>
    <RejectCode>sample string 3</RejectCode>
    <RxNumber>sample string 1</RxNumber>
    <Status>sample string 2</Status>
  </RxRequestResponse>
  <RxRequestResponse>
    <RejectCode>sample string 3</RejectCode>
    <RxNumber>sample string 1</RxNumber>
    <Status>sample string 2</Status>
  </RxRequestResponse>
</ArrayOfRxRequestResponse>