Chilkat Online Tools

phpExt / DocuSign REST API / Returns document page image(s) based on input.

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

$queryParams = new CkJsonObject();
$queryParams->UpdateString('count','{{count}}');
$queryParams->UpdateString('dpi','{{dpi}}');
$queryParams->UpdateString('max_height','{{max_height}}');
$queryParams->UpdateString('max_width','{{max_width}}');
$queryParams->UpdateString('nocache','{{nocache}}');
$queryParams->UpdateString('show_changes','{{show_changes}}');
$queryParams->UpdateString('start_position','{{start_position}}');

// Adds the "Authorization: Bearer {{accessToken}}" header.
$http->put_AuthToken('{{accessToken}}');
$http->SetRequestHeader('Accept','application/json');

// resp is a CkHttpResponse
$resp = $http->QuickRequestParams('GET','https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents/{{documentId}}/pages',$queryParams);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

Curl Command

curl -G -d "count=%7B%7Bcount%7D%7D"
	-d "dpi=%7B%7Bdpi%7D%7D"
	-d "max_height=%7B%7Bmax_height%7D%7D"
	-d "max_width=%7B%7Bmax_width%7D%7D"
	-d "nocache=%7B%7Bnocache%7D%7D"
	-d "show_changes=%7B%7Bshow_changes%7D%7D"
	-d "start_position=%7B%7Bstart_position%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents/{{documentId}}/pages

Postman Collection Item JSON

{
  "name": "Returns document page image(s) based on input.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents/{{documentId}}/pages?count={{count}}&dpi={{dpi}}&max_height={{max_height}}&max_width={{max_width}}&nocache={{nocache}}&show_changes={{show_changes}}&start_position={{start_position}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "documents",
        "{{documentId}}",
        "pages"
      ],
      "query": [
        {
          "key": "count",
          "value": "{{count}}"
        },
        {
          "key": "dpi",
          "value": "{{dpi}}"
        },
        {
          "key": "max_height",
          "value": "{{max_height}}"
        },
        {
          "key": "max_width",
          "value": "{{max_width}}"
        },
        {
          "key": "nocache",
          "value": "{{nocache}}"
        },
        {
          "key": "show_changes",
          "value": "{{show_changes}}"
        },
        {
          "key": "start_position",
          "value": "{{start_position}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "documentId",
          "value": "{{documentId}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        }
      ]
    }
  },
  "response": [
  ]
}