PV API Service

<back to all web services

PayerProtocolRequest

GET a protocol or all protocols for a specific payer.

The following routes are available for this service:
GET, OPTIONS/AutoChargeEntry/Payer/Protocol

To override the Content-type in your clients HTTP Accept Header, append ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/PayerProtocolRequest HTTP/1.1 
Host: api.practicevelocity.com 
Content-Type: application/xml
Content-Length: length

<PayerProtocolRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.AutoChargeEntry.DataModel.Payer">
  <payerId>00000000-0000-0000-0000-000000000000</payerId>
  <practiceId>00000000-0000-0000-0000-000000000000</practiceId>
  <protocolId>00000000-0000-0000-0000-000000000000</protocolId>
</PayerProtocolRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PayerProtocolResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.AutoChargeEntry.DataModel.Payer">
  <Protocols xmlns:d2p1="http://schemas.datacontract.org/2004/07/PV.AutoChargeEntry.DataModel.POCOs">
    <d2p1:Protocol>
      <d2p1:PracticeId>00000000-0000-0000-0000-000000000000</d2p1:PracticeId>
      <d2p1:Procedures>
        <d2p1:Procedure>
          <d2p1:ArAmount>
            <d2p1:Amount>0</d2p1:Amount>
            <d2p1:Currency>String</d2p1:Currency>
          </d2p1:ArAmount>
          <d2p1:Charge>
            <d2p1:Amount>0</d2p1:Amount>
            <d2p1:Currency>String</d2p1:Currency>
          </d2p1:Charge>
          <d2p1:CptCode>String</d2p1:CptCode>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:IsOverridden>false</d2p1:IsOverridden>
          <d2p1:PayerId>00000000-0000-0000-0000-000000000000</d2p1:PayerId>
        </d2p1:Procedure>
      </d2p1:Procedures>
      <d2p1:ProtocolId>00000000-0000-0000-0000-000000000000</d2p1:ProtocolId>
    </d2p1:Protocol>
  </Protocols>
</PayerProtocolResponse>