Home

Transaction

PUT api/Transaction/{systemID}/TransactionUpdate

Update pickup information and signature on an existing transaction.

Request Information

Parameters

NameDescriptionAdditional information
systemID 
Unique ID for system

Define this parameter in the request URI.
transaction 
TransactionUpdate object
            EmployeeID - Pharmacist System Code [*Optional]
            RxNumber - Rx Number [*Required]
            SeqNumber - Transaction sequence number [*Required]
            CustomerID - Customer ID Number [*Optional]
            IDQualifier - Customer ID Type Qualifier [*Optional]
                Valid Input:
                [01] - Military ID
                [02] - State Issued ID
                [03] - Unique System ID
                [04] - Permament Resident Card
                [05] - Passport ID
                [06] - Driver's License ID
                [07] - Social Security Number
                [99] - Other
            IDExpirationDate - Customer ID Expiration Date (YYYYMMDD) [*Optional]
            IssuringJurisdiction - Customer ID Issuing Agency [*Optional]
            RelationshipToPatient - Customer ID Relationship Qualifier [*Optional]
                Valid Input:
                [01] - Patient
                [02] - Parent/Legal Guardian
                [03] - Spouse
                [04] - Caregiver
                [99] - Other
            FirstName - Customer First Name [*Optional]
            LastName - Customer Last Name [*Optional]
            MiddleInitial - Customer Middle Initial [*Optional]
            Address - Customer Address 1 [*Optional]
            City - Customer City [*Optional]
            State - Customer State [*Optional]
            ZipCode - Customer Postal Code [*Optional]
            Checkout - Rx Checked Out At Register (Y/N) [*Optional]
            Signature - Base64 Bitmap image containing signature [*Optional]

Define this parameter in the request body.
    

Response Codes

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

Request body formats

application/json, text/json

Sample: 
{
  "EmployeeID": "sample string 1",
  "RxNumber": "sample string 2",
  "SeqNumber": "sample string 3",
  "CustomerID": "sample string 4",
  "IDQualifier": "sample string 5",
  "IDExpirationDate": "sample string 6",
  "IssuingJurisdiction": "sample string 7",
  "RelationshipToPatient": "sample string 8",
  "FirstName": "sample string 9",
  "LastName": "sample string 10",
  "MiddleInitial": "sample string 11",
  "Address": "sample string 12",
  "City": "sample string 13",
  "State": "sample string 14",
  "ZipCode": "sample string 15",
  "Checkout": "sample string 16",
  "Signature": "sample string 17"
}

text/javascript

Sample: 
{"EmployeeID":"sample string 1","RxNumber":"sample string 2","SeqNumber":"sample string 3","CustomerID":"sample string 4","IDQualifier":"sample string 5","IDExpirationDate":"sample string 6","IssuingJurisdiction":"sample string 7","RelationshipToPatient":"sample string 8","FirstName":"sample string 9","LastName":"sample string 10","MiddleInitial":"sample string 11","Address":"sample string 12","City":"sample string 13","State":"sample string 14","ZipCode":"sample string 15","Checkout":"sample string 16","Signature":"sample string 17"}

application/xml, text/xml

Sample: 
<TransactionUpdateInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
  <Address>sample string 12</Address>
  <Checkout>sample string 16</Checkout>
  <City>sample string 13</City>
  <CustomerID>sample string 4</CustomerID>
  <EmployeeID>sample string 1</EmployeeID>
  <FirstName>sample string 9</FirstName>
  <IDExpirationDate>sample string 6</IDExpirationDate>
  <IDQualifier>sample string 5</IDQualifier>
  <IssuingJurisdiction>sample string 7</IssuingJurisdiction>
  <LastName>sample string 10</LastName>
  <MiddleInitial>sample string 11</MiddleInitial>
  <RelationshipToPatient>sample string 8</RelationshipToPatient>
  <RxNumber>sample string 2</RxNumber>
  <SeqNumber>sample string 3</SeqNumber>
  <Signature>sample string 17</Signature>
  <State>sample string 14</State>
  <ZipCode>sample string 15</ZipCode>
</TransactionUpdateInformation>