Templates: getDocumentPageImage

Retrieves a page image for display from the specified template.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

documentIdstring

Integer that identifies the document in the envelope.

pageNumberstring

The page number being accessed.

templateIdstring

The id of the template.

Optional Query Parameters
dpistring

The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.

max_heightstring

Sets the maximum height of the returned images in pixels.

max_widthstring

Sets the maximum width of the returned images in pixels.

show_changesstring

Responses

CodeDescriptionReference
200

Successful response.

400

Error encountered.

errorDetails

SDK Method

Templates::getDocumentPageImage

Definitions

errorDetails

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

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

}} />