ECS
GET api/ECS/{systemID}/ECSQuery?rxNumber={rxNumber}&sequenceNumber={sequenceNumber}
Gets ECS Data for a specified prescription number/transaction sequence number combination
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| systemID | Unique ID for system |
Define this parameter in the request URI. |
| rxNumber | Rx Number to get ECS Data for |
Define this parameter in the request URI. |
| sequenceNumber | Transaction Sequence number to get ECS Data for |
Define this parameter in the request URI. |
Response Information
ECS Data
Response body formats
application/json, text/json
Sample:
{
"ExceededMaxResults": true,
"ECSResultCount": 3,
"ECSItems": [
{
"PatientCode": "sample string 1",
"PriceCode": "sample string 2",
"MTDKeyValue": "sample string 3",
"StoreNumber": "sample string 4",
"InternalMessage": "sample string 5",
"Delete": true,
"Hold": true,
"SecondaryClaim": true,
"LabelPrinted": true,
"Rebill": true,
"Reversal": true,
"Paid": true,
"Reject": true,
"Captured": true,
"DuplicatePaid": true,
"Eligible": true,
"ReversalAccepted": true,
"OriginalRejected": true,
"Failed": true,
"RefillRequest": true,
"NewRx": true,
"RefillResponse": true,
"NoMoreMessages": true,
"Note": true,
"PaidLTAcquisitionCost": true,
"DataCollection": true,
"PriorAuth": true,
"DuplicateApproved": true,
"DuplicateCaptured": true,
"PriorAuthDeferred": true,
"Tertiary": true,
"PriorAuthViewed": true,
"PriorAuthTypeInquery": true,
"PriorAuthTypeReversal": true,
"PatientEligibilityE1": true,
"PatientEligibilityAvailible": true,
"PatientEligibilityViewed": true,
"ERxRefill": true,
"EStatus": true,
"ECanRX": true,
"EVerify": true,
"PaidAtUC": true,
"NegativeReimbursement": true,
"ZeroAmmount": true,
"MTDPrimaryRejectCodes": "sample string 45",
"MTDSecondaryRejectCodes": "sample string 46",
"MTDTertiaryRejectCodes": "sample string 47",
"SignatureDate": "sample string 48",
"SignatureTime": "sample string 49",
"RxLogSignature": true,
"NursingHomeSignature": true
},
{
"PatientCode": "sample string 1",
"PriceCode": "sample string 2",
"MTDKeyValue": "sample string 3",
"StoreNumber": "sample string 4",
"InternalMessage": "sample string 5",
"Delete": true,
"Hold": true,
"SecondaryClaim": true,
"LabelPrinted": true,
"Rebill": true,
"Reversal": true,
"Paid": true,
"Reject": true,
"Captured": true,
"DuplicatePaid": true,
"Eligible": true,
"ReversalAccepted": true,
"OriginalRejected": true,
"Failed": true,
"RefillRequest": true,
"NewRx": true,
"RefillResponse": true,
"NoMoreMessages": true,
"Note": true,
"PaidLTAcquisitionCost": true,
"DataCollection": true,
"PriorAuth": true,
"DuplicateApproved": true,
"DuplicateCaptured": true,
"PriorAuthDeferred": true,
"Tertiary": true,
"PriorAuthViewed": true,
"PriorAuthTypeInquery": true,
"PriorAuthTypeReversal": true,
"PatientEligibilityE1": true,
"PatientEligibilityAvailible": true,
"PatientEligibilityViewed": true,
"ERxRefill": true,
"EStatus": true,
"ECanRX": true,
"EVerify": true,
"PaidAtUC": true,
"NegativeReimbursement": true,
"ZeroAmmount": true,
"MTDPrimaryRejectCodes": "sample string 45",
"MTDSecondaryRejectCodes": "sample string 46",
"MTDTertiaryRejectCodes": "sample string 47",
"SignatureDate": "sample string 48",
"SignatureTime": "sample string 49",
"RxLogSignature": true,
"NursingHomeSignature": true
},
{
"PatientCode": "sample string 1",
"PriceCode": "sample string 2",
"MTDKeyValue": "sample string 3",
"StoreNumber": "sample string 4",
"InternalMessage": "sample string 5",
"Delete": true,
"Hold": true,
"SecondaryClaim": true,
"LabelPrinted": true,
"Rebill": true,
"Reversal": true,
"Paid": true,
"Reject": true,
"Captured": true,
"DuplicatePaid": true,
"Eligible": true,
"ReversalAccepted": true,
"OriginalRejected": true,
"Failed": true,
"RefillRequest": true,
"NewRx": true,
"RefillResponse": true,
"NoMoreMessages": true,
"Note": true,
"PaidLTAcquisitionCost": true,
"DataCollection": true,
"PriorAuth": true,
"DuplicateApproved": true,
"DuplicateCaptured": true,
"PriorAuthDeferred": true,
"Tertiary": true,
"PriorAuthViewed": true,
"PriorAuthTypeInquery": true,
"PriorAuthTypeReversal": true,
"PatientEligibilityE1": true,
"PatientEligibilityAvailible": true,
"PatientEligibilityViewed": true,
"ERxRefill": true,
"EStatus": true,
"ECanRX": true,
"EVerify": true,
"PaidAtUC": true,
"NegativeReimbursement": true,
"ZeroAmmount": true,
"MTDPrimaryRejectCodes": "sample string 45",
"MTDSecondaryRejectCodes": "sample string 46",
"MTDTertiaryRejectCodes": "sample string 47",
"SignatureDate": "sample string 48",
"SignatureTime": "sample string 49",
"RxLogSignature": true,
"NursingHomeSignature": true
}
]
}
text/javascript
Sample:
{"ExceededMaxResults":true,"ECSResultCount":3,"ECSItems":[{"PatientCode":"sample string 1","PriceCode":"sample string 2","MTDKeyValue":"sample string 3","StoreNumber":"sample string 4","InternalMessage":"sample string 5","Delete":true,"Hold":true,"SecondaryClaim":true,"LabelPrinted":true,"Rebill":true,"Reversal":true,"Paid":true,"Reject":true,"Captured":true,"DuplicatePaid":true,"Eligible":true,"ReversalAccepted":true,"OriginalRejected":true,"Failed":true,"RefillRequest":true,"NewRx":true,"RefillResponse":true,"NoMoreMessages":true,"Note":true,"PaidLTAcquisitionCost":true,"DataCollection":true,"PriorAuth":true,"DuplicateApproved":true,"DuplicateCaptured":true,"PriorAuthDeferred":true,"Tertiary":true,"PriorAuthViewed":true,"PriorAuthTypeInquery":true,"PriorAuthTypeReversal":true,"PatientEligibilityE1":true,"PatientEligibilityAvailible":true,"PatientEligibilityViewed":true,"ERxRefill":true,"EStatus":true,"ECanRX":true,"EVerify":true,"PaidAtUC":true,"NegativeReimbursement":true,"ZeroAmmount":true,"MTDPrimaryRejectCodes":"sample string 45","MTDSecondaryRejectCodes":"sample string 46","MTDTertiaryRejectCodes":"sample string 47","SignatureDate":"sample string 48","SignatureTime":"sample string 49","RxLogSignature":true,"NursingHomeSignature":true},{"PatientCode":"sample string 1","PriceCode":"sample string 2","MTDKeyValue":"sample string 3","StoreNumber":"sample string 4","InternalMessage":"sample string 5","Delete":true,"Hold":true,"SecondaryClaim":true,"LabelPrinted":true,"Rebill":true,"Reversal":true,"Paid":true,"Reject":true,"Captured":true,"DuplicatePaid":true,"Eligible":true,"ReversalAccepted":true,"OriginalRejected":true,"Failed":true,"RefillRequest":true,"NewRx":true,"RefillResponse":true,"NoMoreMessages":true,"Note":true,"PaidLTAcquisitionCost":true,"DataCollection":true,"PriorAuth":true,"DuplicateApproved":true,"DuplicateCaptured":true,"PriorAuthDeferred":true,"Tertiary":true,"PriorAuthViewed":true,"PriorAuthTypeInquery":true,"PriorAuthTypeReversal":true,"PatientEligibilityE1":true,"PatientEligibilityAvailible":true,"PatientEligibilityViewed":true,"ERxRefill":true,"EStatus":true,"ECanRX":true,"EVerify":true,"PaidAtUC":true,"NegativeReimbursement":true,"ZeroAmmount":true,"MTDPrimaryRejectCodes":"sample string 45","MTDSecondaryRejectCodes":"sample string 46","MTDTertiaryRejectCodes":"sample string 47","SignatureDate":"sample string 48","SignatureTime":"sample string 49","RxLogSignature":true,"NursingHomeSignature":true},{"PatientCode":"sample string 1","PriceCode":"sample string 2","MTDKeyValue":"sample string 3","StoreNumber":"sample string 4","InternalMessage":"sample string 5","Delete":true,"Hold":true,"SecondaryClaim":true,"LabelPrinted":true,"Rebill":true,"Reversal":true,"Paid":true,"Reject":true,"Captured":true,"DuplicatePaid":true,"Eligible":true,"ReversalAccepted":true,"OriginalRejected":true,"Failed":true,"RefillRequest":true,"NewRx":true,"RefillResponse":true,"NoMoreMessages":true,"Note":true,"PaidLTAcquisitionCost":true,"DataCollection":true,"PriorAuth":true,"DuplicateApproved":true,"DuplicateCaptured":true,"PriorAuthDeferred":true,"Tertiary":true,"PriorAuthViewed":true,"PriorAuthTypeInquery":true,"PriorAuthTypeReversal":true,"PatientEligibilityE1":true,"PatientEligibilityAvailible":true,"PatientEligibilityViewed":true,"ERxRefill":true,"EStatus":true,"ECanRX":true,"EVerify":true,"PaidAtUC":true,"NegativeReimbursement":true,"ZeroAmmount":true,"MTDPrimaryRejectCodes":"sample string 45","MTDSecondaryRejectCodes":"sample string 46","MTDTertiaryRejectCodes":"sample string 47","SignatureDate":"sample string 48","SignatureTime":"sample string 49","RxLogSignature":true,"NursingHomeSignature":true}]}
application/xml, text/xml
Sample:
<ECSResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QCFWebAPI.Models">
<ECSItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/QCFLibrary.Common.Data">
<d2p1:ECSInformation>
<d2p1:Captured>true</d2p1:Captured>
<d2p1:DataCollection>true</d2p1:DataCollection>
<d2p1:Delete>true</d2p1:Delete>
<d2p1:DuplicateApproved>true</d2p1:DuplicateApproved>
<d2p1:DuplicateCaptured>true</d2p1:DuplicateCaptured>
<d2p1:DuplicatePaid>true</d2p1:DuplicatePaid>
<d2p1:ECanRX>true</d2p1:ECanRX>
<d2p1:ERxRefill>true</d2p1:ERxRefill>
<d2p1:EStatus>true</d2p1:EStatus>
<d2p1:EVerify>true</d2p1:EVerify>
<d2p1:Eligible>true</d2p1:Eligible>
<d2p1:Failed>true</d2p1:Failed>
<d2p1:Hold>true</d2p1:Hold>
<d2p1:InternalMessage>sample string 5</d2p1:InternalMessage>
<d2p1:LabelPrinted>true</d2p1:LabelPrinted>
<d2p1:MTDKeyValue>sample string 3</d2p1:MTDKeyValue>
<d2p1:MTDPrimaryRejectCodes>sample string 45</d2p1:MTDPrimaryRejectCodes>
<d2p1:MTDSecondaryRejectCodes>sample string 46</d2p1:MTDSecondaryRejectCodes>
<d2p1:MTDTertiaryRejectCodes>sample string 47</d2p1:MTDTertiaryRejectCodes>
<d2p1:NegativeReimbursement>true</d2p1:NegativeReimbursement>
<d2p1:NewRx>true</d2p1:NewRx>
<d2p1:NoMoreMessages>true</d2p1:NoMoreMessages>
<d2p1:Note>true</d2p1:Note>
<d2p1:NursingHomeSignature>true</d2p1:NursingHomeSignature>
<d2p1:OriginalRejected>true</d2p1:OriginalRejected>
<d2p1:Paid>true</d2p1:Paid>
<d2p1:PaidAtUC>true</d2p1:PaidAtUC>
<d2p1:PaidLTAcquisitionCost>true</d2p1:PaidLTAcquisitionCost>
<d2p1:PatientCode>sample string 1</d2p1:PatientCode>
<d2p1:PatientEligibilityAvailible>true</d2p1:PatientEligibilityAvailible>
<d2p1:PatientEligibilityE1>true</d2p1:PatientEligibilityE1>
<d2p1:PatientEligibilityViewed>true</d2p1:PatientEligibilityViewed>
<d2p1:PriceCode>sample string 2</d2p1:PriceCode>
<d2p1:PriorAuth>true</d2p1:PriorAuth>
<d2p1:PriorAuthDeferred>true</d2p1:PriorAuthDeferred>
<d2p1:PriorAuthTypeInquery>true</d2p1:PriorAuthTypeInquery>
<d2p1:PriorAuthTypeReversal>true</d2p1:PriorAuthTypeReversal>
<d2p1:PriorAuthViewed>true</d2p1:PriorAuthViewed>
<d2p1:Rebill>true</d2p1:Rebill>
<d2p1:RefillRequest>true</d2p1:RefillRequest>
<d2p1:RefillResponse>true</d2p1:RefillResponse>
<d2p1:Reject>true</d2p1:Reject>
<d2p1:Reversal>true</d2p1:Reversal>
<d2p1:ReversalAccepted>true</d2p1:ReversalAccepted>
<d2p1:RxLogSignature>true</d2p1:RxLogSignature>
<d2p1:SecondaryClaim>true</d2p1:SecondaryClaim>
<d2p1:SignatureDate>sample string 48</d2p1:SignatureDate>
<d2p1:SignatureTime>sample string 49</d2p1:SignatureTime>
<d2p1:StoreNumber>sample string 4</d2p1:StoreNumber>
<d2p1:Tertiary>true</d2p1:Tertiary>
<d2p1:ZeroAmmount>true</d2p1:ZeroAmmount>
</d2p1:ECSInformation>
<d2p1:ECSInformation>
<d2p1:Captured>true</d2p1:Captured>
<d2p1:DataCollection>true</d2p1:DataCollection>
<d2p1:Delete>true</d2p1:Delete>
<d2p1:DuplicateApproved>true</d2p1:DuplicateApproved>
<d2p1:DuplicateCaptured>true</d2p1:DuplicateCaptured>
<d2p1:DuplicatePaid>true</d2p1:DuplicatePaid>
<d2p1:ECanRX>true</d2p1:ECanRX>
<d2p1:ERxRefill>true</d2p1:ERxRefill>
<d2p1:EStatus>true</d2p1:EStatus>
<d2p1:EVerify>true</d2p1:EVerify>
<d2p1:Eligible>true</d2p1:Eligible>
<d2p1:Failed>true</d2p1:Failed>
<d2p1:Hold>true</d2p1:Hold>
<d2p1:InternalMessage>sample string 5</d2p1:InternalMessage>
<d2p1:LabelPrinted>true</d2p1:LabelPrinted>
<d2p1:MTDKeyValue>sample string 3</d2p1:MTDKeyValue>
<d2p1:MTDPrimaryRejectCodes>sample string 45</d2p1:MTDPrimaryRejectCodes>
<d2p1:MTDSecondaryRejectCodes>sample string 46</d2p1:MTDSecondaryRejectCodes>
<d2p1:MTDTertiaryRejectCodes>sample string 47</d2p1:MTDTertiaryRejectCodes>
<d2p1:NegativeReimbursement>true</d2p1:NegativeReimbursement>
<d2p1:NewRx>true</d2p1:NewRx>
<d2p1:NoMoreMessages>true</d2p1:NoMoreMessages>
<d2p1:Note>true</d2p1:Note>
<d2p1:NursingHomeSignature>true</d2p1:NursingHomeSignature>
<d2p1:OriginalRejected>true</d2p1:OriginalRejected>
<d2p1:Paid>true</d2p1:Paid>
<d2p1:PaidAtUC>true</d2p1:PaidAtUC>
<d2p1:PaidLTAcquisitionCost>true</d2p1:PaidLTAcquisitionCost>
<d2p1:PatientCode>sample string 1</d2p1:PatientCode>
<d2p1:PatientEligibilityAvailible>true</d2p1:PatientEligibilityAvailible>
<d2p1:PatientEligibilityE1>true</d2p1:PatientEligibilityE1>
<d2p1:PatientEligibilityViewed>true</d2p1:PatientEligibilityViewed>
<d2p1:PriceCode>sample string 2</d2p1:PriceCode>
<d2p1:PriorAuth>true</d2p1:PriorAuth>
<d2p1:PriorAuthDeferred>true</d2p1:PriorAuthDeferred>
<d2p1:PriorAuthTypeInquery>true</d2p1:PriorAuthTypeInquery>
<d2p1:PriorAuthTypeReversal>true</d2p1:PriorAuthTypeReversal>
<d2p1:PriorAuthViewed>true</d2p1:PriorAuthViewed>
<d2p1:Rebill>true</d2p1:Rebill>
<d2p1:RefillRequest>true</d2p1:RefillRequest>
<d2p1:RefillResponse>true</d2p1:RefillResponse>
<d2p1:Reject>true</d2p1:Reject>
<d2p1:Reversal>true</d2p1:Reversal>
<d2p1:ReversalAccepted>true</d2p1:ReversalAccepted>
<d2p1:RxLogSignature>true</d2p1:RxLogSignature>
<d2p1:SecondaryClaim>true</d2p1:SecondaryClaim>
<d2p1:SignatureDate>sample string 48</d2p1:SignatureDate>
<d2p1:SignatureTime>sample string 49</d2p1:SignatureTime>
<d2p1:StoreNumber>sample string 4</d2p1:StoreNumber>
<d2p1:Tertiary>true</d2p1:Tertiary>
<d2p1:ZeroAmmount>true</d2p1:ZeroAmmount>
</d2p1:ECSInformation>
<d2p1:ECSInformation>
<d2p1:Captured>true</d2p1:Captured>
<d2p1:DataCollection>true</d2p1:DataCollection>
<d2p1:Delete>true</d2p1:Delete>
<d2p1:DuplicateApproved>true</d2p1:DuplicateApproved>
<d2p1:DuplicateCaptured>true</d2p1:DuplicateCaptured>
<d2p1:DuplicatePaid>true</d2p1:DuplicatePaid>
<d2p1:ECanRX>true</d2p1:ECanRX>
<d2p1:ERxRefill>true</d2p1:ERxRefill>
<d2p1:EStatus>true</d2p1:EStatus>
<d2p1:EVerify>true</d2p1:EVerify>
<d2p1:Eligible>true</d2p1:Eligible>
<d2p1:Failed>true</d2p1:Failed>
<d2p1:Hold>true</d2p1:Hold>
<d2p1:InternalMessage>sample string 5</d2p1:InternalMessage>
<d2p1:LabelPrinted>true</d2p1:LabelPrinted>
<d2p1:MTDKeyValue>sample string 3</d2p1:MTDKeyValue>
<d2p1:MTDPrimaryRejectCodes>sample string 45</d2p1:MTDPrimaryRejectCodes>
<d2p1:MTDSecondaryRejectCodes>sample string 46</d2p1:MTDSecondaryRejectCodes>
<d2p1:MTDTertiaryRejectCodes>sample string 47</d2p1:MTDTertiaryRejectCodes>
<d2p1:NegativeReimbursement>true</d2p1:NegativeReimbursement>
<d2p1:NewRx>true</d2p1:NewRx>
<d2p1:NoMoreMessages>true</d2p1:NoMoreMessages>
<d2p1:Note>true</d2p1:Note>
<d2p1:NursingHomeSignature>true</d2p1:NursingHomeSignature>
<d2p1:OriginalRejected>true</d2p1:OriginalRejected>
<d2p1:Paid>true</d2p1:Paid>
<d2p1:PaidAtUC>true</d2p1:PaidAtUC>
<d2p1:PaidLTAcquisitionCost>true</d2p1:PaidLTAcquisitionCost>
<d2p1:PatientCode>sample string 1</d2p1:PatientCode>
<d2p1:PatientEligibilityAvailible>true</d2p1:PatientEligibilityAvailible>
<d2p1:PatientEligibilityE1>true</d2p1:PatientEligibilityE1>
<d2p1:PatientEligibilityViewed>true</d2p1:PatientEligibilityViewed>
<d2p1:PriceCode>sample string 2</d2p1:PriceCode>
<d2p1:PriorAuth>true</d2p1:PriorAuth>
<d2p1:PriorAuthDeferred>true</d2p1:PriorAuthDeferred>
<d2p1:PriorAuthTypeInquery>true</d2p1:PriorAuthTypeInquery>
<d2p1:PriorAuthTypeReversal>true</d2p1:PriorAuthTypeReversal>
<d2p1:PriorAuthViewed>true</d2p1:PriorAuthViewed>
<d2p1:Rebill>true</d2p1:Rebill>
<d2p1:RefillRequest>true</d2p1:RefillRequest>
<d2p1:RefillResponse>true</d2p1:RefillResponse>
<d2p1:Reject>true</d2p1:Reject>
<d2p1:Reversal>true</d2p1:Reversal>
<d2p1:ReversalAccepted>true</d2p1:ReversalAccepted>
<d2p1:RxLogSignature>true</d2p1:RxLogSignature>
<d2p1:SecondaryClaim>true</d2p1:SecondaryClaim>
<d2p1:SignatureDate>sample string 48</d2p1:SignatureDate>
<d2p1:SignatureTime>sample string 49</d2p1:SignatureTime>
<d2p1:StoreNumber>sample string 4</d2p1:StoreNumber>
<d2p1:Tertiary>true</d2p1:Tertiary>
<d2p1:ZeroAmmount>true</d2p1:ZeroAmmount>
</d2p1:ECSInformation>
</ECSItems>
<ECSResultCount>3</ECSResultCount>
<ExceededMaxResults>true</ExceededMaxResults>
</ECSResults>