Chilkat Online Tools

delphiAx / Squadcast API V3 / Get All Schedules

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
id: WideString;
name: WideString;
slug: WideString;
organization_id: WideString;
colour: WideString;
description: WideString;
Id: WideString;
Name: WideString;
Slug: WideString;
i: Integer;
count_i: Integer;

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

http := TChilkatHttp.Create(Self);

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://api.squadcast.com/v3/schedules',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());

respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(http.LastHeader);
    Memo1.Lines.Add('Failed.');
    Exit;
  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

i := 0;
count_i := jResp.SizeOfArray('data');
while i < count_i do
  begin
    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;
  end;

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