Chilkat Online Tools

Xojo / DocuSign eSignature REST API / Gets PDF documents from a template.

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateString("encrypt","{{encrypt}}")
success = queryParams.UpdateString("show_changes","{{show_changes}}")

// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = "{{accessToken}}"
http.SetRequestHeader "Accept","application/pdf"

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/documents/{{documentId}}",queryParams)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

System.DebugLog(Str(resp.StatusCode))
System.DebugLog(resp.BodyStr)

Curl Command

curl -G -d "encrypt=%7B%7Bencrypt%7D%7D"
	-d "show_changes=%7B%7Bshow_changes%7D%7D"
	-H "Accept: application/pdf"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/documents/{{documentId}}

Postman Collection Item JSON

{
  "name": "Gets PDF documents from a template.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/pdf"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/templates/{{templateId}}/documents/{{documentId}}?encrypt={{encrypt}}&show_changes={{show_changes}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "templates",
        "{{templateId}}",
        "documents",
        "{{documentId}}"
      ],
      "query": [
        {
          "key": "encrypt",
          "value": "{{encrypt}}"
        },
        {
          "key": "show_changes",
          "value": "{{show_changes}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "documentId",
          "value": "{{documentId}}",
          "type": "string"
        },
        {
          "key": "templateId",
          "value": "{{templateId}}",
          "type": "string"
        }
      ]
    },
    "description": "Retrieves one or more PDF documents from the specified template.\n\nYou can specify the ID of the document to retrieve or can specify `combined` to retrieve all documents in the template as one pdf."
  },
  "response": [
  ]
}