Chilkat Online Tools

TCL / DocuSign Rooms API - v2 / Returns the roles for which the calling user, based on their role within the room, can assign to invitees.

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

set queryParams [new_CkJsonObject]

CkJsonObject_UpdateString $queryParams "assigneeEmail" "{{assigneeEmail}}"
CkJsonObject_UpdateString $queryParams "filter" "{{filter}}"
CkJsonObject_UpdateInt $queryParams "startPosition" 0
CkJsonObject_UpdateInt $queryParams "count" 100

# Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp_put_AuthToken $http "{{accessToken}}"
CkHttp_SetRequestHeader $http "Accept" "text/plain, application/json, text/json"

# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://domain.com/v2/accounts/{{accountId}}/rooms/{{roomId}}/assignable_roles" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $queryParams
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $queryParams

Curl Command

curl -G -d "assigneeEmail=%7B%7BassigneeEmail%7D%7D"
	-d "filter=%7B%7Bfilter%7D%7D"
	-d "startPosition=0"
	-d "count=100"
	-H "Accept: text/plain, application/json, text/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2/accounts/{{accountId}}/rooms/{{roomId}}/assignable_roles

Postman Collection Item JSON

{
  "name": "Returns the roles for which the calling user, based on their role within the room, can assign to invitees.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "text/plain, application/json, text/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2/accounts/{{accountId}}/rooms/{{roomId}}/assignable_roles?assigneeEmail={{assigneeEmail}}&filter={{filter}}&startPosition=0&count=100",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2",
        "accounts",
        "{{accountId}}",
        "rooms",
        "{{roomId}}",
        "assignable_roles"
      ],
      "query": [
        {
          "key": "assigneeEmail",
          "value": "{{assigneeEmail}}"
        },
        {
          "key": "filter",
          "value": "{{filter}}"
        },
        {
          "key": "startPosition",
          "value": "0"
        },
        {
          "key": "count",
          "value": "100"
        }
      ],
      "variable": [
        {
          "key": "roomId",
          "value": "{{roomId}}"
        },
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    }
  },
  "response": [
  ]
}