PureBasic / Squadcast API V3 / Get All On-call Events
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"currentDate","")
CkJsonObject::ckUpdateInt(queryParams,"daysBefore",4)
CkJsonObject::ckUpdateInt(queryParams,"daysAfter",5)
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.squadcast.com/v3/schedules/:schedulesID/events",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
id.s
start_time.s
end_time.s
name.s
series_id.s
is_override.i
schedule_id.s
Id.s
Name.s
Slug.s
j.i
count_j.i
strVal.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"data[i].id")
start_time = CkJsonObject::ckStringOf(jResp,"data[i].start_time")
end_time = CkJsonObject::ckStringOf(jResp,"data[i].end_time")
name = CkJsonObject::ckStringOf(jResp,"data[i].name")
series_id = CkJsonObject::ckStringOf(jResp,"data[i].series_id")
is_override = CkJsonObject::ckBoolOf(jResp,"data[i].is_override")
schedule_id = CkJsonObject::ckStringOf(jResp,"data[i].schedule_id")
Id = CkJsonObject::ckStringOf(jResp,"data[i].calendar.id")
Name = CkJsonObject::ckStringOf(jResp,"data[i].calendar.name")
Slug = CkJsonObject::ckStringOf(jResp,"data[i].calendar.slug")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"data[i].user_ids")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"data[i].user_ids[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"data[i].squad_ids")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}