DataFlex / Squadcast API V3 / Create On-call Event
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sId
String sStart_time
String sEnd_time
String sName
String sSeries_id
Boolean iIs_override
String sSchedule_id
String sId
String sName
String sSlug
Integer j
Integer iCount_j
String sStrVal
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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"
// }
// }
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "name" "SRE shift 1" To iSuccess
Get ComUpdateString Of hoJson "start_time" "2020-01-11T18:30:00.000Z" To iSuccess
Get ComUpdateString Of hoJson "end_time" "2020-01-11T18:30:00.000Z" To iSuccess
Get ComUpdateString Of hoJson "rotation_sets[0].user_ids[0]" "5d81d9187000fb6b9def7e31" To iSuccess
Get ComUpdateNewArray Of hoJson "rotation_sets[0].squad_ids" To iSuccess
Get ComUpdateString Of hoJson "rotation_sets[1].user_ids[0]" "5d90cc3a4d031497494f07e6" To iSuccess
Get ComUpdateNewArray Of hoJson "rotation_sets[1].squad_ids" To iSuccess
Get ComUpdateString Of hoJson "config.timezone.name" "IST" To iSuccess
Get ComUpdateInt Of hoJson "config.timezone.offset" -330 To iSuccess
Get ComUpdateBool Of hoJson "config.is_forever" True To iSuccess
Get ComUpdateString Of hoJson "config.until" "2020-01-09T14:38:06.658Z" To iSuccess
Get ComUpdateBool Of hoJson "config.rotate" True To iSuccess
Get ComUpdateBool Of hoJson "config.repeat" True To iSuccess
Get ComUpdateInt Of hoJson "config.rotation_frequency" 1 To iSuccess
Get ComUpdateInt Of hoJson "config.repetition.frequency" 1 To iSuccess
Get ComUpdateInt Of hoJson "config.repetition.repeats_on[0]" 0 To iSuccess
Get ComUpdateInt Of hoJson "config.repetition.repeats_on[1]" 6 To iSuccess
Get ComUpdateString Of hoJson "config.repetition.type" "week" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://api.squadcast.com/v3/schedules/:schedulesID/events" "application/json" vJson To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Move 0 To i
Get ComSizeOfArray Of hoJResp "data" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "data[i].id" To sId
Get ComStringOf Of hoJResp "data[i].start_time" To sStart_time
Get ComStringOf Of hoJResp "data[i].end_time" To sEnd_time
Get ComStringOf Of hoJResp "data[i].name" To sName
Get ComStringOf Of hoJResp "data[i].series_id" To sSeries_id
Get ComBoolOf Of hoJResp "data[i].is_override" To iIs_override
Get ComStringOf Of hoJResp "data[i].schedule_id" To sSchedule_id
Get ComStringOf Of hoJResp "data[i].calendar.id" To sId
Get ComStringOf Of hoJResp "data[i].calendar.name" To sName
Get ComStringOf Of hoJResp "data[i].calendar.slug" To sSlug
Move 0 To j
Get ComSizeOfArray Of hoJResp "data[i].user_ids" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "data[i].user_ids[j]" To sStrVal
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "data[i].squad_ids" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
