Chilkat Online Tools

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

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;

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

http := TChilkatHttp.Create(Self);

queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('count','{{count}}');
queryParams.UpdateString('include','{{include}}');
queryParams.UpdateString('order','{{order}}');
queryParams.UpdateString('order_by','{{order_by}}');
queryParams.UpdateString('search_text','{{search_text}}');
queryParams.UpdateString('start_position','{{start_position}}');
queryParams.UpdateString('status','{{status}}');
queryParams.UpdateString('user_id','{{user_id}}');

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

resp := http.QuickRequestParams('GET','https://domain.com/v2.1/accounts/{{accountId}}/bulk_send_batch/{{bulkSendBatchId}}/envelopes',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add(IntToStr(resp.StatusCode));
Memo1.Lines.Add(resp.BodyStr);

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