Chilkat Online Tools

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

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW queryParams;
    HCkHttpResponseW resp;

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

    http = CkHttpW_Create();

    queryParams = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(queryParams,L"include_anchor_tab_locations",L"{{include_anchor_tab_locations}}");
    CkJsonObjectW_UpdateString(queryParams,L"include_extended",L"{{include_extended}}");
    CkJsonObjectW_UpdateString(queryParams,L"include_tabs",L"{{include_tabs}}");

    // Adds the "Authorization: Bearer {{accessToken}}" header.
    CkHttpW_putAuthToken(http,L"{{accessToken}}");
    CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");

    resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://domain.com/v2.1/accounts/{{accountId}}/templates/{{templateId}}/recipients",queryParams);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(queryParams);
        return;
    }

    wprintf(L"%d\n",CkHttpResponseW_getStatusCode(resp));
    wprintf(L"%s\n",CkHttpResponseW_bodyStr(resp));
    CkHttpResponseW_Dispose(resp);


    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(queryParams);

    }

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": [
  ]
}