Chilkat Online Tools

Foxpro / Squadcast API V3 / Get Who Is On-Call

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcFirst_name
LOCAL lcLast_name
LOCAL lcEmail
LOCAL lcDial_code
LOCAL lcPhone_number
LOCAL lcShift_type
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.squadcast.com/v3/schedules/:schedulesID/on-call",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.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": {
*     "shift_type": "Normal Shift",
*     "users": [
*       {
*         "id": "5db927bbf8d4da1473169537",
*         "first_name": "Tony",
*         "last_name": "Stark",
*         "email": "tony@squadcast.com",
*         "contact": {
*           "dial_code": "+91",
*           "phone_number": "9578628779"
*         }
*       }
*     ]
*   }
* }

* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

lcShift_type = loJResp.StringOf("data.shift_type")
i = 0
lnCount_i = loJResp.SizeOfArray("data.users")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("data.users[i].id")
    lcFirst_name = loJResp.StringOf("data.users[i].first_name")
    lcLast_name = loJResp.StringOf("data.users[i].last_name")
    lcEmail = loJResp.StringOf("data.users[i].email")
    lcDial_code = loJResp.StringOf("data.users[i].contact.dial_code")
    lcPhone_number = loJResp.StringOf("data.users[i].contact.phone_number")
    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/:schedulesID/on-call

Postman Collection Item JSON

{
  "name": "Get Who Is On-Call",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/schedules/:schedulesID/on-call",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "schedules",
        ":schedulesID",
        "on-call"
      ],
      "variable": [
        {
          "key": "schedulesID",
          "value": "5ecf7176f92f2e731262b852",
          "type": "string"
        }
      ]
    },
    "description": "This endpoint is used to get all the on-call users of the schedule.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `schedule-read` scope."
  },
  "response": [
    {
      "name": "200 OK",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/schedules/:schedulesID/on-call",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "schedules",
            ":schedulesID",
            "on-call"
          ],
          "variable": [
            {
              "key": "schedulesID",
              "value": "5ecf7176f92f2e731262b852"
            }
          ]
        }
      },
      "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:18:21 GMT"
        },
        {
          "key": "Content-Length",
          "value": "50"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"data\": {\n        \"shift_type\": \"Normal Shift\",\n        \"users\": [\n            {\n                \"id\": \"5db927bbf8d4da1473169537\",\n                \"first_name\": \"Tony\",\n                \"last_name\": \"Stark\",\n                \"email\": \"tony@squadcast.com\",\n                \"contact\": {\n                    \"dial_code\": \"+91\",\n                    \"phone_number\": \"9578628779\"\n                }\n            }\n        ]\n    }\n}"
    },
    {
      "name": "401 Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/schedules/:schedulesID/on-call",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "schedules",
            ":schedulesID",
            "on-call"
          ],
          "variable": [
            {
              "key": "schedulesID",
              "value": "5ecf7176f92f2e731262b852"
            }
          ]
        }
      },
      "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:18:21 GMT"
        },
        {
          "key": "Content-Length",
          "value": "50"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"meta\": {\n        \"status\": 401,\n        \"error_message\": \"<string>\"\n    }\n}"
    }
  ]
}