Chilkat Online Tools

autoit / Squadcast API V3 / Get Schedule Gaps

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.squadcast.com/v3/schedules/gaps",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

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

; {
;   "data": [
;     {
;       "schedule_id": "5ecf7176f92f2e731262b852",
;       "schedule_name": "Weekly schedule",
;       "gap": {
;         "start_time": "2020-05-05T18:29:59.999Z",
;         "end_time": "2020-05-06T18:30:00Z"
;       }
;     }
;   ]
; }

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

Local $schedule_id
Local $schedule_name
Local $sStart_time
Local $sEnd_time

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data")
While $i < $iCount_i
    $oJResp.I = $i
    $schedule_id = $oJResp.StringOf("data[i].schedule_id")
    $schedule_name = $oJResp.StringOf("data[i].schedule_name")
    $sStart_time = $oJResp.StringOf("data[i].gap.start_time")
    $sEnd_time = $oJResp.StringOf("data[i].gap.end_time")
    $i = $i + 1
Wend

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.squadcast.com/v3/schedules/gaps

Postman Collection Item JSON

{
  "name": "Get Schedule Gaps",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/schedules/gaps",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "schedules",
        "gaps"
      ]
    },
    "description": "This endpoint is used to check if there are any gaps in the schedules. This returns the first detected gap in the schedule.\n\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `schedule-read` scope."
  },
  "response": [
    {
      "name": "Get Schedule Gaps",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/schedules/gaps",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "schedules",
            "gaps"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "Date",
          "value": "Thu, 28 May 2020 09:24:37 GMT"
        },
        {
          "key": "Content-Length",
          "value": "12"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"data\": [\n        {\n            \"schedule_id\": \"5ecf7176f92f2e731262b852\",\n            \"schedule_name\": \"Weekly schedule\",\n            \"gap\": {\n                \"start_time\": \"2020-05-05T18:29:59.999Z\",\n                \"end_time\": \"2020-05-06T18:30:00Z\"\n            }\n        }\n    ]\n}"
    },
    {
      "name": "401 Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/schedules/gaps",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "schedules",
            "gaps"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "Date",
          "value": "Thu, 28 May 2020 09:24:37 GMT"
        },
        {
          "key": "Content-Length",
          "value": "12"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"meta\": {\n        \"status\": 401,\n        \"error_message\": \"<string>\"\n    }\n}"
    }
  ]
}