GetFormPDF()

The GetFormPDF() command returns a PDF of the form specified.

  • Quota: 60
  • Printed format: A4
Table 1. Parameters
ParameterTypeMax LengthRequiredDescription
apiTokenstring20YYour API security token configured in Field View.
formIdstringYThe unique ID of the form.
showActionsboolYIf the actions should be rendered on the report.
showAnsweredByboolYIf answered by details should be rendered on the report.
showAttachedCommentsboolYIf attached comments should be rendered on the report.
showAttachedDocumentsboolYIf attached document details should be rendered on the report.
showAttachedImagesbool YIf attached images should be rendered on the report.
showStatusAuditTrailboolYIf the status audit trail should be rendered on the report.
imageSizestring/enumYThe size of images to render on the report. Must be one of: Small, Medium, Large, or XLarge.
Table 2. Returns
FieldTypeDescription
FilePayloadByteThe 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);
   }