Chilkat Online Tools

VB6 / Squadcast API V3 / Create Schedules

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New ChilkatHttp
Dim success As Long

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

Dim json As New ChilkatJsonObject
success = json.UpdateString("name","Daily schedule")
success = json.UpdateString("colour","#0f61dd")
success = json.UpdateString("description","This schedule repeats daily")

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"

Dim resp As ChilkatHttpResponse
Set resp = http.PostJson3("https://api.squadcast.com/v3/schedules","application/json",json)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

' 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

Dim Id As String
Id = jResp.StringOf("data.id")
Dim Name As String
Name = jResp.StringOf("data.name")
Dim Slug As String
Slug = jResp.StringOf("data.slug")
Dim Organization_id As String
Organization_id = jResp.StringOf("data.organization_id")
Dim Colour As String
Colour = jResp.StringOf("data.colour")
Dim Description As String
Description = jResp.StringOf("data.description")
Dim OrganizationId As String
OrganizationId = jResp.StringOf("data.organization.id")
Dim OrganizationName As String
OrganizationName = jResp.StringOf("data.organization.name")
Dim OrganizationSlug As String
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}"
    }
  ]
}