Chilkat Online Tools

C++ / Squadcast API V3 / Create On-call Event

Back to Collection Items

#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>

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

    CkHttp http;
    bool success;

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "name": "SRE shift 1",
    //   "start_time": "2020-01-11T18:30:00.000Z",
    //   "end_time": "2020-01-11T18:30:00.000Z",
    //   "rotation_sets": [
    //     {
    //       "user_ids": [
    //         "5d81d9187000fb6b9def7e31"
    //       ],
    //       "squad_ids": [
    //       ]
    //     },
    //     {
    //       "user_ids": [
    //         "5d90cc3a4d031497494f07e6"
    //       ],
    //       "squad_ids": [
    //       ]
    //     }
    //   ],
    //   "config": {
    //     "timezone": {
    //       "name": "IST",
    //       "offset": -330
    //     },
    //     "is_forever": true,
    //     "until": "2020-01-09T14:38:06.658Z",
    //     "rotate": true,
    //     "repeat": true,
    //     "rotation_frequency": 1,
    //     "repetition": {
    //       "frequency": 1,
    //       "repeats_on": [
    //         0,
    //         6
    //       ],
    //       "type": "week"
    //     }
    //   }
    // }

    CkJsonObject json;
    json.UpdateString("name","SRE shift 1");
    json.UpdateString("start_time","2020-01-11T18:30:00.000Z");
    json.UpdateString("end_time","2020-01-11T18:30:00.000Z");
    json.UpdateString("rotation_sets[0].user_ids[0]","5d81d9187000fb6b9def7e31");
    json.UpdateNewArray("rotation_sets[0].squad_ids");
    json.UpdateString("rotation_sets[1].user_ids[0]","5d90cc3a4d031497494f07e6");
    json.UpdateNewArray("rotation_sets[1].squad_ids");
    json.UpdateString("config.timezone.name","IST");
    json.UpdateInt("config.timezone.offset",-330);
    json.UpdateBool("config.is_forever",true);
    json.UpdateString("config.until","2020-01-09T14:38:06.658Z");
    json.UpdateBool("config.rotate",true);
    json.UpdateBool("config.repeat",true);
    json.UpdateInt("config.rotation_frequency",1);
    json.UpdateInt("config.repetition.frequency",1);
    json.UpdateInt("config.repetition.repeats_on[0]",0);
    json.UpdateInt("config.repetition.repeats_on[1]",6);
    json.UpdateString("config.repetition.type","week");

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

    CkHttpResponse *resp = http.PostJson3("https://api.squadcast.com/v3/schedules/:schedulesID/events","application/json",json);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp->GetBodySb(sbResponseBody);

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp->get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp->header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        delete resp;
        return;
    }

    delete resp;

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

    // {
    //   "data": [
    //     {
    //       "id": "5ecf89b4ebddeae2907cd424",
    //       "start_time": "2020-01-12T00:00:00+05:30",
    //       "end_time": "2020-01-12T00:00:00+05:30",
    //       "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"
    //       }
    //     },
    //     {
    //       "id": "5ecf89b4ebddeae2907cd425",
    //       "start_time": "2020-01-18T00:00:00+05:30",
    //       "end_time": "2020-01-18T00:00:00+05:30",
    //       "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": "5ecf89b4ebddeae2907cd426",
    //       "start_time": "2020-01-19T00:00:00+05:30",
    //       "end_time": "2020-01-19T00:00:00+05:30",
    //       "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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *id = 0;
    const char *start_time = 0;
    const char *end_time = 0;
    const char *name = 0;
    const char *series_id = 0;
    bool is_override;
    const char *schedule_id = 0;
    const char *Id = 0;
    const char *Name = 0;
    const char *Slug = 0;
    int j;
    int count_j;
    const char *strVal = 0;

    int i = 0;
    int count_i = jResp.SizeOfArray("data");
    while (i < count_i) {
        jResp.put_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.put_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.put_J(j);
            j = j + 1;
        }

        i = i + 1;
    }
    }

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "name": "SRE shift 1",
    "start_time": "2020-01-11T18:30:00.000Z",
    "end_time": "2020-01-11T18:30:00.000Z",
    "rotation_sets": [
        {
            "user_ids": ["5d81d9187000fb6b9def7e31"],
            "squad_ids": []
        },
        {
            "user_ids": ["5d90cc3a4d031497494f07e6"],
            "squad_ids": []
        }
    ],
    "config": {
        "timezone": {
        	"name": "IST", 
        	"offset": -330
        },
        "is_forever": true,
        "until": "2020-01-09T14:38:06.658Z",
        "rotate": true,
        "repeat": true,
        "rotation_frequency": 1,
        "repetition": {
            "frequency": 1,
            "repeats_on": [
                0,
                6
            ],
            "type": "week"
        }
    }
}'
https://api.squadcast.com/v3/schedules/:schedulesID/events

Postman Collection Item JSON

{
  "name": "Create On-call Event",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"name\": \"SRE shift 1\",\n    \"start_time\": \"2020-01-11T18:30:00.000Z\",\n    \"end_time\": \"2020-01-11T18:30:00.000Z\",\n    \"rotation_sets\": [\n        {\n            \"user_ids\": [\"5d81d9187000fb6b9def7e31\"],\n            \"squad_ids\": []\n        },\n        {\n            \"user_ids\": [\"5d90cc3a4d031497494f07e6\"],\n            \"squad_ids\": []\n        }\n    ],\n    \"config\": {\n        \"timezone\": {\n        \t\"name\": \"IST\", \n        \t\"offset\": -330\n        },\n        \"is_forever\": true,\n        \"until\": \"2020-01-09T14:38:06.658Z\",\n        \"rotate\": true,\n        \"repeat\": true,\n        \"rotation_frequency\": 1,\n        \"repetition\": {\n            \"frequency\": 1,\n            \"repeats_on\": [\n                0,\n                6\n            ],\n            \"type\": \"week\"\n        }\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/schedules/:schedulesID/events",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "schedules",
        ":schedulesID",
        "events"
      ],
      "variable": [
        {
          "key": "schedulesID",
          "value": "5ecf7176f92f2e731262b852",
          "type": "string"
        }
      ]
    },
    "description": "This endpoint is used to create a new on-call rotation(event) for the schedule.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `schedule-write` scope.\n\n\nRepresentation of Weekly Repetition:\n```\n0 - Sunday\n1 - Monday\n2 - Tuesday\n3 - Wednesday\n4 - Thursday\n5 - Friday\n6 - Saturday\n```"
  },
  "response": [
    {
      "name": "400 Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"start_time\": \"2020-01-11T18:30:00.000Z\",\n    \"end_time\": \"2020-01-11T18:30:00.000Z\",\n    \"rotation_sets\": [\n        {\n            \"user_ids\": [\"5d81d9187000fb6b9def7e31\"],\n            \"squad_ids\": []\n        },\n        {\n            \"user_ids\": [\"5d90cc3a4d031497494f07e6\"],\n            \"squad_ids\": []\n        }\n    ],\n    \"config\": {\n        \"timezone\": {\n        \t\"name\": \"IST\", \n        \t\"offset\": -330\n        },\n        \"is_forever\": true,\n        \"until\": \"2020-01-09T14:38:06.658Z\",\n        \"rotate\": true,\n        \"repeat\": true,\n        \"rotation_frequency\": 1,\n        \"repetition\": {\n            \"frequency\": 1,\n            \"repeats_on\": [\n                0,\n                6\n            ],\n            \"type\": \"week\"\n        }\n    }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/schedules/:schedulesID/events",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "schedules",
            ":schedulesID",
            "events"
          ],
          "variable": [
            {
              "key": "schedulesID",
              "value": "5ecf7176f92f2e731262b852"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "Date",
          "value": "Thu, 28 May 2020 09:45:33 GMT"
        },
        {
          "key": "Content-Length",
          "value": "70"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"meta\": {\n        \"status\": 400,\n        \"error_message\": \"rotation frequency required\"\n    }\n}"
    },
    {
      "name": "500 Internal Server Error",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"start_time\": \"2020-01-11T18:30:00.000Z\",\n    \"end_time\": \"2020-01-11T18:30:00.000Z\",\n    \"rotation_sets\": [\n        {\n            \"user_ids\": [\"5d81d9187000fb6b9def7e31\"],\n            \"squad_ids\": []\n        },\n        {\n            \"user_ids\": [\"5d90cc3a4d031497494f07e6\"],\n            \"squad_ids\": []\n        }\n    ],\n    \"config\": {\n        \"timezone\": {\n        \t\"name\": \"IST\", \n        \t\"offset\": -330\n        },\n        \"is_forever\": true,\n        \"until\": \"2020-01-09T14:38:06.658Z\",\n        \"rotate\": true,\n        \"repeat\": true,\n        \"rotation_frequency\": 1,\n        \"repetition\": {\n            \"frequency\": 1,\n            \"repeats_on\": [\n                0,\n                6\n            ],\n            \"type\": \"week\"\n        }\n    }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/schedules/:schedulesID/events",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "schedules",
            ":schedulesID",
            "events"
          ],
          "variable": [
            {
              "key": "schedulesID",
              "value": "5ecf7176f92f2e731262b852"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "Date",
          "value": "Thu, 28 May 2020 09:46:01 GMT"
        },
        {
          "key": "Content-Length",
          "value": "63"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"meta\": {\n        \"status\": 500,\n        \"error_message\": \"Something went wrong\"\n    }\n}"
    },
    {
      "name": "201 Created",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"start_time\": \"2020-01-11T18:30:00.000Z\",\n    \"end_time\": \"2020-01-11T18:30:00.000Z\",\n    \"rotation_sets\": [\n        {\n            \"user_ids\": [\"5d81d9187000fb6b9def7e31\"],\n            \"squad_ids\": []\n        },\n        {\n            \"user_ids\": [\"5d90cc3a4d031497494f07e6\"],\n            \"squad_ids\": []\n        }\n    ],\n    \"config\": {\n        \"timezone\": {\n        \t\"name\": \"IST\", \n        \t\"offset\": -330\n        },\n        \"is_forever\": true,\n        \"until\": \"2020-01-09T14:38:06.658Z\",\n        \"rotate\": true,\n        \"repeat\": true,\n        \"rotation_frequency\": 1,\n        \"repetition\": {\n            \"frequency\": 1,\n            \"repeats_on\": [\n                0,\n                6\n            ],\n            \"type\": \"week\"\n        }\n    }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/schedules/:schedulesID/events",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "schedules",
            ":schedulesID",
            "events"
          ],
          "variable": [
            {
              "key": "schedulesID",
              "value": "5ecf7176f92f2e731262b852"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "Date",
          "value": "Thu, 28 May 2020 09:51:50 GMT"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"data\": [\n        {\n            \"id\": \"5ecf89b4ebddeae2907cd424\",\n            \"start_time\": \"2020-01-12T00:00:00+05:30\",\n            \"end_time\": \"2020-01-12T00:00:00+05:30\",\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            \"id\": \"5ecf89b4ebddeae2907cd425\",\n            \"start_time\": \"2020-01-18T00:00:00+05:30\",\n            \"end_time\": \"2020-01-18T00:00:00+05:30\",\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\": \"5ecf89b4ebddeae2907cd426\",\n            \"start_time\": \"2020-01-19T00:00:00+05:30\",\n            \"end_time\": \"2020-01-19T00:00:00+05:30\",\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}"
    }
  ]
}