unicodeC / Squadcast API V3 / Update On-call Event
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkStringBuilderW sbRequestBody;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *id;
const wchar_t *start_time;
const wchar_t *end_time;
const wchar_t *name;
const wchar_t *series_id;
BOOL is_override;
const wchar_t *schedule_id;
const wchar_t *Id;
const wchar_t *Name;
const wchar_t *Slug;
int j;
int count_j;
const wchar_t *strVal;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
// 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",
// "update_type": 1,
// "start_time": "2020-01-10T18:30:00.000Z",
// "end_time": "2020-01-10T18: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"
// }
// }
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"name",L"SRE shift 1");
CkJsonObjectW_UpdateInt(json,L"update_type",1);
CkJsonObjectW_UpdateString(json,L"start_time",L"2020-01-10T18:30:00.000Z");
CkJsonObjectW_UpdateString(json,L"end_time",L"2020-01-10T18:30:00.000Z");
CkJsonObjectW_UpdateString(json,L"rotation_sets[0].user_ids[0]",L"5d81d9187000fb6b9def7e31");
CkJsonObjectW_UpdateNewArray(json,L"rotation_sets[0].squad_ids");
CkJsonObjectW_UpdateString(json,L"rotation_sets[1].user_ids[0]",L"5d90cc3a4d031497494f07e6");
CkJsonObjectW_UpdateNewArray(json,L"rotation_sets[1].squad_ids");
CkJsonObjectW_UpdateString(json,L"config.timezone.name",L"IST");
CkJsonObjectW_UpdateInt(json,L"config.timezone.offset",-330);
CkJsonObjectW_UpdateBool(json,L"config.is_forever",TRUE);
CkJsonObjectW_UpdateString(json,L"config.until",L"2020-01-09T14:38:06.658Z");
CkJsonObjectW_UpdateBool(json,L"config.rotate",TRUE);
CkJsonObjectW_UpdateBool(json,L"config.repeat",TRUE);
CkJsonObjectW_UpdateInt(json,L"config.rotation_frequency",1);
CkJsonObjectW_UpdateInt(json,L"config.repetition.frequency",1);
CkJsonObjectW_UpdateInt(json,L"config.repetition.repeats_on[0]",0);
CkJsonObjectW_UpdateInt(json,L"config.repetition.repeats_on[1]",6);
CkJsonObjectW_UpdateString(json,L"config.repetition.type",L"week");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
sbRequestBody = CkStringBuilderW_Create();
CkJsonObjectW_EmitSb(json,sbRequestBody);
resp = CkHttpW_PTextSb(http,L"PUT",L"https://api.squadcast.com/v3/schedules/:schedulesID/events/:eventID",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "id": "5ecf89b4ebddeae2907cd424",
// "start_time": "2020-01-10T18:30:00Z",
// "end_time": "2020-01-10T18: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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"data");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
id = CkJsonObjectW_stringOf(jResp,L"data[i].id");
start_time = CkJsonObjectW_stringOf(jResp,L"data[i].start_time");
end_time = CkJsonObjectW_stringOf(jResp,L"data[i].end_time");
name = CkJsonObjectW_stringOf(jResp,L"data[i].name");
series_id = CkJsonObjectW_stringOf(jResp,L"data[i].series_id");
is_override = CkJsonObjectW_BoolOf(jResp,L"data[i].is_override");
schedule_id = CkJsonObjectW_stringOf(jResp,L"data[i].schedule_id");
Id = CkJsonObjectW_stringOf(jResp,L"data[i].calendar.id");
Name = CkJsonObjectW_stringOf(jResp,L"data[i].calendar.name");
Slug = CkJsonObjectW_stringOf(jResp,L"data[i].calendar.slug");
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"data[i].user_ids");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
strVal = CkJsonObjectW_stringOf(jResp,L"data[i].user_ids[j]");
j = j + 1;
}
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"data[i].squad_ids");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
j = j + 1;
}
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"name": "SRE shift 1",
"update_type":1,
"start_time": "2020-01-10T18:30:00.000Z",
"end_time": "2020-01-10T18: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/:eventID
Postman Collection Item JSON
{
"name": "Update On-call Event",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"SRE shift 1\",\n\t\"update_type\":1,\n \"start_time\": \"2020-01-10T18:30:00.000Z\",\n \"end_time\": \"2020-01-10T18: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/:eventID",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules",
":schedulesID",
"events",
":eventID"
],
"variable": [
{
"key": "schedulesID",
"value": "5ecf7176f92f2e731262b852",
"type": "string"
},
{
"key": "eventID",
"value": "5ecf89b4ebddeae2907cd424",
"type": "string"
}
]
},
"description": "This endpoint is used to update the on-call rotation(event) for the schedule.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `schedule-write` scope.\n\nUpdate Type value representations:\n```\nupdate_type:\n\n1 - Update the current single event\n2 - Update the current event and all the following events\n```\n\n\nRepresentation of Weekly Repetition:\n```\n0 - Sunday\n1 - Monday\n2 - Tuesday\n3 - Wednesday\n4 - Thursday\n5 - Friday\n6 - Saturday\n```"
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"update_type\":1,\n \"start_time\": \"2020-01-10T18:30:00.000Z\",\n \"end_time\": \"2020-01-10T18: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/:eventID",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules",
":schedulesID",
"events",
":eventID"
],
"variable": [
{
"key": "schedulesID",
"value": "5ecf7176f92f2e731262b852"
},
{
"key": "eventID",
"value": "5ecf89b4ebddeae2907cd424"
}
]
}
},
"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:24:09 GMT"
},
{
"key": "Content-Length",
"value": "406"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"id\": \"5ecf89b4ebddeae2907cd424\",\n \"start_time\": \"2020-01-10T18:30:00Z\",\n \"end_time\": \"2020-01-10T18: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}"
}
]
}
