Chilkat Online Tools

Objective-C / 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

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"assigneeEmail" value: @"{{assigneeEmail}}"];
[queryParams UpdateString: @"filter" value: @"{{filter}}"];
[queryParams UpdateInt: @"startPosition" value: [NSNumber numberWithInt: 0]];
[queryParams UpdateInt: @"count" value: [NSNumber numberWithInt: 100]];

// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = @"{{accessToken}}";
[http SetRequestHeader: @"Accept" value: @"text/plain, application/json, text/json"];

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://domain.com/v2/accounts/{{accountId}}/rooms/{{roomId}}/assignable_roles" json: queryParams];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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