Chilkat Online Tools

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

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat_9_5_0.Http")
Local $bSuccess

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"

$oSbResponseBody = ObjCreate("Chilkat_9_5_0.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.squadcast.com/v3/schedules/:schedulesID/on-call",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat_9_5_0.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
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

Local $sId
Local $sFirst_name
Local $sLast_name
Local $sEmail
Local $sDial_code
Local $sPhone_number

Local $sShift_type = $oJResp.StringOf("data.shift_type")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data.users")
While $i < $iCount_i
    $oJResp.I = $i
    $sId = $oJResp.StringOf("data.users[i].id")
    $sFirst_name = $oJResp.StringOf("data.users[i].first_name")
    $sLast_name = $oJResp.StringOf("data.users[i].last_name")
    $sEmail = $oJResp.StringOf("data.users[i].email")
    $sDial_code = $oJResp.StringOf("data.users[i].contact.dial_code")
    $sPhone_number = $oJResp.StringOf("data.users[i].contact.phone_number")
    $i = $i + 1
Wend

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