The GetFormPDF() command returns a PDF of the form
specified.
- Quota: 60
- Printed format: A4
|
Table 1. Parameters| Parameter | Type | Max Length | Required | Description |
|---|
| apiToken | string | 20 | Y | Your API security token configured in Field View. |
| formId | string | | Y | The unique ID of the form. |
| showActions | bool | | Y | If the actions should be rendered on the report. |
| showAnsweredBy | bool | | Y | If answered by details should be rendered on the report. |
| showAttachedComments | bool | | Y | If attached comments should be rendered on the report. |
| showAttachedDocuments | bool | | Y | If attached document details should be rendered on the report. |
| showAttachedImages | bool | | Y | If attached images should be rendered on the report. |
| showStatusAuditTrail | bool | | Y | If the status audit trail should be rendered on the report. |
| imageSize | string/enum | | Y | The size of images to render on the report. Must be one of: Small, Medium, Large, or
XLarge. |
| fullResolutionImages | bool | | | If true, report images will be full resolution. |
Table 2. Returns| Field | Type | Description |
|---|
| FilePayload | Byte | The PDF file as bytes. |
<ProjectFormsListResponse>
<Status>
SUCCESS
<Message>Success.</Message>
</Status>
<FilePayload></FilePayload>
</ProjectFormsListResponse>
Example Recreating PDF file in
.Net
var response = client.GetFormPDF(formId, showActions, showAnsweredBy, showAttachedComments, showAttachedDocuments, showAttachedImages, showStatusAuditTrail);
if (response.Status.Code == APIBaseClass.StatusCode.SUCCESS)
{
File.WriteAllBytes(@"c:\\temp\\formpdf.pdf", response.FilePayload);
}
