PowerBuilder / Zoom API / Get top 25 Zoom Rooms with issues
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_Room_name
integer li_Issues_count
string ls_From
string ls_V_to
integer li_Total_records
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("from","1989-05-07")
loo_QueryParams.UpdateString("to","1989-05-07")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Resp = loo_Http.QuickRequestParams("GET","https://api.zoom.us/v2/metrics/issues/zoomrooms",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "from": "2019-05-22",
// "to": "1958-10-24",
// "total_records": -12352697,
// "zoom_rooms": [
// {
// "id": "culpa Ut",
// "room_name": "nisi dolor amet eiusmod",
// "issues_count": -15865999
// },
// {
// "id": "ipsum exercitation minim dolor",
// "room_name": "veniam pariatur laboris qui",
// "issues_count": 11887943
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_From = loo_JResp.StringOf("from")
ls_V_to = loo_JResp.StringOf("to")
li_Total_records = loo_JResp.IntOf("total_records")
i = 0
li_Count_i = loo_JResp.SizeOfArray("zoom_rooms")
do while i < li_Count_i
loo_JResp.I = i
ls_Id = loo_JResp.StringOf("zoom_rooms[i].id")
ls_Room_name = loo_JResp.StringOf("zoom_rooms[i].room_name")
li_Issues_count = loo_JResp.IntOf("zoom_rooms[i].issues_count")
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -G -d "from=1989-05-07"
-d "to=1989-05-07"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/metrics/issues/zoomrooms
Postman Collection Item JSON
{
"name": "Get top 25 Zoom Rooms with issues",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/metrics/issues/zoomrooms?from=1989-05-07&to=1989-05-07",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"issues",
"zoomrooms"
],
"query": [
{
"key": "from",
"value": "1989-05-07",
"description": "(Required) Start date in 'yyyy-mm-dd' format. The date range defined by the \"from\" and \"to\" parameters should only be one month as the report includes only one month worth of data at once."
},
{
"key": "to",
"value": "1989-05-07",
"description": "(Required) End date."
}
]
},
"description": "Get information on top 25 Zoom Rooms with issues in a month. The month specified with the \"from\" and \"to\" range should fall within the last six months.<br>\n**Scope:** `dashboard_home:read:admin`<br>\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>\n**Prerequisites:**<br>\n* Business or a higher plan.\n* Zoom Room must be enabled in the account."
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nZoom Room with issue details returned",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/metrics/issues/zoomrooms?from=1989-05-07&to=1989-05-07",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"issues",
"zoomrooms"
],
"query": [
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"from\": \"2019-05-22\",\n \"to\": \"1958-10-24\",\n \"total_records\": -12352697,\n \"zoom_rooms\": [\n {\n \"id\": \"culpa Ut\",\n \"room_name\": \"nisi dolor amet eiusmod\",\n \"issues_count\": -15865999\n },\n {\n \"id\": \"ipsum exercitation minim dolor\",\n \"room_name\": \"veniam pariatur laboris qui\",\n \"issues_count\": 11887943\n }\n ]\n}"
}
]
}
