Chilkat Online Tools

C++ / Zoom API / List members in a role

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>

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

    CkHttp http;
    bool success;

    CkJsonObject queryParams;
    queryParams.UpdateString("page_count","quis officia in reprehenderit");
    queryParams.UpdateInt("page_number",1);
    queryParams.UpdateString("next_page_token","quis officia in reprehenderit");
    queryParams.UpdateInt("page_size",30);

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

    CkHttpResponse *resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/roles/:roleId/members",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

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

    // {
    //   "page_count": 1,
    //   "page_number": 1,
    //   "page_size": 30,
    //   "total_records": 1,
    //   "members": [
    //     {
    //       "id": "zadksadjBBBBBBB8uQ",
    //       "email": "example@example.com",
    //       "first_name": "Taylor",
    //       "last_name": "Gomez",
    //       "type": 2,
    //       "department": "Chemistry"
    //     }
    //   ]
    // }

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

    const char *id = 0;
    const char *email = 0;
    const char *first_name = 0;
    const char *last_name = 0;
    int v_type;
    const char *department = 0;

    int page_count = jResp.IntOf("page_count");
    int page_number = jResp.IntOf("page_number");
    int page_size = jResp.IntOf("page_size");
    int total_records = jResp.IntOf("total_records");
    int i = 0;
    int count_i = jResp.SizeOfArray("members");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("members[i].id");
        email = jResp.stringOf("members[i].email");
        first_name = jResp.stringOf("members[i].first_name");
        last_name = jResp.stringOf("members[i].last_name");
        v_type = jResp.IntOf("members[i].type");
        department = jResp.stringOf("members[i].department");
        i = i + 1;
    }
    }

Curl Command

curl -G -d "page_count=quis%20officia%20in%20reprehenderit"
	-d "page_number=1"
	-d "next_page_token=quis%20officia%20in%20reprehenderit"
	-d "page_size=30"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/roles/:roleId/members

Postman Collection Item JSON

{
  "name": "List members in a role",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/roles/:roleId/members?page_count=quis officia in reprehenderit&page_number=1&next_page_token=quis officia in reprehenderit&page_size=30",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "roles",
        ":roleId",
        "members"
      ],
      "query": [
        {
          "key": "page_count",
          "value": "quis officia in reprehenderit",
          "description": "The number of pages returned for this request."
        },
        {
          "key": "page_number",
          "value": "1",
          "description": "**Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination."
        },
        {
          "key": "next_page_token",
          "value": "quis officia in reprehenderit",
          "description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
        },
        {
          "key": "page_size",
          "value": "30",
          "description": "The number of records returned within a single API call."
        }
      ],
      "variable": [
        {
          "key": "roleId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The role ID"
        }
      ]
    },
    "description": "User [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to list all the members that are assigned a specific role.\n\n**Scope:** `role:read:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br>**Prerequisites:**<br>\n* A Pro or a higher plan."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nSuccess",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/roles/:roleId/members?page_count=quis officia in reprehenderit&page_number=1&next_page_token=quis officia in reprehenderit&page_size=30",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "roles",
            ":roleId",
            "members"
          ],
          "query": [
            {
              "key": "page_count",
              "value": "quis officia in reprehenderit"
            },
            {
              "key": "page_number",
              "value": "1"
            },
            {
              "key": "next_page_token",
              "value": "quis officia in reprehenderit"
            },
            {
              "key": "page_size",
              "value": "30"
            }
          ],
          "variable": [
            {
              "key": "roleId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The role ID"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"page_count\": 1,\n \"page_number\": 1,\n \"page_size\": 30,\n \"total_records\": 1,\n \"members\": [\n  {\n   \"id\": \"zadksadjBBBBBBB8uQ\",\n   \"email\": \"example@example.com\",\n   \"first_name\": \"Taylor\",\n   \"last_name\": \"Gomez\",\n   \"type\": 2,\n   \"department\": \"Chemistry\"\n  }\n ]\n}"
    },
    {
      "name": "**HTTP Status Code:** `404`<br>Role not found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/roles/:roleId/members?page_count=quis officia in reprehenderit&page_number=1&next_page_token=quis officia in reprehenderit&page_size=30",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "roles",
            ":roleId",
            "members"
          ],
          "query": [
            {
              "key": "page_count",
              "value": "quis officia in reprehenderit"
            },
            {
              "key": "page_number",
              "value": "1"
            },
            {
              "key": "next_page_token",
              "value": "quis officia in reprehenderit"
            },
            {
              "key": "page_size",
              "value": "30"
            }
          ],
          "variable": [
            {
              "key": "roleId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The role ID"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}