Chilkat Online Tools

Foxpro / Squadcast API V3 / Get On-call Event By ID

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcStrVal
LOCAL lcId
LOCAL lcStart_time
LOCAL lcEnd_time
LOCAL lcName
LOCAL lcSeries_id
LOCAL lnIs_override
LOCAL lcSchedule_id
LOCAL lcCalendarId
LOCAL lcCalendarName
LOCAL lcSlug
LOCAL i
LOCAL lnCount_i

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

loHttp = CreateObject('Chilkat_9_5_0.Http')

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.squadcast.com/v3/schedules/:schedulesID/events/:eventID",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
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"
*     }
*   }
* }

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

lcId = loJResp.StringOf("data.id")
lcStart_time = loJResp.StringOf("data.start_time")
lcEnd_time = loJResp.StringOf("data.end_time")
lcName = loJResp.StringOf("data.name")
lcSeries_id = loJResp.StringOf("data.series_id")
lnIs_override = loJResp.BoolOf("data.is_override")
lcSchedule_id = loJResp.StringOf("data.schedule_id")
lcCalendarId = loJResp.StringOf("data.calendar.id")
lcCalendarName = loJResp.StringOf("data.calendar.name")
lcSlug = loJResp.StringOf("data.calendar.slug")
i = 0
lnCount_i = loJResp.SizeOfArray("data.user_ids")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("data.user_ids[i]")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("data.squad_ids")
DO WHILE i < lnCount_i
    loJResp.I = i
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get On-call Event By ID",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/schedules/:schedulesID/events/:eventID",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "schedules",
        ":schedulesID",
        "events",
        ":eventID"
      ],
      "variable": [
        {
          "key": "schedulesID",
          "value": "5ecf7176f92f2e731262b852",
          "type": "string"
        },
        {
          "key": "eventID",
          "value": "5ecf89b4ebddeae2907cd44b",
          "type": "string"
        }
      ]
    },
    "description": "This endpoint is used to get the on-call rotation(event) details by event id.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `schedule-read` scope."
  },
  "response": [
    {
      "name": "200 OK",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/schedules/:schedulesID/events/:eventID",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "schedules",
            ":schedulesID",
            "events",
            ":eventID"
          ],
          "variable": [
            {
              "key": "schedulesID",
              "value": "5ecf7176f92f2e731262b852"
            },
            {
              "key": "eventID",
              "value": "5ecf89b4ebddeae2907cd44b"
            }
          ]
        }
      },
      "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:16:57 GMT"
        },
        {
          "key": "Content-Length",
          "value": "404"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"data\": {\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}"
    }
  ]
}