Chilkat Online Tools

Foxpro / 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

LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp

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

loHttp = CreateObject('Chilkat_9_5_0.Http')

loQueryParams = CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams.UpdateString("assigneeEmail","{{assigneeEmail}}")
loQueryParams.UpdateString("filter","{{filter}}")
loQueryParams.UpdateInt("startPosition",0)
loQueryParams.UpdateInt("count",100)

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

loResp = loHttp.QuickRequestParams("GET","https://domain.com/v2/accounts/{{accountId}}/rooms/{{roomId}}/assignable_roles",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loQueryParams
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loQueryParams

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