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=jsv

HTTP + JSV

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

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

{
	practiceId: 00000000000000000000000000000000,
	payerId: 00000000000000000000000000000000,
	protocolId: 00000000000000000000000000000000
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	protocols: 
	[
		{
			practiceId: 00000000000000000000000000000000,
			protocolId: 00000000000000000000000000000000,
			procedures: 
			[
				{
					cptCode: String,
					charge: 
					{
						currency: String,
						amount: 0
					},
					arAmount: 
					{
						currency: String,
						amount: 0
					},
					payerId: 00000000000000000000000000000000,
					description: String,
					isOverridden: False
				}
			]
		}
	]
}