Chilkat Online Tools

Foxpro / DocuSign REST API / Gets recipient information from a template.

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("include_anchor_tab_locations","{{include_anchor_tab_locations}}")
loQueryParams.UpdateString("include_extended","{{include_extended}}")
loQueryParams.UpdateString("include_tabs","{{include_tabs}}")

* Adds the "Authorization: Bearer {{accessToken}}" header.
loHttp.AuthToken = "{{accessToken}}"
loHttp.SetRequestHeader("Accept","application/json")

loResp = loHttp.QuickRequestParams("GET","https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/recipients",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loQueryParams
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loQueryParams

Curl Command

curl -G -d "include_anchor_tab_locations=%7B%7Binclude_anchor_tab_locations%7D%7D"
	-d "include_extended=%7B%7Binclude_extended%7D%7D"
	-d "include_tabs=%7B%7Binclude_tabs%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/recipients

Postman Collection Item JSON

{
  "name": "Gets recipient information from a template.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/templates/{{templateId}}/recipients?include_anchor_tab_locations={{include_anchor_tab_locations}}&include_extended={{include_extended}}&include_tabs={{include_tabs}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "templates",
        "{{templateId}}",
        "recipients"
      ],
      "query": [
        {
          "key": "include_anchor_tab_locations",
          "value": "{{include_anchor_tab_locations}}"
        },
        {
          "key": "include_extended",
          "value": "{{include_extended}}"
        },
        {
          "key": "include_tabs",
          "value": "{{include_tabs}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "templateId",
          "value": "{{templateId}}"
        }
      ]
    },
    "description": "Retrieves the information for all recipients in the specified template."
  },
  "response": [
  ]
}