Chilkat Online Tools

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

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
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_QueryParams = create oleobject
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_QueryParams.UpdateString("include_anchor_tab_locations","{{include_anchor_tab_locations}}")
loo_QueryParams.UpdateString("include_extended","{{include_extended}}")
loo_QueryParams.UpdateString("include_tabs","{{include_tabs}}")

// 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}}/templates/{{templateId}}/recipients",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 "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": [
  ]
}