Chilkat Online Tools

Objective-C / Squadcast API V3 / Get Schedule Gaps

Back to Collection Items

#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

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

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://api.squadcast.com/v3/schedules/gaps" sbContent: sbResponseBody];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",http.LastHeader);
    NSLog(@"%@",@"Failed.");
    return;
}

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

NSString *schedule_id = 0;
NSString *schedule_name = 0;
NSString *Start_time = 0;
NSString *End_time = 0;

int i = 0;
int count_i = [[jResp SizeOfArray: @"data"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: 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}"
    }
  ]
}