Chilkat Online Tools

TCL / DocuSign eSignature REST API / Gets a page image from an envelope for display.

Back to Collection Items

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

set queryParams [new_CkJsonObject]

CkJsonObject_UpdateString $queryParams "dpi" "{{dpi}}"
CkJsonObject_UpdateString $queryParams "max_height" "{{max_height}}"
CkJsonObject_UpdateString $queryParams "max_width" "{{max_width}}"
CkJsonObject_UpdateString $queryParams "show_changes" "{{show_changes}}"

# Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp_put_AuthToken $http "{{accessToken}}"
CkHttp_SetRequestHeader $http "Accept" "image/png"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents/{{documentId}}/pages/{{pageNumber}}/page_image" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $queryParams

Curl Command

curl -G -d "dpi=%7B%7Bdpi%7D%7D"
	-d "max_height=%7B%7Bmax_height%7D%7D"
	-d "max_width=%7B%7Bmax_width%7D%7D"
	-d "show_changes=%7B%7Bshow_changes%7D%7D"
	-H "Accept: image/png"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents/{{documentId}}/pages/{{pageNumber}}/page_image

Postman Collection Item JSON

{
  "name": "Gets a page image from an envelope for display.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "image/png"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents/{{documentId}}/pages/{{pageNumber}}/page_image?dpi={{dpi}}&max_height={{max_height}}&max_width={{max_width}}&show_changes={{show_changes}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "documents",
        "{{documentId}}",
        "pages",
        "{{pageNumber}}",
        "page_image"
      ],
      "query": [
        {
          "key": "dpi",
          "value": "{{dpi}}"
        },
        {
          "key": "max_height",
          "value": "{{max_height}}"
        },
        {
          "key": "max_width",
          "value": "{{max_width}}"
        },
        {
          "key": "show_changes",
          "value": "{{show_changes}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "documentId",
          "value": "{{documentId}}",
          "type": "string"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}",
          "type": "string"
        },
        {
          "key": "pageNumber",
          "value": "{{pageNumber}}",
          "type": "string"
        }
      ]
    },
    "description": "Retrieves a page image for display from the specified envelope."
  },
  "response": [
  ]
}