Chilkat Online Tools

C / DocuSign REST API / Gets envelopes from a specific bulk send batch

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject queryParams;
    HCkHttpResponse resp;

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

    http = CkHttp_Create();

    queryParams = CkJsonObject_Create();
    CkJsonObject_UpdateString(queryParams,"count","{{count}}");
    CkJsonObject_UpdateString(queryParams,"include","{{include}}");
    CkJsonObject_UpdateString(queryParams,"order","{{order}}");
    CkJsonObject_UpdateString(queryParams,"order_by","{{order_by}}");
    CkJsonObject_UpdateString(queryParams,"search_text","{{search_text}}");
    CkJsonObject_UpdateString(queryParams,"start_position","{{start_position}}");
    CkJsonObject_UpdateString(queryParams,"status","{{status}}");
    CkJsonObject_UpdateString(queryParams,"user_id","{{user_id}}");

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

    resp = CkHttp_QuickRequestParams(http,"GET","https://domain.com/v2.1/accounts/{{accountId}}/bulk_send_batch/{{bulkSendBatchId}}/envelopes",queryParams);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        return;
    }

    printf("%d\n",CkHttpResponse_getStatusCode(resp));
    printf("%s\n",CkHttpResponse_bodyStr(resp));
    CkHttpResponse_Dispose(resp);


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(queryParams);

    }

Curl Command

curl -G -d "count=%7B%7Bcount%7D%7D"
	-d "include=%7B%7Binclude%7D%7D"
	-d "order=%7B%7Border%7D%7D"
	-d "order_by=%7B%7Border_by%7D%7D"
	-d "search_text=%7B%7Bsearch_text%7D%7D"
	-d "start_position=%7B%7Bstart_position%7D%7D"
	-d "status=%7B%7Bstatus%7D%7D"
	-d "user_id=%7B%7Buser_id%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/bulk_send_batch/{{bulkSendBatchId}}/envelopes

Postman Collection Item JSON

{
  "name": "Gets envelopes from a specific bulk send batch",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/bulk_send_batch/{{bulkSendBatchId}}/envelopes?count={{count}}&include={{include}}&order={{order}}&order_by={{order_by}}&search_text={{search_text}}&start_position={{start_position}}&status={{status}}&user_id={{user_id}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "bulk_send_batch",
        "{{bulkSendBatchId}}",
        "envelopes"
      ],
      "query": [
        {
          "key": "count",
          "value": "{{count}}"
        },
        {
          "key": "include",
          "value": "{{include}}"
        },
        {
          "key": "order",
          "value": "{{order}}"
        },
        {
          "key": "order_by",
          "value": "{{order_by}}"
        },
        {
          "key": "search_text",
          "value": "{{search_text}}"
        },
        {
          "key": "start_position",
          "value": "{{start_position}}"
        },
        {
          "key": "status",
          "value": "{{status}}"
        },
        {
          "key": "user_id",
          "value": "{{user_id}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "bulkSendBatchId",
          "value": "{{bulkSendBatchId}}"
        }
      ]
    }
  },
  "response": [
  ]
}