Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
// 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 Backend schedule",
// "colour": "#0f61dc",
// "description": "This schedule repeats daily"
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"name" value: @"Daily Backend schedule"];
[json UpdateString: @"colour" value: @"#0f61dc"];
[json UpdateString: @"description" value: @"This schedule repeats daily"];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];
CkoHttpResponse *resp = [http PTextSb: @"PUT" url: @"https://api.squadcast.com/v3/schedules/:schedulesID" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "id": "5ecf73fbf92f2e731262b853",
// "name": "Daily Backend schedule",
// "slug": "daily-schedule",
// "organization_id": "5d81d9187000fb6b9def7e32",
// "colour": "#0f61dc",
// "description": "This schedule repeats daily",
// "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
NSString *Id = [jResp StringOf: @"data.id"];
NSString *Name = [jResp StringOf: @"data.name"];
NSString *Slug = [jResp StringOf: @"data.slug"];
NSString *Organization_id = [jResp StringOf: @"data.organization_id"];
NSString *Colour = [jResp StringOf: @"data.colour"];
NSString *Description = [jResp StringOf: @"data.description"];
NSString *OrganizationId = [jResp StringOf: @"data.organization.id"];
NSString *OrganizationName = [jResp StringOf: @"data.organization.name"];
NSString *OrganizationSlug = [jResp StringOf: @"data.organization.slug"];
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"name": "Daily Backend schedule",
"colour": "#0f61dc",
"description": "This schedule repeats daily"
}'
https://api.squadcast.com/v3/schedules/:schedulesID
Postman Collection Item JSON
{
"name": "Update Schedule",
"request": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Daily Backend schedule\",\n\t\"colour\": \"#0f61dc\",\n\t\"description\": \"This schedule repeats daily\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/schedules/:schedulesID",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules",
":schedulesID"
],
"variable": [
{
"key": "schedulesID",
"value": "5ecf73fbf92f2e731262b853",
"type": "string"
}
]
},
"description": "This endpoint is used to update a schedule's configuration.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `schedule-write` scope."
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Daily Backend schedule\",\n\t\"colour\": \"#0f61dc\",\n\t\"description\": \"This schedule repeats daily\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/schedules/:schedulesID",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules",
":schedulesID"
],
"variable": [
{
"key": "schedulesID",
"value": "5ecf73fbf92f2e731262b853"
}
]
}
},
"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 08:37:30 GMT"
},
{
"key": "Content-Length",
"value": "294"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"5ecf73fbf92f2e731262b853\",\n \"name\": \"Daily Backend schedule\",\n \"slug\": \"daily-schedule\",\n \"organization_id\": \"5d81d9187000fb6b9def7e32\",\n \"colour\": \"#0f61dc\",\n \"description\": \"This schedule repeats daily\",\n \"organization\": {\n \"id\": \"5d81d9187000fb6b9def7e32\",\n \"name\": \"GopherHut\",\n \"slug\": \"gopherhut\"\n }\n }\n}"
},
{
"name": "409 Conflict",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Weekly schedule\",\n\t\"colour\": \"#0f61dc\",\n\t\"description\": \"This schedule repeats daily\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/schedules/:schedulesID",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules",
":schedulesID"
],
"variable": [
{
"key": "schedulesID",
"value": "5ecf73fbf92f2e731262b853"
}
]
}
},
"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 09:00:58 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": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Daily Backend schedule\",\n\t\"colour\": \"#0f61dc\",\n\t\"description\": \"This schedule repeats daily\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/schedules/:schedulesID",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules",
":schedulesID"
],
"variable": [
{
"key": "schedulesID",
"value": "5ecf73fbf92f2e731262b853"
}
]
}
},
"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:01:26 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": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Daily Backend schedule\",\n\t\"colour\": \"#0f61dc\",\n\t\"description\": \"This schedule repeats daily\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/schedules/:schedulesID",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules",
":schedulesID"
],
"variable": [
{
"key": "schedulesID",
"value": "5ecf73fbf92f2e731262b853"
}
]
}
},
"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:01:26 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": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Daily Backend schedule\",\n\t\"colour\": \"#0f61dc\",\n\t\"description\": \"This schedule repeats daily\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/schedules/:schedulesID",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules",
":schedulesID"
],
"variable": [
{
"key": "schedulesID",
"value": "5ecf73fbf92f2e731262b853"
}
]
}
},
"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:01:26 GMT"
},
{
"key": "Content-Length",
"value": "56"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 500,\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "403 - Forbidden",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Daily Backend schedule\",\n\t\"colour\": \"#0f61dc\",\n\t\"description\": \"This schedule repeats daily\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/schedules/:schedulesID",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules",
":schedulesID"
],
"variable": [
{
"key": "schedulesID",
"value": "5ecf73fbf92f2e731262b853"
}
]
}
},
"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:01:26 GMT"
},
{
"key": "Content-Length",
"value": "56"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 403,\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "404 Not Found",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Daily Backend schedule\",\n\t\"colour\": \"#0f61dc\",\n\t\"description\": \"This schedule repeats daily\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/schedules/:schedulesID",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules",
":schedulesID"
],
"variable": [
{
"key": "schedulesID",
"value": "5ecf73fbf92f2e731262b854"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "Date",
"value": "Thu, 28 May 2020 09:07:39 GMT"
},
{
"key": "Content-Length",
"value": "70"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 404,\n \"error_message\": \"schedule resource not found\"\n }\n}"
}
]
}
