Chilkat Online Tools

PowerBuilder / DocuSign REST API / Returns a list of bulk send batch satuses initiated by account.

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")

loo_QueryParams.UpdateString("batch_ids","{{batch_ids}}")
loo_QueryParams.UpdateString("count","{{count}}")
loo_QueryParams.UpdateString("search_text","{{search_text}}")
loo_QueryParams.UpdateString("start_position","{{start_position}}")
loo_QueryParams.UpdateString("status","{{status}}")

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

loo_Resp = loo_Http.QuickRequestParams("GET","https://domain.com/v2.1/accounts/{{accountId}}/bulk_send_batch",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_QueryParams
    return
end if

Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp


destroy loo_Http
destroy loo_QueryParams

Curl Command

curl -G -d "batch_ids=%7B%7Bbatch_ids%7D%7D"
	-d "count=%7B%7Bcount%7D%7D"
	-d "search_text=%7B%7Bsearch_text%7D%7D"
	-d "start_position=%7B%7Bstart_position%7D%7D"
	-d "status=%7B%7Bstatus%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/bulk_send_batch

Postman Collection Item JSON

{
  "name": "Returns a list of bulk send batch satuses initiated by account.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/bulk_send_batch?batch_ids={{batch_ids}}&count={{count}}&search_text={{search_text}}&start_position={{start_position}}&status={{status}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "bulk_send_batch"
      ],
      "query": [
        {
          "key": "batch_ids",
          "value": "{{batch_ids}}"
        },
        {
          "key": "count",
          "value": "{{count}}"
        },
        {
          "key": "search_text",
          "value": "{{search_text}}"
        },
        {
          "key": "start_position",
          "value": "{{start_position}}"
        },
        {
          "key": "status",
          "value": "{{status}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    }
  },
  "response": [
  ]
}