Chilkat Online Tools

delphiDll / Squadcast API V3 / Update On-call Event

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
start_time: PWideChar;
end_time: PWideChar;
name: PWideChar;
series_id: PWideChar;
is_override: Boolean;
schedule_id: PWideChar;
Id: PWideChar;
Name: PWideChar;
Slug: PWideChar;
j: Integer;
count_j: Integer;
strVal: 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();

// 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 := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'name','SRE shift 1');
CkJsonObject_UpdateInt(json,'update_type',1);
CkJsonObject_UpdateString(json,'start_time','2020-01-10T18:30:00.000Z');
CkJsonObject_UpdateString(json,'end_time','2020-01-10T18:30:00.000Z');
CkJsonObject_UpdateString(json,'rotation_sets[0].user_ids[0]','5d81d9187000fb6b9def7e31');
CkJsonObject_UpdateNewArray(json,'rotation_sets[0].squad_ids');
CkJsonObject_UpdateString(json,'rotation_sets[1].user_ids[0]','5d90cc3a4d031497494f07e6');
CkJsonObject_UpdateNewArray(json,'rotation_sets[1].squad_ids');
CkJsonObject_UpdateString(json,'config.timezone.name','IST');
CkJsonObject_UpdateInt(json,'config.timezone.offset',-330);
CkJsonObject_UpdateBool(json,'config.is_forever',True);
CkJsonObject_UpdateString(json,'config.until','2020-01-09T14:38:06.658Z');
CkJsonObject_UpdateBool(json,'config.rotate',True);
CkJsonObject_UpdateBool(json,'config.repeat',True);
CkJsonObject_UpdateInt(json,'config.rotation_frequency',1);
CkJsonObject_UpdateInt(json,'config.repetition.frequency',1);
CkJsonObject_UpdateInt(json,'config.repetition.repeats_on[0]',0);
CkJsonObject_UpdateInt(json,'config.repetition.repeats_on[1]',6);
CkJsonObject_UpdateString(json,'config.repetition.type','week');

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

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);

resp := CkHttp_PTextSb(http,'PUT','https://api.squadcast.com/v3/schedules/:schedulesID/events/:eventID',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

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

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

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_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

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'data');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    id := CkJsonObject__stringOf(jResp,'data[i].id');
    start_time := CkJsonObject__stringOf(jResp,'data[i].start_time');
    end_time := CkJsonObject__stringOf(jResp,'data[i].end_time');
    name := CkJsonObject__stringOf(jResp,'data[i].name');
    series_id := CkJsonObject__stringOf(jResp,'data[i].series_id');
    is_override := CkJsonObject_BoolOf(jResp,'data[i].is_override');
    schedule_id := CkJsonObject__stringOf(jResp,'data[i].schedule_id');
    Id := CkJsonObject__stringOf(jResp,'data[i].calendar.id');
    Name := CkJsonObject__stringOf(jResp,'data[i].calendar.name');
    Slug := CkJsonObject__stringOf(jResp,'data[i].calendar.slug');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'data[i].user_ids');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        strVal := CkJsonObject__stringOf(jResp,'data[i].user_ids[j]');
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'data[i].squad_ids');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        j := j + 1;
      end;

    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_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}"
    }
  ]
}