SQL Server / Squadcast API V3 / Get On-call Event By ID
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.squadcast.com/v3/schedules/:schedulesID/events/:eventID', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- 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
DECLARE @strVal nvarchar(4000)
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'data.id'
DECLARE @Start_time nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Start_time OUT, 'data.start_time'
DECLARE @End_time nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @End_time OUT, 'data.end_time'
DECLARE @Name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'data.name'
DECLARE @Series_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Series_id OUT, 'data.series_id'
DECLARE @Is_override int
EXEC sp_OAMethod @jResp, 'BoolOf', @Is_override OUT, 'data.is_override'
DECLARE @Schedule_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Schedule_id OUT, 'data.schedule_id'
DECLARE @CalendarId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CalendarId OUT, 'data.calendar.id'
DECLARE @CalendarName nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @CalendarName OUT, 'data.calendar.name'
DECLARE @Slug nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Slug OUT, 'data.calendar.slug'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data.user_ids'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'data.user_ids[i]'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data.squad_ids'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
