Chilkat Online Tools

VB.NET / Squadcast API V3 / Get On-call Event By ID

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://api.squadcast.com/v3/schedules/:schedulesID/events/:eventID",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' 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



Dim strVal As String

Dim Id As String = jResp.StringOf("data.id")
Dim Start_time As String = jResp.StringOf("data.start_time")
Dim End_time As String = jResp.StringOf("data.end_time")
Dim Name As String = jResp.StringOf("data.name")
Dim Series_id As String = jResp.StringOf("data.series_id")
Dim Is_override As Boolean = jResp.BoolOf("data.is_override")
Dim Schedule_id As String = jResp.StringOf("data.schedule_id")
Dim CalendarId As String = jResp.StringOf("data.calendar.id")
Dim CalendarName As String = jResp.StringOf("data.calendar.name")
Dim Slug As String = jResp.StringOf("data.calendar.slug")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("data.user_ids")
While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("data.user_ids[i]")
    i = i + 1
End While
i = 0
count_i = jResp.SizeOfArray("data.squad_ids")
While i < count_i
    jResp.I = i
    i = i + 1
End While

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}"
    }
  ]
}