Instead of installing the QuikFormsEngine.dll you can use the web service version instead. The web service is essentially a wrapper for the QuikFormsEngine.dll enabling you to use the software remotely without installing the actual software or requiring the .NET Framework in your production environment. This is ideal for non-.NET users (e.g. Linux, Unix, MacOS, tablet OS, etc.).
Service URL: https://websvcs.quikforms.com/quikformsenginews/v5500/quikformsengine.asmx
Service WSDL: https://websvcs.quikforms.com/quikformsenginews/v5500/quikformsengine.asmx?wsdl
Call the Execute method to generate HTML forms
Call the ExecutePDF method to generate PDF forms
Call the UploadFileAsBytes and UploadFileFromURL methods to add attachments to previously generated forms. Note: Attachments must not exceed 20 MB. See below for details on the DocSortOrder
and BeforeForm
parameters of these methods.
DocSortOrder
(int):
Method | Desription | Notes |
---|
Execute | Used to generate HTML forms | Example request:
Code Block |
---|
| <?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Header>
<AuthenticationHeader xmlns="https://websvcs.quikforms.com/quikformsenginews/">
<CustomerID></CustomerID>
<UserName></UserName>
<Password></Password>
</AuthenticationHeader>
</soap12:Header>
<soap12:Body>
<Execute xmlns="https://websvcs.quikforms.com/quikformsenginews/">
<QFESettings>
<QuikFormID>12</QuikFormID>
<HostFormOnQuik>true</HostFormOnQuik>
</QFESettings>
</Execute>
</soap12:Body>
</soap12:Envelope> |
|
ExecutePDF | Used to generate PDF forms | |
UploadFileAsBytes | Used to upload attachments as bytes | DocSortOrder (int): optional
BeforeForm (bool): If TRUE, all attachments are placed at the beginning of the package and displayed before forms when package is printed or shown in DocuSign. If FALSE, all attachments are placed at the end of the package when printed or shown in DocuSign. Call this method multiple times when adding multiple attachments. The attachments will be appended to the generated forms in the order they are uploaded.
|
UploadFileFromURL | Used to upload attachments from a URL | See above notes for UploadFileAsBytes |
UploadFileAsBytesV2 | Used to upload attachments as bytes with updated logic | DocSortOrder (int): Required. See details below
BeforeForm (bool): If TRUE, all attachments are placed at the beginning of the package and displayed before forms when package is printed or shown in DocuSign. In this case, if multiple attachments are used, they are ordered in ascending order based on DocSortOrder value.
If FALSE, all attachments are placed in the middle or at the end of the package when printed or shown in DocuSign. Each form in a package has a “position” which is the order they were generated in. An attachment is placed in the order with the DocSortOrder value after the form in that position.
EXAMPLE |
...
: Customer generates Forms 1 and 2 together in a package, and they have positions 1 and 2 respectively. If Attachment A is uploaded with BeforeForm = FALSE and DocSortOrder = 1, then the Attachment is placed after Form 1 and before Form 2. If customer wants it shown after Form 2 then the DocSortOrder value must be 2 or greater. If a customer wants more than one Attachment in the same position in a package, then they must upload every attachment with the same DocSortOrder value and they will be placed in ascending order by upload order. Attachments must not exceed 20 MB |
UploadFileFromURLV2 | Used to upload attachments from a URL with updated logic | See above notes for UploadFileAsBytesV2 |