Chilkat Online Tools

Perl / Squadcast API V3 / Get Schedule Gaps

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

# Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken("<access_token>");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://api.squadcast.com/v3/schedules/gaps",$sbResponseBody);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $http->get_LastStatus();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $http->lastHeader() . "\r\n";
    print "Failed." . "\r\n";
    exit;
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "data": [
#     {
#       "schedule_id": "5ecf7176f92f2e731262b852",
#       "schedule_name": "Weekly schedule",
#       "gap": {
#         "start_time": "2020-05-05T18:29:59.999Z",
#         "end_time": "2020-05-06T18:30:00Z"
#       }
#     }
#   ]
# }

# 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) {
    $jResp->put_I($i);
    $schedule_id = $jResp->stringOf("data[i].schedule_id");
    $schedule_name = $jResp->stringOf("data[i].schedule_name");
    $Start_time = $jResp->stringOf("data[i].gap.start_time");
    $End_time = $jResp->stringOf("data[i].gap.end_time");
    $i = $i + 1;
}

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.squadcast.com/v3/schedules/gaps

Postman Collection Item JSON

{
  "name": "Get Schedule Gaps",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/schedules/gaps",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "schedules",
        "gaps"
      ]
    },
    "description": "This endpoint is used to check if there are any gaps in the schedules. This returns the first detected gap in the schedule.\n\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `schedule-read` scope."
  },
  "response": [
    {
      "name": "Get Schedule Gaps",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/schedules/gaps",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "schedules",
            "gaps"
          ]
        }
      },
      "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 09:24:37 GMT"
        },
        {
          "key": "Content-Length",
          "value": "12"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"data\": [\n        {\n            \"schedule_id\": \"5ecf7176f92f2e731262b852\",\n            \"schedule_name\": \"Weekly schedule\",\n            \"gap\": {\n                \"start_time\": \"2020-05-05T18:29:59.999Z\",\n                \"end_time\": \"2020-05-06T18:30:00Z\"\n            }\n        }\n    ]\n}"
    },
    {
      "name": "401 Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/schedules/gaps",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "schedules",
            "gaps"
          ]
        }
      },
      "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 09:24:37 GMT"
        },
        {
          "key": "Content-Length",
          "value": "12"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"meta\": {\n        \"status\": 401,\n        \"error_message\": \"<string>\"\n    }\n}"
    }
  ]
}