Templates: getPageImages

Request

HTTP request

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

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.

templateId string

The ID of the template being accessed.

Optional query parameters
count string

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

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.

nocache string
show_changes string
start_position string

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

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

SDK Method

Templates::getPages

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.

page

Description of a page of a document.

dpi string

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

errorDetails errorDetails
height string

Height of the tab in pixels.

imageBytes string
mimeType string
pageId string
sequence string
width string

Width of the tab in pixels.

pageImages

endPosition string

The last position in the result set.

nextUri string

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]
previousUri string

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.

resultSetSize string

The number of results returned in this response.

startPosition string

Starting position of the current result set.

totalSetSize string

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>