Show/Hide Toolbars

PerfectApps™ Help Guide

Get App Instance PDF: The GetAppInstancePDF method retrieves a app’s instance PDF in a Base64binary format, ready to be written to file.

 

REQUEST ATTRIBUTES

appendixHeightInches

string

The height of the pdf appendix in inches

appendixWidthInches

string

The width of the pdf appendix in inches

appId

string

This is the app ID obtained from the app's API reference link

instanceId

int

This is the app's instance number (incrementing integer, starting at 1 for the first submitted instance of the app)

section

string

Permits generation of different parts of the app. Possible values:

complete - (default value) - generates for pages along with appendix pages in a single file

app - generates only app pages

appendix - generates only appendix pages

separate - generates two separate files; one for app pages and one for appendix pages

tokenIn

string

This is the security token that is obtained by the previous API call. See API Security topic for more details

 

 

RETURN ATTRIBUTES

GetAppInstancePDFResult

int

An integer result indicating success (= 0) or an error (<> 0)

pdf

base64binary

The app instance's PDF content in base64Binary format

tokenOut

string

This is the new security token that should be used for the next function call after this one. See the API Security topic for more details

 

REST

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

 

POST /REST/api/portal/GetAppInstancePDF HTTP/1.1

Host: <server url>

Content-Type: multipart/form-data

 

Content-Disposition: form-data; name="appendixHeightInches" string

Content-Disposition: form-data; name="appendixWidthInches" string

Content-Disposition: form-data; name="appId" string

Content-Disposition: form-data; name="instanceId" int

Content-Disposition: form-data; name="section" string

Content-Disposition: form-data; name="tokenIn" string

 

HTTP/1.1 200 OK

Content-Length: length

Content-Type: application/json; charset=utf-8

{

"GetAppInstancePDFResult":int,

"pdf":base64binary,

"tokenOut":string

}

 

Return to: Account API Methods (REST), Integration