Chilkat Online Tools

C# / DocuSign eSignature REST API / Gets a page image from a template for display.

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

Chilkat.JsonObject queryParams = new Chilkat.JsonObject();
queryParams.UpdateString("dpi","{{dpi}}");
queryParams.UpdateString("max_height","{{max_height}}");
queryParams.UpdateString("max_width","{{max_width}}");
queryParams.UpdateString("show_changes","{{show_changes}}");

// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = "{{accessToken}}";
http.SetRequestHeader("Accept","image/png");

Chilkat.HttpResponse resp = http.QuickRequestParams("GET","https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/documents/{{documentId}}/pages/{{pageNumber}}/page_image",queryParams);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Debug.WriteLine(Convert.ToString(resp.StatusCode));
Debug.WriteLine(resp.BodyStr);

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}}/templates/{{templateId}}/documents/{{documentId}}/pages/{{pageNumber}}/page_image

Postman Collection Item JSON

{
  "name": "Gets a page image from a template for display.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "image/png"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/templates/{{templateId}}/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}}",
        "templates",
        "{{templateId}}",
        "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": "pageNumber",
          "value": "{{pageNumber}}",
          "type": "string"
        },
        {
          "key": "templateId",
          "value": "{{templateId}}",
          "type": "string"
        }
      ]
    },
    "description": "Retrieves a page image for display from the specified template."
  },
  "response": [
  ]
}