Chilkat Online Tools

C / Zoom API / Get role information

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    const char *strVal;
    const char *id;
    const char *name;
    const char *description;
    int total_members;
    int Second_level;
    int i;
    int count_i;

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

    http = CkHttp_Create();

    // Adds the "Authorization: Bearer <access_token>" header.
    CkHttp_putAuthToken(http,"<access_token>");

    sbResponseBody = CkStringBuilder_Create();
    success = CkHttp_QuickGetSb(http,"https://api.zoom.us/v2/roles/:roleId",sbResponseBody);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttp_getLastStatus(http);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttp_lastHeader(http));
        printf("Failed.\n");
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "id": "in fugiat ad magna irure",
    //   "name": "deserunt pariatur Duis",
    //   "description": "dolor minim commodo non laborum",
    //   "total_members": 28969635,
    //   "privileges": [
    //     "eiusmod dolor",
    //     "qui occaecat"
    //   ],
    //   "sub_account_privileges": {
    //     "second_level": -33281927
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    id = CkJsonObject_stringOf(jResp,"id");
    name = CkJsonObject_stringOf(jResp,"name");
    description = CkJsonObject_stringOf(jResp,"description");
    total_members = CkJsonObject_IntOf(jResp,"total_members");
    Second_level = CkJsonObject_IntOf(jResp,"sub_account_privileges.second_level");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"privileges");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        strVal = CkJsonObject_stringOf(jResp,"privileges[i]");
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/roles/:roleId

Postman Collection Item JSON

{
  "name": "Get role information",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/roles/:roleId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "roles",
        ":roleId"
      ],
      "variable": [
        {
          "key": "roleId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) Role Id. "
        }
      ]
    },
    "description": "Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list of privileges.\n\nUse this API to get information including specific privileges assigned to a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control).<br>\n**Pre-requisite:**<br>\n* A Pro or higher plan.<br>\n* For role management and updates, you must be the Account Owner or user with role management permissions.\n\n**Scopes:** `role:read:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
  },
  "response": [
    {
      "name": "**Status Code:** `200`<br>\nInformation about a specific role returned.\n\n**Error Code:** `200`<br>\nYou do not have the permission to retrieve role information.\n",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/roles/:roleId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "roles",
            ":roleId"
          ],
          "variable": [
            {
              "key": "roleId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Role Id. "
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"id\": \"in fugiat ad magna irure\",\n \"name\": \"deserunt pariatur Duis\",\n \"description\": \"dolor minim commodo non laborum\",\n \"total_members\": 28969635,\n \"privileges\": [\n  \"eiusmod dolor\",\n  \"qui occaecat\"\n ],\n \"sub_account_privileges\": {\n  \"second_level\": -33281927\n }\n}"
    },
    {
      "name": "**Error Code:** `300`<br>\nRole not found.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/roles/:roleId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "roles",
            ":roleId"
          ],
          "variable": [
            {
              "key": "roleId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Role Id. "
            }
          ]
        }
      },
      "status": "Multiple Choices",
      "code": 300,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}