Chilkat Online Tools

Foxpro / Squadcast API V3 / Get Schedule Gaps

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcSchedule_id
LOCAL lcSchedule_name
LOCAL lcStart_time
LOCAL lcEnd_time
LOCAL i
LOCAL lnCount_i

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

loHttp = CreateObject('Chilkat_9_5_0.Http')

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.squadcast.com/v3/schedules/gaps",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

* 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
lnCount_i = loJResp.SizeOfArray("data")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcSchedule_id = loJResp.StringOf("data[i].schedule_id")
    lcSchedule_name = loJResp.StringOf("data[i].schedule_name")
    lcStart_time = loJResp.StringOf("data[i].gap.start_time")
    lcEnd_time = loJResp.StringOf("data[i].gap.end_time")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

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