Templates: getDocumentPageImage

Retrieves a page image for display from the specified template.

Request

HTTP request

GET /v2/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image

Parameters

Parameter name Value Description
Path parameters
accountId string

The external account number (int) or account ID Guid.

documentId string

The ID of the document being accessed.

pageNumber string

The page number being accessed.

templateId string

The ID of the template being accessed.

Optional query parameters
dpi string

Number of dots per inch for the resulting image. The default if not used is 94. The range is 1-310.

max_height string

Sets the maximum height (in pixels) of the returned image.

max_width string

Sets the maximum width (in pixels) of the returned image.

show_changes string

Responses

image/png

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Templates::getDocumentPageImage

Definitions Expand All | Collapse All

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.