Envelopes: getPageImages

Returns images of the pages in a document for display based on the parameters that you specify.

Request

HTTP request

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

documentIdstring

The documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

Optional Query Parameters
countstring

The maximum number of results to return.

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.

nocachestring

If true, using cache is disabled and image information is retrieved from a database. True is the default value.

show_changesstring

If true, changes display in the user interface.

start_positionstring

The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

Responses

CodeDescriptionReference
200

Successful response.

pageImages
400

Error encountered.

errorDetails

SDK Method

Envelopes::getDocumentPageImages

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.

page

Description of a page of a document.

dpistring

The number of dots per inch used for the page image.

errorDetailserrorDetails

If an error occurs, this property describes the error.

heightstring

The height of the page in pixels.

imageBytesstring

The number of image bytes.

mimeTypestring

The MIME type.

pageIdstring

The id of the page.

sequencestring

The sequence of the page in the document, or page number.

widthstring

The width of the page in pixels.

pageImages

endPositionstring

The last index position in the result set.

nextUristring

The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.

pages[page]

An array of page objects.

previousUristring

The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.

resultSetSizestring

The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the totalSetSize.

startPositionstring

The starting index position of the current result set.

totalSetSizestring

The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.

Examples

Generic JSON Response

Response
{
  "resultSetSize": "sample string 1",
  "startPosition": "sample string 2",
  "endPosition": "sample string 3",
  "totalSetSize": "sample string 4",
  "nextUri": "sample string 5",
  "previousUri": "sample string 6",
  "pages": [
    {
      "pageId": "sample string 1",
      "sequence": "sample string 2",
      "height": "sample string 3",
      "width": "sample string 4",
      "dpi": "sample string 5",
      "imageBytes": "sample string 6",
      "mimeType": "sample string 7",
      "errorDetails": {
        "errorCode": "sample string 1",
        "message": "sample string 2"
      }
    }
  ]
}
Generic XML Response

Response
<pageImages xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <endPosition>sample string 3</endPosition>
  <nextUri>sample string 5</nextUri>
  <pages>
    <page>
      <dpi>sample string 5</dpi>
      <errorDetails>
        <errorCode>sample string 1</errorCode>
        <message>sample string 2</message>
      </errorDetails>
      <height>sample string 3</height>
      <imageBytes>sample string 6</imageBytes>
      <mimeType>sample string 7</mimeType>
      <pageId>sample string 1</pageId>
      <sequence>sample string 2</sequence>
      <width>sample string 4</width>
    </page>
  </pages>
  <previousUri>sample string 6</previousUri>
  <resultSetSize>sample string 1</resultSetSize>
  <startPosition>sample string 2</startPosition>
  <totalSetSize>sample string 4</totalSetSize>
</pageImages> 
}} />