Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; 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"
; }
; }
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("name","SRE shift 1")
$oJson.UpdateString("start_time","2020-01-11T18:30:00.000Z")
$oJson.UpdateString("end_time","2020-01-11T18:30:00.000Z")
$oJson.UpdateString("rotation_sets[0].user_ids[0]","5d81d9187000fb6b9def7e31")
$oJson.UpdateNewArray("rotation_sets[0].squad_ids")
$oJson.UpdateString("rotation_sets[1].user_ids[0]","5d90cc3a4d031497494f07e6")
$oJson.UpdateNewArray("rotation_sets[1].squad_ids")
$oJson.UpdateString("config.timezone.name","IST")
$oJson.UpdateInt("config.timezone.offset",-330)
$oJson.UpdateBool("config.is_forever",True)
$oJson.UpdateString("config.until","2020-01-09T14:38:06.658Z")
$oJson.UpdateBool("config.rotate",True)
$oJson.UpdateBool("config.repeat",True)
$oJson.UpdateInt("config.rotation_frequency",1)
$oJson.UpdateInt("config.repetition.frequency",1)
$oJson.UpdateInt("config.repetition.repeats_on[0]",0)
$oJson.UpdateInt("config.repetition.repeats_on[1]",6)
$oJson.UpdateString("config.repetition.type","week")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
Local $oResp = $oHttp.PostJson3("https://api.squadcast.com/v3/schedules/:schedulesID/events","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sId
Local $start_time
Local $sEnd_time
Local $sName
Local $series_id
Local $bIs_override
Local $schedule_id
Local $sId
Local $sName
Local $sSlug
Local $iJ
Local $iCount_j
Local $strVal
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("data[i].id")
$start_time = $oJResp.StringOf("data[i].start_time")
$sEnd_time = $oJResp.StringOf("data[i].end_time")
$sName = $oJResp.StringOf("data[i].name")
$series_id = $oJResp.StringOf("data[i].series_id")
$bIs_override = $oJResp.BoolOf("data[i].is_override")
$schedule_id = $oJResp.StringOf("data[i].schedule_id")
$sId = $oJResp.StringOf("data[i].calendar.id")
$sName = $oJResp.StringOf("data[i].calendar.name")
$sSlug = $oJResp.StringOf("data[i].calendar.slug")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].user_ids")
While $iJ < $iCount_j
$oJResp.J = $iJ
$strVal = $oJResp.StringOf("data[i].user_ids[j]")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].squad_ids")
While $iJ < $iCount_j
$oJResp.J = $iJ
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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}"
}
]
}
