Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This service converts an HTML form into a PDF. NOTE: This service is part of a larger set of services. Please only use this service method, GetPDFForms, as the GetPDFForms method as the other methods are for internal Quik! use.

PLEASE VISIT THE URL'S BELOW FOR THE LATEST XML FORMAT

GetPDFForms Web Service URL: https://websvcs.quikforms.com/HTMLFormViewTrans/v5500/HTMLFormViewTransaction.asmx?op=GetPDFForms
Service WSDL: https://websvcs.quikforms.com/HTMLFormViewTrans/v5500/HTMLFormViewTransaction.asmx?WSDL

Methods:

The following method(s) are used to perform various functions useful to manage your implementation or Sample Website using the Quik! Forms Engine software.

  • GetPDFForms

GetPDFForms

GetPDFForms Details

Use this method to retrieve a PDF for the HTML form that was submitted to your server. This method is best used behind the scenes after your server receives a form's posted form data (i.e. HTTP POST) during a submit Submit event. For example, if a user submits a form for validation and it passes validation you might call this service to get the PDF for archiving or routing through your workflow. 

SOAP

...

Request

Code Block
languagexml
titleXML
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetPDFForms xmlns="https://websvcs.quikforms.com/htmlformviewtrans5100/formviewhtml/">
      <strFormData>string</strFormData>
      <blnEditablePDFs>boolean</blnEditablePDFs>
      <signAllDocsCombined>boolean</signAllDocsCombined>
    </GetPDFForms>
  </soap:Body>
</soap:Envelope>

SOAP Body Request Parameters

...

Field Name

Data Type

Length

Required?

Description

strFormData

String

8000 chars

YES

The exact data received from an HTTP POST of the HTML Form. Pass the exact string of posted data your server received.

blnEditablePDFsBoolean
NOBy default PDF fields are not editable and are flattened. By setting this value to TRUE you can return a PDF that can still be edited.
signAllDocsCombinedBoolean
NOSet flag to TRUE to include forms AND any external documents in a single PDF that is returned by this service

SOAP 1.1 Response

...

Code Block
languagexml
titleXML
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetPDFFormsResponse xmlns="https://websvcs.quikforms.com/htmlformviewtrans5100/formviewhtml/">
      <GetPDFFormsResult>
        <ErrorCode>int</ErrorCode>
        <Message>string</Message>
        <ResultData>
          <xsd:schema>schema</xsd:schema>xml</ResultData>
      </GetPDFFormsResult>
    </GetPDFFormsResponse>
  </soap:Body>
</soap:Envelope>

Result Fields

This method returns a table of client roles that exist on the provided forms so a user can assign their client records to each role for prefilling the forms.

...