Chilkat Online Tools

unicodeC / Squadcast API V3 / Get All Schedules

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *id;
    const wchar_t *name;
    const wchar_t *slug;
    const wchar_t *organization_id;
    const wchar_t *colour;
    const wchar_t *description;
    const wchar_t *Id;
    const wchar_t *Name;
    const wchar_t *Slug;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

    // Adds the "Authorization: Bearer <access_token>" header.
    CkHttpW_putAuthToken(http,L"<access_token>");

    sbResponseBody = CkStringBuilderW_Create();
    success = CkHttpW_QuickGetSb(http,L"https://api.squadcast.com/v3/schedules",sbResponseBody);
    if (success == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpW_getLastStatus(http);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpW_lastHeader(http));
        wprintf(L"Failed.\n");
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"data");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        id = CkJsonObjectW_stringOf(jResp,L"data[i].id");
        name = CkJsonObjectW_stringOf(jResp,L"data[i].name");
        slug = CkJsonObjectW_stringOf(jResp,L"data[i].slug");
        organization_id = CkJsonObjectW_stringOf(jResp,L"data[i].organization_id");
        colour = CkJsonObjectW_stringOf(jResp,L"data[i].colour");
        description = CkJsonObjectW_stringOf(jResp,L"data[i].description");
        Id = CkJsonObjectW_stringOf(jResp,L"data[i].organization.id");
        Name = CkJsonObjectW_stringOf(jResp,L"data[i].organization.name");
        Slug = CkJsonObjectW_stringOf(jResp,L"data[i].organization.slug");
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(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}"
    }
  ]
}