SQL Server / Squadcast API V3 / Get All Schedules
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', @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": "5ecf7176f92f2e731262b852",
-- "name": "Weekly schedule",
-- "slug": "weekly-schedule",
-- "organization_id": "5d81d9187000fb6b9def7e32",
-- "colour": "#0f61dd",
-- "description": "This schedule repeats weekly",
-- "organization": {
-- "id": "5d81d9187000fb6b9def7e32",
-- "name": "GopherHut",
-- "slug": "gopherhut"
-- }
-- },
-- {
-- "id": "5ecf73fbf92f2e731262b853",
-- "name": "Daily schedule",
-- "slug": "daily-schedule",
-- "organization_id": "5d81d9187000fb6b9def7e32",
-- "colour": "#0f61dd",
-- "description": "This schedule repeats daily",
-- "organization": {
-- "id": "5d81d9187000fb6b9def7e32",
-- "name": "GopherHut",
-- "slug": "gopherhut"
-- }
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @id nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @slug nvarchar(4000)
DECLARE @organization_id nvarchar(4000)
DECLARE @colour nvarchar(4000)
DECLARE @description nvarchar(4000)
DECLARE @Id nvarchar(4000)
DECLARE @Name nvarchar(4000)
DECLARE @Slug nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'data[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'data[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @slug OUT, 'data[i].slug'
EXEC sp_OAMethod @jResp, 'StringOf', @organization_id OUT, 'data[i].organization_id'
EXEC sp_OAMethod @jResp, 'StringOf', @colour OUT, 'data[i].colour'
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'data[i].description'
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'data[i].organization.id'
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'data[i].organization.name'
EXEC sp_OAMethod @jResp, 'StringOf', @Slug OUT, 'data[i].organization.slug'
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
Postman Collection Item JSON
{
"name": "Get All Schedules",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/schedules",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules"
]
},
"description": "This endpoint is used to get all the created schedules for the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `schedule-read` scope."
},
"response": [
{
"name": "200 - Schedules response",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/schedules",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules"
]
}
},
"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 08:21:04 GMT"
},
{
"key": "Content-Length",
"value": "568"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"id\": \"5ecf7176f92f2e731262b852\",\n \"name\": \"Weekly schedule\",\n \"slug\": \"weekly-schedule\",\n \"organization_id\": \"5d81d9187000fb6b9def7e32\",\n \"colour\": \"#0f61dd\",\n \"description\": \"This schedule repeats weekly\",\n \"organization\": {\n \"id\": \"5d81d9187000fb6b9def7e32\",\n \"name\": \"GopherHut\",\n \"slug\": \"gopherhut\"\n }\n },\n {\n \"id\": \"5ecf73fbf92f2e731262b853\",\n \"name\": \"Daily schedule\",\n \"slug\": \"daily-schedule\",\n \"organization_id\": \"5d81d9187000fb6b9def7e32\",\n \"colour\": \"#0f61dd\",\n \"description\": \"This schedule repeats daily\",\n \"organization\": {\n \"id\": \"5d81d9187000fb6b9def7e32\",\n \"name\": \"GopherHut\",\n \"slug\": \"gopherhut\"\n }\n }\n ]\n}"
},
{
"name": "401 Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/schedules",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "Date",
"value": "Thu, 28 May 2020 08:21:04 GMT"
},
{
"key": "Content-Length",
"value": "568"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 401,\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "403 - Forbidden",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/schedules",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "Date",
"value": "Thu, 28 May 2020 08:21:04 GMT"
},
{
"key": "Content-Length",
"value": "568"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 403,\n \"error_message\": \"<string>\"\n }\n}"
}
]
}
