Chilkat Online Tools

Powershell / Squadcast API V3 / Get All Schedules

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",$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": "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
$count_i = $jResp.SizeOfArray("data")
while ($i -lt $count_i) {
    $jResp.I = $i
    $id = $jResp.StringOf("data[i].id")
    $name = $jResp.StringOf("data[i].name")
    $slug = $jResp.StringOf("data[i].slug")
    $organization_id = $jResp.StringOf("data[i].organization_id")
    $colour = $jResp.StringOf("data[i].colour")
    $description = $jResp.StringOf("data[i].description")
    $Id = $jResp.StringOf("data[i].organization.id")
    $Name = $jResp.StringOf("data[i].organization.name")
    $Slug = $jResp.StringOf("data[i].organization.slug")
    $i = $i + 1
}

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