PureBasic / Squadcast API V3 / Get Who Is On-Call
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.squadcast.com/v3/schedules/:schedulesID/on-call",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "shift_type": "Normal Shift",
; "users": [
; {
; "id": "5db927bbf8d4da1473169537",
; "first_name": "Tony",
; "last_name": "Stark",
; "email": "tony@squadcast.com",
; "contact": {
; "dial_code": "+91",
; "phone_number": "9578628779"
; }
; }
; ]
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id.s
first_name.s
last_name.s
email.s
Dial_code.s
Phone_number.s
Shift_type.s = CkJsonObject::ckStringOf(jResp,"data.shift_type")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data.users")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"data.users[i].id")
first_name = CkJsonObject::ckStringOf(jResp,"data.users[i].first_name")
last_name = CkJsonObject::ckStringOf(jResp,"data.users[i].last_name")
email = CkJsonObject::ckStringOf(jResp,"data.users[i].email")
Dial_code = CkJsonObject::ckStringOf(jResp,"data.users[i].contact.dial_code")
Phone_number = CkJsonObject::ckStringOf(jResp,"data.users[i].contact.phone_number")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.squadcast.com/v3/schedules/:schedulesID/on-call
Postman Collection Item JSON
{
"name": "Get Who Is On-Call",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/schedules/:schedulesID/on-call",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules",
":schedulesID",
"on-call"
],
"variable": [
{
"key": "schedulesID",
"value": "5ecf7176f92f2e731262b852",
"type": "string"
}
]
},
"description": "This endpoint is used to get all the on-call users of the schedule.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `schedule-read` scope."
},
"response": [
{
"name": "200 OK",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/schedules/:schedulesID/on-call",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules",
":schedulesID",
"on-call"
],
"variable": [
{
"key": "schedulesID",
"value": "5ecf7176f92f2e731262b852"
}
]
}
},
"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 09:18:21 GMT"
},
{
"key": "Content-Length",
"value": "50"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"shift_type\": \"Normal Shift\",\n \"users\": [\n {\n \"id\": \"5db927bbf8d4da1473169537\",\n \"first_name\": \"Tony\",\n \"last_name\": \"Stark\",\n \"email\": \"tony@squadcast.com\",\n \"contact\": {\n \"dial_code\": \"+91\",\n \"phone_number\": \"9578628779\"\n }\n }\n ]\n }\n}"
},
{
"name": "401 Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/schedules/:schedulesID/on-call",
"host": [
"{{baseUrl}}"
],
"path": [
"schedules",
":schedulesID",
"on-call"
],
"variable": [
{
"key": "schedulesID",
"value": "5ecf7176f92f2e731262b852"
}
]
}
},
"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 09:18:21 GMT"
},
{
"key": "Content-Length",
"value": "50"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": 401,\n \"error_message\": \"<string>\"\n }\n}"
}
]
}