Chilkat Online Tools

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

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
first_name: PWideChar;
last_name: PWideChar;
email: PWideChar;
Dial_code: PWideChar;
Phone_number: PWideChar;
Shift_type: PWideChar;
i: Integer;
count_i: Integer;

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

http := CkHttp_Create();

// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://api.squadcast.com/v3/schedules/:schedulesID/on-call',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

Shift_type := CkJsonObject__stringOf(jResp,'data.shift_type');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'data.users');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    id := CkJsonObject__stringOf(jResp,'data.users[i].id');
    first_name := CkJsonObject__stringOf(jResp,'data.users[i].first_name');
    last_name := CkJsonObject__stringOf(jResp,'data.users[i].last_name');
    email := CkJsonObject__stringOf(jResp,'data.users[i].email');
    Dial_code := CkJsonObject__stringOf(jResp,'data.users[i].contact.dial_code');
    Phone_number := CkJsonObject__stringOf(jResp,'data.users[i].contact.phone_number');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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