The DocumentInformation type is used hold information about a document that can be passed between the UX and APIs.
Below are the properties and their purpose.
- Guid UserGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the user the bookmark belongs to.
- Guid SessionGUID
- Default Value: Empty Guid.
- Intended Value: The guid for the users current session.
- Guid InstanceGUID
- Default Value: Empty Guid.
- Intended Value: The instance guid for the document.
- Guid DocumentTemplateGUID
- Default Value: Empty Guid.
- Intended Value: The guid of the template that the document is based off.
- string XML
- Default Value: Empty string.
- Intended Value: The XML used to populate the document for the Download XML button.
- string Language
- Default Value: Empty string.
- Intended Value: The language that the document will be displayed in.
- string CommandName
- Default Value: Empty string.
- Intended Value: The command that will be executed on the API. Determines what will be done with this object.
- string B64HTML
- Default Value: Empty string.
- Intended Value: The base64 html of the document to allow rendering.
- string B64PDF
- Default Value: Empty string.
- Intended Value: The base64 pdf code of the document to allow downloading the document as a pdf.
- string FileName
- Default Value: Empty string.
- Intended Value: The name of the document that will be uploaded to storage.
- string RecipientEmail
- Default Value: Empty string.
- Intended Value: The email address the PDF file will be sent to.
- Guid StorageGUID
- Default Value: Empty Guid.
- Intended Value: The Guid of the storage the PDF will be uploaded to.
- Guid EmailTemplateGUID
- Default Value: Empty Guid.
- Intended Value: The Guid of the email template that will be used to format the email.
- string StorageName
- Default Value: Empty string.
- Intended Value: The name of the storage the file will be uploaded to.
- string ErrorMessage
- Default Value: Empty string.
- Intended Value: An error message if something failed in the API so the UX can properly handle it.
PdfResponse
The PdfResponse type is used hold information about a pdf version of a document that is used internally to communicate with the HTML to PDF API. This type is a subtype of DocumentInformation.
Below are the properties and their purpose.
- string b64PDF
- Default Value: Empty string.
- Intended Value: The base64 pdf code of the document returned from the html to pdf API.
- string error
- Default Value: Empty string.
- Intended Value: Contains an error message if something failed in the html to pdf conversion.
PdfRequest
The PdfRequest type is used hold information about a document that is used internally to communicate with the HTML to PDF API. This type is a subtype of DocumentInformation.
Below are the properties and their purpose.
- string b64HTML
- Default Value: Empty string.
- Intended Value: The base64 html code of the document to make a request for conversion to the html to pdf API.
