Chilkat Online Tools

Xojo / Zoom API / Get location settings

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateString("setting_type","meeting")

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/rooms/locations/:locationId/settings",queryParams)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

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

// {
//   "client_alert": {
//     "detect_microphone_error_alert": true,
//     "detect_bluetooth_microphone_error_alert": true,
//     "detect_speaker_error_alert": true,
//     "detect_bluetooth_speaker_error_alert": true,
//     "detect_camera_error_alert": true
//   },
//   "notification": {
//     "audio_not_meet_usability_threshold": false,
//     "battery_low_and_not_charging": false,
//     "controller_scheduling_disconnected": false,
//     "cpu_usage_high_detected": false,
//     "network_unstable_detected": false,
//     "zoom_room_offline": false,
//     "sip_registration_failed": false,
//     "mic_speaker_camera_disconnected": false,
//     "zoom_room_display_disconnected": false
//   }
// }

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

Dim Detect_microphone_error_alert As Boolean
Detect_microphone_error_alert = jResp.BoolOf("client_alert.detect_microphone_error_alert")
Dim Detect_bluetooth_microphone_error_alert As Boolean
Detect_bluetooth_microphone_error_alert = jResp.BoolOf("client_alert.detect_bluetooth_microphone_error_alert")
Dim Detect_speaker_error_alert As Boolean
Detect_speaker_error_alert = jResp.BoolOf("client_alert.detect_speaker_error_alert")
Dim Detect_bluetooth_speaker_error_alert As Boolean
Detect_bluetooth_speaker_error_alert = jResp.BoolOf("client_alert.detect_bluetooth_speaker_error_alert")
Dim Detect_camera_error_alert As Boolean
Detect_camera_error_alert = jResp.BoolOf("client_alert.detect_camera_error_alert")
Dim Audio_not_meet_usability_threshold As Boolean
Audio_not_meet_usability_threshold = jResp.BoolOf("notification.audio_not_meet_usability_threshold")
Dim Battery_low_and_not_charging As Boolean
Battery_low_and_not_charging = jResp.BoolOf("notification.battery_low_and_not_charging")
Dim Controller_scheduling_disconnected As Boolean
Controller_scheduling_disconnected = jResp.BoolOf("notification.controller_scheduling_disconnected")
Dim Cpu_usage_high_detected As Boolean
Cpu_usage_high_detected = jResp.BoolOf("notification.cpu_usage_high_detected")
Dim Network_unstable_detected As Boolean
Network_unstable_detected = jResp.BoolOf("notification.network_unstable_detected")
Dim Zoom_room_offline As Boolean
Zoom_room_offline = jResp.BoolOf("notification.zoom_room_offline")
Dim Sip_registration_failed As Boolean
Sip_registration_failed = jResp.BoolOf("notification.sip_registration_failed")
Dim Mic_speaker_camera_disconnected As Boolean
Mic_speaker_camera_disconnected = jResp.BoolOf("notification.mic_speaker_camera_disconnected")
Dim Zoom_room_display_disconnected As Boolean
Zoom_room_display_disconnected = jResp.BoolOf("notification.zoom_room_display_disconnected")

Curl Command

curl -G -d "setting_type=meeting"
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/rooms/locations/:locationId/settings

Postman Collection Item JSON

{
  "name": "Get location settings",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/rooms/locations/:locationId/settings?setting_type=meeting",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "rooms",
        "locations",
        ":locationId",
        "settings"
      ],
      "query": [
        {
          "key": "setting_type",
          "value": "meeting",
          "description": "(Required) The type of setting that you would like to retrieve.<br> `alert`: Alert Settings applied on the Zoom Rooms Account.<br>\n`meeting`: Meeting settings of the Zoom Rooms Account.<br>\n`signage`: Digital signage settings of the Zoom Rooms Account."
        }
      ],
      "variable": [
        {
          "key": "locationId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response)."
        }
      ]
    },
    "description": "Get information on meeting or alert settings applied to Zoom Rooms located in a specific location. By default, only **Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.<br><br>\n**Prerequisites:**<br>\n* Zoom Room licenses\n* Owner or Admin privileges on the Zoom Account.<br>\n**Scopes:** `room:read:admin`<br> \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200` **OK**<br>\nZoom Room location settings returned successfully.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/rooms/locations/:locationId/settings?setting_type=meeting",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "rooms",
            "locations",
            ":locationId",
            "settings"
          ],
          "query": [
            {
              "key": "setting_type",
              "value": "meeting"
            }
          ],
          "variable": [
            {
              "key": "locationId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response)."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"client_alert\": {\n  \"detect_microphone_error_alert\": true,\n  \"detect_bluetooth_microphone_error_alert\": true,\n  \"detect_speaker_error_alert\": true,\n  \"detect_bluetooth_speaker_error_alert\": true,\n  \"detect_camera_error_alert\": true\n },\n \"notification\": {\n  \"audio_not_meet_usability_threshold\": false,\n  \"battery_low_and_not_charging\": false,\n  \"controller_scheduling_disconnected\": false,\n  \"cpu_usage_high_detected\": false,\n  \"network_unstable_detected\": false,\n  \"zoom_room_offline\": false,\n  \"sip_registration_failed\": false,\n  \"mic_speaker_camera_disconnected\": false,\n  \"zoom_room_display_disconnected\": false\n }\n}"
    },
    {
      "name": "**HTTP Status Code:** `400` **Bad Request**<br>\n\n**Error Code:** `200`<br>\nZoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAccess Restricted.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/rooms/locations/:locationId/settings?setting_type=meeting",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "rooms",
            "locations",
            ":locationId",
            "settings"
          ],
          "query": [
            {
              "key": "setting_type",
              "value": "meeting"
            }
          ],
          "variable": [
            {
              "key": "locationId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response)."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `404` **Not Found**<br>\n\n**Error Code:** `4801`<br>\nLocation not found: {locationId}\n\n",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/rooms/locations/:locationId/settings?setting_type=meeting",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "rooms",
            "locations",
            ":locationId",
            "settings"
          ],
          "query": [
            {
              "key": "setting_type",
              "value": "meeting"
            }
          ],
          "variable": [
            {
              "key": "locationId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response)."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}