GetFormInstancePDF

 Previous  Home topic  Next  Print this topic Send Feedback

The GetFormInstancePDF method retrieves a form’s instance PDF in a Base64binary format, ready to be written to file.

 

Send Params

Return Params
•appendixWidthInches – This is the width of a PDF page, in inches.
•appendixHeightInches – This is the height of a PDF page, in inches.
•formId – This is the form id obtained from the form’s API reference link.

Send Param formID - form ID From API Ref Link

•instanceid – This is the form’s instance number (incrementing integer, starting at 1 for the first instance of the form).
•section – This allows for generating different parts of form. Possible values:
ocomplete – (default value), generates form pages along with appendix pages
oform – generates only form pages
oappendix – generates only appendix pages
oseparate – generates two separate files, one for form pages and one form appendix pages
•GetFormInstanceDataResult – This is the integer result indicating success ( = 0 ) or an error (<> 0).
•pdf – This is the form instance’s PDF content in base64Binary format.

 

•tokenOut – This is the new security token that should be used for the next Web service call after this one. See the API Security for more details.

 

 

Test

The test form is only available for requests from the local machine.

 

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

 

POST /api/API.asmx HTTP/1.1

Host: testing.perfectforms.com

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://www.PerfectForms.com/API/GetFormInstancePDF"

 

<?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>

    <GetFormInstancePDF xmlns="http://www.PerfectForms.com/API">

      <tokenIn>string</tokenIn>

      <formId>string</formId>

      <instanceId>int</instanceId>

      <section>string</section>

      <appendixWidthInches>string</appendixWidthInches>

      <appendixHeightInches>string</appendixHeightInches>

    </GetFormInstancePDF>

  </soap:Body>

</soap:Envelope>

 

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

 

<?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>

    <GetFormInstancePDFResponse xmlns="http://www.PerfectForms.com/API">

      <GetFormInstancePDFResult>int</GetFormInstancePDFResult>

      <tokenOut>string</tokenOut>

      <pdf>base64Binary</pdf>

    </GetFormInstancePDFResponse>

  </soap:Body>

</soap:Envelope>

 

 

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

 

POST /api/API.asmx HTTP/1.1

Host: testing.perfectforms.com

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

 

<?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>

    <GetFormInstancePDF xmlns="http://www.PerfectForms.com/API">

      <tokenIn>string</tokenIn>

      <formId>string</formId>

      <instanceId>int</instanceId>

      <section>string</section>

      <appendixWidthInches>string</appendixWidthInches>

      <appendixHeightInches>string</appendixHeightInches>

    </GetFormInstancePDF>

  </soap12:Body>

</soap12:Envelope>

 

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

 

<?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>

    <GetFormInstancePDFResponse xmlns="http://www.PerfectForms.com/API">

      <GetFormInstancePDFResult>int</GetFormInstancePDFResult>

      <tokenOut>string</tokenOut>

      <pdf>base64Binary</pdf>

    </GetFormInstancePDFResponse>

  </soap12:Body>

</soap12:Envelope>

 

Updated: 06/12/2011  Page url: http://www.perfectforms.com/Documentation/manual/html/?fg_getforminstancepdf.htm
PerfectForms™ -- forms software, workflow software, and business process management