Envelopes: getPageImages

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 ID of the document being accessed.

envelopeIdstring

The envelope's GUID. (For example, 93be49ab-afa0-4adf-933c-f752070d71ec).

Optional Query Parameters
countstring

The maximum number of results to be returned by this request.

dpistring

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

max_heightstring

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

max_widthstring

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

nocachestring

show_changesstring

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

A 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 unique 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 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]

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 returned in this response.

startPositionstring

Starting position of the current result set.

totalSetSizestring

The total number of items in the search's result set. It will always be greater than or equal to the value of the resultSetSize field.

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> 
}} />