Chilkat Online Tools

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

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

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

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://api.squadcast.com/v3/schedules/:schedulesID/events/:eventID",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    exit
}

# 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

$Id = $jResp.StringOf("data.id")
$Start_time = $jResp.StringOf("data.start_time")
$End_time = $jResp.StringOf("data.end_time")
$Name = $jResp.StringOf("data.name")
$Series_id = $jResp.StringOf("data.series_id")
$Is_override = $jResp.BoolOf("data.is_override")
$Schedule_id = $jResp.StringOf("data.schedule_id")
$CalendarId = $jResp.StringOf("data.calendar.id")
$CalendarName = $jResp.StringOf("data.calendar.name")
$Slug = $jResp.StringOf("data.calendar.slug")
$i = 0
$count_i = $jResp.SizeOfArray("data.user_ids")
while ($i -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("data.user_ids[i]")
    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("data.squad_ids")
while ($i -lt $count_i) {
    $jResp.I = $i
    $i = $i + 1
}

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