Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
' 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"
' }
' }
' }
Dim json As New ChilkatJsonObject
success = json.UpdateString("name","SRE shift 1")
success = json.UpdateInt("update_type",1)
success = json.UpdateString("start_time","2020-01-10T18:30:00.000Z")
success = json.UpdateString("end_time","2020-01-10T18:30:00.000Z")
success = json.UpdateString("rotation_sets[0].user_ids[0]","5d81d9187000fb6b9def7e31")
success = json.UpdateNewArray("rotation_sets[0].squad_ids")
success = json.UpdateString("rotation_sets[1].user_ids[0]","5d90cc3a4d031497494f07e6")
success = json.UpdateNewArray("rotation_sets[1].squad_ids")
success = json.UpdateString("config.timezone.name","IST")
success = json.UpdateInt("config.timezone.offset",-330)
success = json.UpdateBool("config.is_forever",1)
success = json.UpdateString("config.until","2020-01-09T14:38:06.658Z")
success = json.UpdateBool("config.rotate",1)
success = json.UpdateBool("config.repeat",1)
success = json.UpdateInt("config.rotation_frequency",1)
success = json.UpdateInt("config.repetition.frequency",1)
success = json.UpdateInt("config.repetition.repeats_on[0]",0)
success = json.UpdateInt("config.repetition.repeats_on[1]",6)
success = json.UpdateString("config.repetition.type","week")
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim sbRequestBody As New ChilkatStringBuilder
success = json.EmitSb(sbRequestBody)
Dim resp As ChilkatHttpResponse
Set resp = http.PTextSb("PUT","https://api.squadcast.com/v3/schedules/:schedulesID/events/:eventID",sbRequestBody,"utf-8","application/json",0,0)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' 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
Dim id As String
Dim start_time As String
Dim end_time As String
Dim name As String
Dim series_id As String
Dim is_override As Long
Dim schedule_id As String
Dim Id As String
Dim Name As String
Dim Slug As String
Dim j As Long
Dim count_j As Long
Dim strVal As String
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("data")
Do 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")
Do While j < count_j
jResp.J = j
strVal = jResp.StringOf("data[i].user_ids[j]")
j = j + 1
Loop
j = 0
count_j = jResp.SizeOfArray("data[i].squad_ids")
Do While j < count_j
jResp.J = j
j = j + 1
Loop
i = i + 1
Loop
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}"
}
]
}
