Chilkat Online Tools

Node.js / Squadcast API V3 / Get All On-call Events

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    var queryParams = new chilkat.JsonObject();
    queryParams.UpdateString("currentDate","");
    queryParams.UpdateInt("daysBefore",4);
    queryParams.UpdateInt("daysAfter",5);

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

    // resp: HttpResponse
    var resp = http.QuickRequestParams("GET","https://api.squadcast.com/v3/schedules/:schedulesID/events",queryParams);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    var sbResponseBody = new chilkat.StringBuilder();
    resp.GetBodySb(sbResponseBody);

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = resp.StatusCode;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(resp.Header);
        console.log("Failed.");

        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "data": [
    //     {
    //       "id": "5ecf89b4ebddeae2907cd44b",
    //       "start_time": "2020-05-29T18:30:00Z",
    //       "end_time": "2020-05-29T18:30:00Z",
    //       "name": "SRE shift 1",
    //       "user_ids": [
    //         "5d90cc3a4d031497494f07e6"
    //       ],
    //       "series_id": "5ecf89b4ebddeae2907cd423",
    //       "squad_ids": [
    //       ],
    //       "is_override": false,
    //       "schedule_id": "5ecf7176f92f2e731262b852",
    //       "calendar": {
    //         "id": "5ecf7176f92f2e731262b852",
    //         "name": "Weekly schedule",
    //         "slug": "weekly-schedule"
    //       }
    //     },
    //     {
    //       "id": "5ecf89b4ebddeae2907cd44c",
    //       "start_time": "2020-05-30T18:30:00Z",
    //       "end_time": "2020-05-30T18:30:00Z",
    //       "name": "SRE shift 1",
    //       "user_ids": [
    //         "5d81d9187000fb6b9def7e31"
    //       ],
    //       "series_id": "5ecf89b4ebddeae2907cd423",
    //       "squad_ids": [
    //       ],
    //       "is_override": false,
    //       "schedule_id": "5ecf7176f92f2e731262b852",
    //       "calendar": {
    //         "id": "5ecf7176f92f2e731262b852",
    //         "name": "Weekly schedule",
    //         "slug": "weekly-schedule"
    //       }
    //     }
    //   ]
    // }

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

    var id;
    var start_time;
    var end_time;
    var name;
    var series_id;
    var is_override;
    var schedule_id;
    var Id;
    var Name;
    var Slug;
    var j;
    var count_j;
    var strVal;

    var i = 0;
    var count_i = jResp.SizeOfArray("data");
    while (i < count_i) {
        jResp.I = i;
        id = jResp.StringOf("data[i].id");
        start_time = jResp.StringOf("data[i].start_time");
        end_time = jResp.StringOf("data[i].end_time");
        name = jResp.StringOf("data[i].name");
        series_id = jResp.StringOf("data[i].series_id");
        is_override = jResp.BoolOf("data[i].is_override");
        schedule_id = jResp.StringOf("data[i].schedule_id");
        Id = jResp.StringOf("data[i].calendar.id");
        Name = jResp.StringOf("data[i].calendar.name");
        Slug = jResp.StringOf("data[i].calendar.slug");
        j = 0;
        count_j = jResp.SizeOfArray("data[i].user_ids");
        while (j < count_j) {
            jResp.J = j;
            strVal = jResp.StringOf("data[i].user_ids[j]");
            j = j+1;
        }

        j = 0;
        count_j = jResp.SizeOfArray("data[i].squad_ids");
        while (j < count_j) {
            jResp.J = j;
            j = j+1;
        }

        i = i+1;
    }


}

chilkatExample();

Curl Command

curl -G -d "currentDate=%22%22"
	-d "daysBefore=4"
	-d "daysAfter=5"
	-H "Authorization: Bearer <access_token>"
https://api.squadcast.com/v3/schedules/:schedulesID/events

Postman Collection Item JSON

{
  "name": "Get All On-call Events",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/schedules/:schedulesID/events?currentDate=\"\"&daysBefore=4&daysAfter=5",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "schedules",
        ":schedulesID",
        "events"
      ],
      "query": [
        {
          "key": "currentDate",
          "value": "\"\""
        },
        {
          "key": "daysBefore",
          "value": "4"
        },
        {
          "key": "daysAfter",
          "value": "5"
        }
      ],
      "variable": [
        {
          "key": "schedulesID",
          "value": "5ecf7176f92f2e731262b852",
          "type": "string"
        }
      ]
    },
    "description": "This endpoint is used to get all the on-call rotations(event) for the schedule.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `schedule-read` scope.\n\n\nQuery Params:\n```\ncurrentDate (optional, default time.now) - from which time to fetch all the events\ndaysBefore (optional, default 15, max 42 days) - from how many days before the currentDate \ndaysAfter (optional, default 30, max 42 days) - from how many days after the currentDate events to be fetched\n\n```"
  },
  "response": [
    {
      "name": "200 OK",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/schedules/:schedulesID/events?currentDate=\"\"&daysBefore=4&daysAfter=5",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "schedules",
            ":schedulesID",
            "events"
          ],
          "query": [
            {
              "key": "currentDate",
              "value": "\"\""
            },
            {
              "key": "daysBefore",
              "value": "4"
            },
            {
              "key": "daysAfter",
              "value": "5"
            }
          ],
          "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 10:13:53 GMT"
        },
        {
          "key": "Content-Length",
          "value": "801"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"data\": [\n        {\n            \"id\": \"5ecf89b4ebddeae2907cd44b\",\n            \"start_time\": \"2020-05-29T18:30:00Z\",\n            \"end_time\": \"2020-05-29T18:30:00Z\",\n            \"name\": \"SRE shift 1\",\n            \"user_ids\": [\n                \"5d90cc3a4d031497494f07e6\"\n            ],\n            \"series_id\": \"5ecf89b4ebddeae2907cd423\",\n            \"squad_ids\": [],\n            \"is_override\": false,\n            \"schedule_id\": \"5ecf7176f92f2e731262b852\",\n            \"calendar\": {\n                \"id\": \"5ecf7176f92f2e731262b852\",\n                \"name\": \"Weekly schedule\",\n                \"slug\": \"weekly-schedule\"\n            }\n        },\n        {\n            \"id\": \"5ecf89b4ebddeae2907cd44c\",\n            \"start_time\": \"2020-05-30T18:30:00Z\",\n            \"end_time\": \"2020-05-30T18:30:00Z\",\n            \"name\": \"SRE shift 1\",\n            \"user_ids\": [\n                \"5d81d9187000fb6b9def7e31\"\n            ],\n            \"series_id\": \"5ecf89b4ebddeae2907cd423\",\n            \"squad_ids\": [],\n            \"is_override\": false,\n            \"schedule_id\": \"5ecf7176f92f2e731262b852\",\n            \"calendar\": {\n                \"id\": \"5ecf7176f92f2e731262b852\",\n                \"name\": \"Weekly schedule\",\n                \"slug\": \"weekly-schedule\"\n            }\n        }\n    ]\n}"
    }
  ]
}