Chilkat Online Tools

PowerBuilder / Squadcast API V3 / Get All Schedules

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_Name
string ls_Slug
string ls_Organization_id
string ls_Colour
string ls_Description
string ls_Id
string ls_Name
string ls_Slug
integer i
integer li_Count_i

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://api.squadcast.com/v3/schedules",loo_SbResponseBody)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponseBody
    return
end if

loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Http.LastHeader
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

// 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

i = 0
li_Count_i = loo_JResp.SizeOfArray("data")
do while i < li_Count_i
    loo_JResp.I = i
    ls_Id = loo_JResp.StringOf("data[i].id")
    ls_Name = loo_JResp.StringOf("data[i].name")
    ls_Slug = loo_JResp.StringOf("data[i].slug")
    ls_Organization_id = loo_JResp.StringOf("data[i].organization_id")
    ls_Colour = loo_JResp.StringOf("data[i].colour")
    ls_Description = loo_JResp.StringOf("data[i].description")
    ls_Id = loo_JResp.StringOf("data[i].organization.id")
    ls_Name = loo_JResp.StringOf("data[i].organization.name")
    ls_Slug = loo_JResp.StringOf("data[i].organization.slug")
    i = i + 1
loop


destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp

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