Chilkat Online Tools

Swift3 / Squadcast API V3 / Create On-call Event

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    // 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"
    //     }
    //   }
    // }

    let json = CkoJsonObject()!
    json.update("name", value: "SRE shift 1")
    json.update("start_time", value: "2020-01-11T18:30:00.000Z")
    json.update("end_time", value: "2020-01-11T18:30:00.000Z")
    json.update("rotation_sets[0].user_ids[0]", value: "5d81d9187000fb6b9def7e31")
    json.updateNewArray("rotation_sets[0].squad_ids")
    json.update("rotation_sets[1].user_ids[0]", value: "5d90cc3a4d031497494f07e6")
    json.updateNewArray("rotation_sets[1].squad_ids")
    json.update("config.timezone.name", value: "IST")
    json.updateInt("config.timezone.offset", value: -330)
    json.updateBool("config.is_forever", value: true)
    json.update("config.until", value: "2020-01-09T14:38:06.658Z")
    json.updateBool("config.rotate", value: true)
    json.updateBool("config.repeat", value: true)
    json.updateInt("config.rotation_frequency", value: 1)
    json.updateInt("config.repetition.frequency", value: 1)
    json.updateInt("config.repetition.repeats_on[0]", value: 0)
    json.updateInt("config.repetition.repeats_on[1]", value: 6)
    json.update("config.repetition.type", value: "week")

    // Adds the "Authorization: Bearer <access_token>" header.
    http.authToken = "<access_token>"

    var resp: CkoHttpResponse? = http.postJson3("https://api.squadcast.com/v3/schedules/:schedulesID/events", contentType: "application/json", json: json)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // 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

    var id: String?
    var start_time: String?
    var end_time: String?
    var name: String?
    var series_id: String?
    var is_override: Bool
    var schedule_id: String?
    var Id: String?
    var Name: String?
    var Slug: String?
    var j: Int
    var count_j: Int
    var strVal: String?

    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "data").intValue
    while i < count_i {
        jResp.i = i
        id = jResp.string(of: "data[i].id")
        start_time = jResp.string(of: "data[i].start_time")
        end_time = jResp.string(of: "data[i].end_time")
        name = jResp.string(of: "data[i].name")
        series_id = jResp.string(of: "data[i].series_id")
        is_override = jResp.bool(of: "data[i].is_override")
        schedule_id = jResp.string(of: "data[i].schedule_id")
        Id = jResp.string(of: "data[i].calendar.id")
        Name = jResp.string(of: "data[i].calendar.name")
        Slug = jResp.string(of: "data[i].calendar.slug")
        j = 0
        count_j = jResp.size(ofArray: "data[i].user_ids").intValue
        while j < count_j {
            jResp.j = j
            strVal = jResp.string(of: "data[i].user_ids[j]")
            j = j + 1
        }

        j = 0
        count_j = jResp.size(ofArray: "data[i].squad_ids").intValue
        while j < count_j {
            jResp.j = j
            j = j + 1
        }

        i = i + 1
    }


}

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}"
    }
  ]
}