PV API Service

<back to all web services

ESignDocumentCreateAndStoreRequest

POST a new ESign Document Creation request for a Practice or Clinic given a particular DocumentTemplatePK and its Root Storage ID and the passed DocumentSettings. The API will construct an actual instance of the PDF and store into into temporary DocStorage. It will then return a FileToken ID that will allow its download and transfer into permanent storage after patient merge operations.

The following routes are available for this service:
POST, OPTIONS/ESignAPI/ESignDocument/{Practice}/{ClinicPk}/{DocumentTemplatePk}/{StorageRootId}
POST, OPTIONS/ESignAPI/ESignDocument/{Practice}/{ClinicPk}/{DocumentTemplatePk}/{StorageRootId}/{IsPracticeDocumentTemplate}

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/ESignDocumentCreateAndStoreRequest HTTP/1.1 
Host: api.practicevelocity.com 
Content-Type: text/jsv
Content-Length: length

{
	practice: String,
	clinicPk: 00000000000000000000000000000000,
	documentTemplatePk: 00000000000000000000000000000000,
	storageRootId: 0,
	isPracticeDocumentTemplate: False,
	documentInserts: 
	[
		{
			key: String,
			value: String
		}
	]
}

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

{
	fileToken: 00000000000000000000000000000000,
	fileSize: 0,
	numberOfPages: 0
}