Foxpro / Squadcast API V3 / Get All On-call Events
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcStart_time
LOCAL lcEnd_time
LOCAL lcName
LOCAL lcSeries_id
LOCAL lnIs_override
LOCAL lcSchedule_id
LOCAL lcId
LOCAL lcName
LOCAL lcSlug
LOCAL j
LOCAL lnCount_j
LOCAL lcStrVal
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("currentDate","")
loQueryParams.UpdateInt("daysBefore",4)
loQueryParams.UpdateInt("daysAfter",5)
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.QuickRequestParams("GET","https://api.squadcast.com/v3/schedules/:schedulesID/events",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
i = 0
lnCount_i = loJResp.SizeOfArray("data")
DO WHILE i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("data[i].id")
lcStart_time = loJResp.StringOf("data[i].start_time")
lcEnd_time = loJResp.StringOf("data[i].end_time")
lcName = loJResp.StringOf("data[i].name")
lcSeries_id = loJResp.StringOf("data[i].series_id")
lnIs_override = loJResp.BoolOf("data[i].is_override")
lcSchedule_id = loJResp.StringOf("data[i].schedule_id")
lcId = loJResp.StringOf("data[i].calendar.id")
lcName = loJResp.StringOf("data[i].calendar.name")
lcSlug = loJResp.StringOf("data[i].calendar.slug")
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].user_ids")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("data[i].user_ids[j]")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].squad_ids")
DO WHILE j < lnCount_j
loJResp.J = j
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
