Show/Hide Toolbars

PerfectApps™ Help Guide

The GetAppInstancePDF method retrieves a app’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.

appId – This is the app id obtained from the app’s API reference link.

Send Param appID - app ID From API Ref Link

 

instanceid – This is the app’s instance number (incrementing integer, starting at 1 for the first instance of the app).

section – This allows for generating different parts of the app. Possible values:

ocomplete (default value), generates app pages along with appendix pages

oapp generates only app pages

oappendix generates only appendix pages

oseparate generates two separate files, one for app pages and one app appendix pages

GetAppInstanceDataResult – This is the integer result indicating success ( = 0 ) or an error (<> 0).

pdf – This is the app 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.

 

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: app.perfectforms.com

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

Content-Length: length

SOAPAction: "http://www.PerfectApps.com/API/GetAppInstancePDF"

 

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

    <GetAppInstancePDF xmlns="http://www.PerfectApps.com/API">

      <tokenIn>string</tokenIn>

      <appId>string</appId>

      <instanceId>int</instanceId>

      <section>string</section>

      <appendixWidthInches>string</appendixWidthInches>

      <appendixHeightInches>string</appendixHeightInches>

    </GetAppInstancePDF>

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

    <GetAppInstancePDFResponse xmlns="http://www.PerfectApps.com/API">

      <GetAppInstancePDFResult>int</GetAppInstancePDFResult>

      <tokenOut>string</tokenOut>

      <pdf>base64Binary</pdf>

    </GetAppInstancePDFResponse>

  </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: app.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>

    <GetAppInstancePDF xmlns="http://www.PerfectApps.com/API">

      <tokenIn>string</tokenIn>

      <appId>string</appId>

      <instanceId>int</instanceId>

      <section>string</section>

      <appendixWidthInches>string</appendixWidthInches>

      <appendixHeightInches>string</appendixHeightInches>

    </GetAppInstancePDF>

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

    <GetAppInstancePDFResponse xmlns="http://www.PerfectApps.com/API">

      <GetAppInstancePDFResult>int</GetAppInstancePDFResult>

      <tokenOut>string</tokenOut>

      <pdf>base64Binary</pdf>

    </GetAppInstancePDFResponse>

  </soap12:Body>

</soap12:Envelope>

 

 

Return to: Account API Methods (SOAP), Integration