PV API Service

<back to all web services

ESignDocumentTemplateFindRequest

GET a new ESign Document Template Download request for a Practice or Clinic. If the Document Template is found its PK is returned along with a FileToken that will allow the download operation.

The following routes are available for this service:
GET, OPTIONS/ESignAPI/ESignDocumentTemplate/{DocumentTypeName}/{Practice}/{ClinicPk}/{Version}
GET, OPTIONS/ESignAPI/ESignDocumentTemplate/{DocumentTypeName}/{Practice}/{ClinicPk}

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/ESignDocumentTemplateFindRequest HTTP/1.1 
Host: api.practicevelocity.com 
Content-Type: application/xml
Content-Length: length

<ESignDocumentTemplateFindRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.ESign.DataModel.RequestResponse">
  <ClinicPk>00000000-0000-0000-0000-000000000000</ClinicPk>
  <DocumentTypeName>String</DocumentTypeName>
  <Practice>String</Practice>
  <Version>0</Version>
</ESignDocumentTemplateFindRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ESignDocumentTemplateFindResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.ESign.DataModel.RequestResponse">
  <DocumenTemplatePk>00000000-0000-0000-0000-000000000000</DocumenTemplatePk>
  <IsPracticeDocument>false</IsPracticeDocument>
  <StorageRootId>0</StorageRootId>
  <Version>0</Version>
</ESignDocumentTemplateFindResponse>