Content Comparison

Execute HTML

/qfe/execute/html

POST

Execute the Quik! Forms Engine for HTML form output

HTMLSettings (Object with properties to be set in the QuikFormsEngine)

Sample Request:

{
   "HostFormOnQuik":true,
   "FormFields":[
      {
         "FieldName":"1own.FName",
         "FieldValue":"Joe"
      },
      {
         "FieldName":"1own.LName",
         "FieldValue":"Smith"
      }
   ],
   "QuikFormID":"12"
}

Execute PDF

/qfe/execute/pdf

POST

Execute the Quik! Forms Engine for PDF form output

PDFSettings (Object with properties to be set in the QuikFormsEngine)

Sample Request:

{
   "ForSign":true,
   "QuikFormID":"12",
   "PrintEditablePDF":false
}

Note: the ExecutePDF method will output a signable PDF if and only if ForSign is true and PrintEditablePDF is false.

Get Attachments

/attachments

GET

Get all attachments associated with a UNID

unid : The UNID value of the transaction that you wish to retrieve attachments from

Upload Attachments

/attachments/upload

POST

Upload an attachment file to a specified UNID

unid : The UNID value of the transaction that you wish to upload attachments to

Name (string): Assign a name to the attachment that will be displayed in the Attachments panel of the Form Viewer. Given name string must end with the file extension that matches the file type of the original attachment. For example, if uploading a PDF attachment, the Name parameter must end in “.pdf”.

Path (string): Leave this parameter empty

Content : The base 64 string for the byte content of the attachment

DocSortOrder (int): 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.

Delete Attachments

/attachments/{id}/remove

DELETE

{id} (int): The Attachment ID to be deleted. This Attachment ID must be entered in the URL when calling this API

unid : The UNID value of the transaction that you wish to delete an attachment from

Print

/print

POST

Generate a PDF of the form from HTML

Use this method for generating a PDF of a form using data submitted in a Submit event. Documentation here

FormLinks

INTERNAL QUIK! USE ONLY

Save

INTERNAL QUIK! USE ONLY