autoit / Squadcast API V3 / Get All On-call Events
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
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("currentDate","")
$oQueryParams.UpdateInt("daysBefore",4)
$oQueryParams.UpdateInt("daysAfter",5)
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api.squadcast.com/v3/schedules/:schedulesID/events",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": [
; {
; "id": "5ecf89b4ebddeae2907cd44b",
; "start_time": "2020-05-29T18:30:00Z",
; "end_time": "2020-05-29T18:30:00Z",
; "name": "SRE shift 1",
; "user_ids": [
; "5d90cc3a4d031497494f07e6"
; ],
; "series_id": "5ecf89b4ebddeae2907cd423",
; "squad_ids": [
; ],
; "is_override": false,
; "schedule_id": "5ecf7176f92f2e731262b852",
; "calendar": {
; "id": "5ecf7176f92f2e731262b852",
; "name": "Weekly schedule",
; "slug": "weekly-schedule"
; }
; },
; {
; "id": "5ecf89b4ebddeae2907cd44c",
; "start_time": "2020-05-30T18:30:00Z",
; "end_time": "2020-05-30T18:30:00Z",
; "name": "SRE shift 1",
; "user_ids": [
; "5d81d9187000fb6b9def7e31"
; ],
; "series_id": "5ecf89b4ebddeae2907cd423",
; "squad_ids": [
; ],
; "is_override": false,
; "schedule_id": "5ecf7176f92f2e731262b852",
; "calendar": {
; "id": "5ecf7176f92f2e731262b852",
; "name": "Weekly schedule",
; "slug": "weekly-schedule"
; }
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sId
Local $start_time
Local $sEnd_time
Local $sName
Local $series_id
Local $bIs_override
Local $schedule_id
Local $sId
Local $sName
Local $sSlug
Local $iJ
Local $iCount_j
Local $strVal
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("data[i].id")
$start_time = $oJResp.StringOf("data[i].start_time")
$sEnd_time = $oJResp.StringOf("data[i].end_time")
$sName = $oJResp.StringOf("data[i].name")
$series_id = $oJResp.StringOf("data[i].series_id")
$bIs_override = $oJResp.BoolOf("data[i].is_override")
$schedule_id = $oJResp.StringOf("data[i].schedule_id")
$sId = $oJResp.StringOf("data[i].calendar.id")
$sName = $oJResp.StringOf("data[i].calendar.name")
$sSlug = $oJResp.StringOf("data[i].calendar.slug")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].user_ids")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("data[i].user_ids[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].squad_ids")
While $iJ < $iCount_j
$oJResp.J = $iJ
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
Curl Command
curl -G -d "currentDate=%22%22"
-d "daysBefore=4"
-d "daysAfter=5"
-H "Authorization: Bearer <access_token>"
https://api.squadcast.com/v3/schedules/:schedulesID/events
Postman Collection Item JSON
{
"name": "Get All On-call Events",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/schedules/:schedulesID/events?currentDate=\"\"&daysBefore=4&daysAfter=5",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules",
":schedulesID",
"events"
],
"query": [
{
"key": "currentDate",
"value": "\"\""
},
{
"key": "daysBefore",
"value": "4"
},
{
"key": "daysAfter",
"value": "5"
}
],
"variable": [
{
"key": "schedulesID",
"value": "5ecf7176f92f2e731262b852",
"type": "string"
}
]
},
"description": "This endpoint is used to get all the on-call rotations(event) for the schedule.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `schedule-read` scope.\n\n\nQuery Params:\n```\ncurrentDate (optional, default time.now) - from which time to fetch all the events\ndaysBefore (optional, default 15, max 42 days) - from how many days before the currentDate \ndaysAfter (optional, default 30, max 42 days) - from how many days after the currentDate events to be fetched\n\n```"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/schedules/:schedulesID/events?currentDate=\"\"&daysBefore=4&daysAfter=5",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules",
":schedulesID",
"events"
],
"query": [
{
"key": "currentDate",
"value": "\"\""
},
{
"key": "daysBefore",
"value": "4"
},
{
"key": "daysAfter",
"value": "5"
}
],
"variable": [
{
"key": "schedulesID",
"value": "5ecf7176f92f2e731262b852"
}
]
}
},
"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 10:13:53 GMT"
},
{
"key": "Content-Length",
"value": "801"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"id\": \"5ecf89b4ebddeae2907cd44b\",\n \"start_time\": \"2020-05-29T18:30:00Z\",\n \"end_time\": \"2020-05-29T18:30:00Z\",\n \"name\": \"SRE shift 1\",\n \"user_ids\": [\n \"5d90cc3a4d031497494f07e6\"\n ],\n \"series_id\": \"5ecf89b4ebddeae2907cd423\",\n \"squad_ids\": [],\n \"is_override\": false,\n \"schedule_id\": \"5ecf7176f92f2e731262b852\",\n \"calendar\": {\n \"id\": \"5ecf7176f92f2e731262b852\",\n \"name\": \"Weekly schedule\",\n \"slug\": \"weekly-schedule\"\n }\n },\n {\n \"id\": \"5ecf89b4ebddeae2907cd44c\",\n \"start_time\": \"2020-05-30T18:30:00Z\",\n \"end_time\": \"2020-05-30T18:30:00Z\",\n \"name\": \"SRE shift 1\",\n \"user_ids\": [\n \"5d81d9187000fb6b9def7e31\"\n ],\n \"series_id\": \"5ecf89b4ebddeae2907cd423\",\n \"squad_ids\": [],\n \"is_override\": false,\n \"schedule_id\": \"5ecf7176f92f2e731262b852\",\n \"calendar\": {\n \"id\": \"5ecf7176f92f2e731262b852\",\n \"name\": \"Weekly schedule\",\n \"slug\": \"weekly-schedule\"\n }\n }\n ]\n}"
}
]
}
