DocuSign Momentum 2018DocuSign Momentum 2018

Envelopes: getPageImage

Retrieves a page image for display from the specified envelope.

Request

HTTP request

GET /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

documentIdstring

The ID of the document being accessed.

envelopeIdstring

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

pageNumberstring

The page number being accessed.

Optional Query Parameters
dpistring

Sets the dpi for the image.

max_heightstring

Sets the maximum height for the page image in pixels. The dpi is recalculated based on this setting.

max_widthstring

Sets the maximum width for the page image in pixels. The dpi is recalculated based on this setting.

show_changesstring

Responses

CodeDescriptionReference
200

Successful response.

400

Error encountered.

errorDetails

SDK Method

Envelopes::getDocumentPageImage

Definitions

errorDetails