Endpoint converts HTML into a PDF for download.
- X-Availity-Customer-ID (required) - Organization customer id is used by the system to identify the owner of the PDF document.
- applicationId (required) — Application name that created the PDF request. Examples:
- html (required) - Simple HTML that renders into a PDF. Max size
- fileName (optional) - If
fileNameis not assigned then the default PDF job id is used instead.
- Send an entire HTML document including
- You should produce HTML specifically for PDF rendering. Keep your HTML and styles simple and compact. Table layouts usually work out well in PDF format.
- CSS at the head of your document will be used by the PDF rendering engine
- Images can included using base64 encoded data URLs in image tags. Ex:
<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAb2Z0d2Fy..." />
- Make sure to use HTML entities in your templates. For example, if you want to render an apostrophe
'then use entity
'instead. Please see https://www.w3.org/wiki/Common_HTML_entities_used_for_typography for references to other HTML entities.
- 200 - PDF created and can be downloaded
- 202 - PDF is processing and is not ready for download
Rending checkboxes is already supported out of the box but you can't prevent the user from selecting/deselecting the checkbox. In order to show read only checkboxes you will have to include inline images in your template.
Read-only checked box using image:
Read-only unchecked box using image:
Example Handlebar templates than conditionally renders check/uncheck state when
You can use any image for checked/unchecked state as long as it can fit inside data uri attribute.