Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *id;
const char *first_name;
const char *last_name;
const char *email;
const char *Dial_code;
const char *Phone_number;
BOOL email_verified;
const char *time_zone;
const char *title;
const char *bio;
BOOL user_image;
const char *role_id;
const char *role;
const char *secondary_emails;
int j;
int count_j;
const char *v_type;
int time;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
CkHttp_SetRequestHeader(http,"Authorization","");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://api.squadcast.com/v3/users",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "id": "5d81d9187000fb6b9def7e31",
// "first_name": "Manigandan",
// "last_name": "Dharmalingam",
// "email": "manigandan@squadcast.com",
// "contact": {
// "dial_code": "+91",
// "phone_number": "9578628779"
// },
// "secondary_emails": [
// ],
// "email_verified": true,
// "time_zone": "Asia/Calcutta",
// "title": "",
// "bio": "",
// "notification_rules": [
// {
// "type": "Email",
// "time": 0
// },
// {
// "type": "Push",
// "time": 0
// },
// {
// "type": "SMS",
// "time": 1
// },
// {
// "type": "Phone",
// "time": 2
// }
// ],
// "user_image": false,
// "role_id": "5a425b383c36823b3ed91fb4",
// "role": "account_owner"
// },
// {
// "id": "5d91d262a2c85fa24a27d4d7",
// "first_name": "Akilan",
// "last_name": "Elango",
// "email": "akilan@squadcast.com",
// "contact": {
// "dial_code": "",
// "phone_number": ""
// },
// "secondary_emails": null,
// "email_verified": false,
// "time_zone": "",
// "title": "",
// "bio": "",
// "notification_rules": [
// {
// "type": "Email",
// "time": 0
// },
// {
// "type": "Push",
// "time": 0
// },
// {
// "type": "SMS",
// "time": 1
// },
// {
// "type": "Phone",
// "time": 2
// }
// ],
// "user_image": false,
// "role_id": "5a425b383c36823b3ed91fb5",
// "role": "admin"
// },
// {
// "id": "5d91d262a2c85fa24a27d4da",
// "first_name": "Madhu",
// "last_name": "DS Frontend",
// "email": "madhu@squadcast.com",
// "contact": {
// "dial_code": "",
// "phone_number": ""
// },
// "secondary_emails": null,
// "email_verified": false,
// "time_zone": "",
// "title": "",
// "bio": "",
// "notification_rules": [
// {
// "type": "Email",
// "time": 0
// },
// {
// "type": "Push",
// "time": 0
// },
// {
// "type": "SMS",
// "time": 1
// },
// {
// "type": "Phone",
// "time": 2
// }
// ],
// "user_image": false,
// "role_id": "5a425b383c36823b3ed91fb6",
// "role": "user"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"data");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
id = CkJsonObject_stringOf(jResp,"data[i].id");
first_name = CkJsonObject_stringOf(jResp,"data[i].first_name");
last_name = CkJsonObject_stringOf(jResp,"data[i].last_name");
email = CkJsonObject_stringOf(jResp,"data[i].email");
Dial_code = CkJsonObject_stringOf(jResp,"data[i].contact.dial_code");
Phone_number = CkJsonObject_stringOf(jResp,"data[i].contact.phone_number");
email_verified = CkJsonObject_BoolOf(jResp,"data[i].email_verified");
time_zone = CkJsonObject_stringOf(jResp,"data[i].time_zone");
title = CkJsonObject_stringOf(jResp,"data[i].title");
bio = CkJsonObject_stringOf(jResp,"data[i].bio");
user_image = CkJsonObject_BoolOf(jResp,"data[i].user_image");
role_id = CkJsonObject_stringOf(jResp,"data[i].role_id");
role = CkJsonObject_stringOf(jResp,"data[i].role");
secondary_emails = CkJsonObject_stringOf(jResp,"data[i].secondary_emails");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"data[i].secondary_emails");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"data[i].notification_rules");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
v_type = CkJsonObject_stringOf(jResp,"data[i].notification_rules[j].type");
time = CkJsonObject_IntOf(jResp,"data[i].notification_rules[j].time");
j = j + 1;
}
i = i + 1;
}
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -X GET
-H "Authorization: "
https://api.squadcast.com/v3/users
Postman Collection Item JSON
{
"name": "Get All Users",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Authorization",
"value": ""
}
],
"url": {
"raw": "{{baseUrl}}/users",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
]
},
"description": "Returns all the users of the organization.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope.\n "
},
"response": [
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/users",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": \"<integer>\",\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "Internal Server Error",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/users",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": \"<integer>\",\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/users",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"id\": \"5d81d9187000fb6b9def7e31\",\n \"first_name\": \"Manigandan\",\n \"last_name\": \"Dharmalingam\",\n \"email\": \"manigandan@squadcast.com\",\n \"contact\": {\n \"dial_code\": \"+91\",\n \"phone_number\": \"9578628779\"\n },\n \"secondary_emails\": [],\n \"email_verified\": true,\n \"time_zone\": \"Asia/Calcutta\",\n \"title\": \"\",\n \"bio\": \"\",\n \"notification_rules\": [\n {\n \"type\": \"Email\",\n \"time\": 0\n },\n {\n \"type\": \"Push\",\n \"time\": 0\n },\n {\n \"type\": \"SMS\",\n \"time\": 1\n },\n {\n \"type\": \"Phone\",\n \"time\": 2\n }\n ],\n \"user_image\": false,\n \"role_id\": \"5a425b383c36823b3ed91fb4\",\n \"role\": \"account_owner\"\n },\n {\n \"id\": \"5d91d262a2c85fa24a27d4d7\",\n \"first_name\": \"Akilan\",\n \"last_name\": \"Elango\",\n \"email\": \"akilan@squadcast.com\",\n \"contact\": {\n \"dial_code\": \"\",\n \"phone_number\": \"\"\n },\n \"secondary_emails\": null,\n \"email_verified\": false,\n \"time_zone\": \"\",\n \"title\": \"\",\n \"bio\": \"\",\n \"notification_rules\": [\n {\n \"type\": \"Email\",\n \"time\": 0\n },\n {\n \"type\": \"Push\",\n \"time\": 0\n },\n {\n \"type\": \"SMS\",\n \"time\": 1\n },\n {\n \"type\": \"Phone\",\n \"time\": 2\n }\n ],\n \"user_image\": false,\n \"role_id\": \"5a425b383c36823b3ed91fb5\",\n \"role\": \"admin\"\n },\n {\n \"id\": \"5d91d262a2c85fa24a27d4da\",\n \"first_name\": \"Madhu\",\n \"last_name\": \"DS Frontend\",\n \"email\": \"madhu@squadcast.com\",\n \"contact\": {\n \"dial_code\": \"\",\n \"phone_number\": \"\"\n },\n \"secondary_emails\": null,\n \"email_verified\": false,\n \"time_zone\": \"\",\n \"title\": \"\",\n \"bio\": \"\",\n \"notification_rules\": [\n {\n \"type\": \"Email\",\n \"time\": 0\n },\n {\n \"type\": \"Push\",\n \"time\": 0\n },\n {\n \"type\": \"SMS\",\n \"time\": 1\n },\n {\n \"type\": \"Phone\",\n \"time\": 2\n }\n ],\n \"user_image\": false,\n \"role_id\": \"5a425b383c36823b3ed91fb6\",\n \"role\": \"user\"\n }\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/users",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": \"<integer>\",\n \"error_message\": \"<string>\"\n }\n}"
}
]
}
