Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# 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": "Daily schedule",
# "colour": "#0f61dd",
# "description": "This schedule repeats daily"
# }
json = Chilkat::CkJsonObject.new()
json.UpdateString("name","Daily schedule")
json.UpdateString("colour","#0f61dd")
json.UpdateString("description","This schedule repeats daily")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
# resp is a CkHttpResponse
resp = http.PostJson3("https://api.squadcast.com/v3/schedules","application/json",json)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "data": {
# "id": "5ecf7176f92f2e731262b852",
# "name": "Weekly schedule",
# "slug": "weekly-schedule",
# "organization_id": "5d81d9187000fb6b9def7e32",
# "colour": "#0f61dd",
# "description": "This schedule repeats weekly",
# "organization": {
# "id": "5d81d9187000fb6b9def7e32",
# "name": "GopherHut",
# "slug": "gopherhut"
# }
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Id = jResp.stringOf("data.id")
Name = jResp.stringOf("data.name")
Slug = jResp.stringOf("data.slug")
Organization_id = jResp.stringOf("data.organization_id")
Colour = jResp.stringOf("data.colour")
Description = jResp.stringOf("data.description")
OrganizationId = jResp.stringOf("data.organization.id")
OrganizationName = jResp.stringOf("data.organization.name")
OrganizationSlug = jResp.stringOf("data.organization.slug")
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-d '{
"name": "Daily schedule",
"colour": "#0f61dd",
"description": "This schedule repeats daily"
}'
https://api.squadcast.com/v3/schedules
Postman Collection Item JSON
{
"name": "Create Schedules",
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Daily schedule\",\n\t\"colour\": \"#0f61dd\",\n\t\"description\": \"This schedule repeats daily\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/schedules",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules"
]
},
"description": "This endpoint is used to create a new schedule.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `schedule-write` scope."
},
"response": [
{
"name": "201 Created",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Weekly schedule\",\n\t\"colour\": \"#0f61dd\",\n\t\"description\": \"This schedule repeats weekly\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/schedules",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules"
]
}
},
"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 08:08:24 GMT"
},
{
"key": "Content-Length",
"value": "289"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"5ecf7176f92f2e731262b852\",\n \"name\": \"Weekly schedule\",\n \"slug\": \"weekly-schedule\",\n \"organization_id\": \"5d81d9187000fb6b9def7e32\",\n \"colour\": \"#0f61dd\",\n \"description\": \"This schedule repeats weekly\",\n \"organization\": {\n \"id\": \"5d81d9187000fb6b9def7e32\",\n \"name\": \"GopherHut\",\n \"slug\": \"gopherhut\"\n }\n }\n}"
},
{
"name": "409 Conflict",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Weekly schedule\",\n\t\"colour\": \"#0f61dd\",\n\t\"description\": \"This schedule repeats weekly\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/schedules",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "Date",
"value": "Thu, 28 May 2020 08:09:44 GMT"
},
{
"key": "Content-Length",
"value": "85"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 409,\n \"error_message\": \"schedule with the same name already exists\"\n }\n}"
},
{
"name": "400 Bad Request",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Weekly schedule\",\n\t\"colour\": \"#0f61dd\",\n\t\"description\": \"This schedule repeats weekly\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/schedules",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules"
]
}
},
"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 08:10:13 GMT"
},
{
"key": "Content-Length",
"value": "56"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 400,\n \"error_message\": \"Name required\"\n }\n}"
},
{
"name": "401 Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Weekly schedule\",\n\t\"colour\": \"#0f61dd\",\n\t\"description\": \"This schedule repeats weekly\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/schedules",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules"
]
}
},
"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 08:10:13 GMT"
},
{
"key": "Content-Length",
"value": "56"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 401,\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "500 Internal Server Error",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Weekly schedule\",\n\t\"colour\": \"#0f61dd\",\n\t\"description\": \"This schedule repeats weekly\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/schedules",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules"
]
}
},
"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 08:10:13 GMT"
},
{
"key": "Content-Length",
"value": "56"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 500,\n \"error_message\": \"<string>\"\n }\n}"
}
]
}
