The miscellaneous configuration methods and options are available in the GetPDFForms of the HTMLFormViewTransaction.
PLEASE VISIT THE URL'S BELOW FOR THE LATEST XML FORMAT
GetPDFForms Web Service URL: https://websvcs.quikforms.com/HTMLFormViewTrans/v5400/HTMLFormViewTransaction.asmx?op=GetPDFForms
Service WSDL: https://websvcs.quikforms.com/HTMLFormViewTrans/v5400/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
SOAP 1.1 Request
The following is a sample SOAP 1.1 request. The placeholders shown need to be replaced with actual values.
<?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
This method accepts the following parameters.
Field Name | Data Type | Length | Required? | Description |
---|---|---|---|---|
FormIDsList | String | 8000 chars | YES | CSV list of unique form IDs |
SOAP 1.1 Response
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
<?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.
Field Name | Data Type | Length | Description |
---|---|---|---|
RoleID | Int |
| A unique ID for the field |
QFDLevel1FieldID | Int |
| The internal ID for the Quik! Parent Field |
FieldName | String |
| The field name of the Quik! Parent Field or role |
RoleInstance | Int |
| The role instance number (e.g. 1 for the first role, 2 for the second role, etc.) |
SOAP 1.2 Request
The following is a sample SOAP 1.2 request. The placeholders shown need to be replaced with actual values.
<?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:Body> <GetPDFForms xmlns="https://websvcs.quikforms.com/htmlformviewtrans5100/formviewhtml/"> <strFormData>string</strFormData> <blnEditablePDFs>boolean</blnEditablePDFs> <signAllDocsCombined>boolean</signAllDocsCombined> </GetPDFForms> </soap12:Body> </soap12:Envelope>
SOAP Body Request Parameters
This method accepts the following parameters.
Field Name | Data Type | Length | Required? | Description |
---|---|---|---|---|
FormIDsList | String | 8000 chars | YES | CSV list of unique form IDs |
SOAP 1.2 Response
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
<?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: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> </soap12:Body> </soap12: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.
Field Name | Data Type | Length | Description |
---|---|---|---|
RoleID | Int |
| A unique ID for the field |
QFDLevel1FieldID | Int |
| The internal ID for the Quik! Parent Field |
FieldName | String |
| The field name of the Quik! Parent Field or role |
RoleInstance | Int |
| The role instance number (e.g. 1 for the first role, 2 for the second role, etc.) |
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /HTMLFormViewTrans/v5400/HTMLFormViewTransaction.asmx/GetPDFForms?strFormData=string&blnEditablePDFs=string&signAllDocsCombined=string HTTP/1.1 Host: websvcs.quikforms.com
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <QuikResultWS xmlns="https://websvcs.quikforms.com/htmlformviewtrans5100/formviewhtml/"> <ErrorCode>int</ErrorCode> <Message>string</Message> <ResultData> <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</ResultData> </QuikResultWS>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /HTMLFormViewTrans/v5400/HTMLFormViewTransaction.asmx/GetPDFForms HTTP/1.1 Host: websvcs.quikforms.com Content-Type: application/x-www-form-urlencoded Content-Length: length strFormData=string&blnEditablePDFs=string&signAllDocsCombined=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <QuikResultWS xmlns="https://websvcs.quikforms.com/htmlformviewtrans5100/formviewhtml/"> <ErrorCode>int</ErrorCode> <Message>string</Message> <ResultData> <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</ResultData> </QuikResultWS>