Back to Collection Items
#include <CkHttpW.h>
#include <CkStringBuilderW.h>
#include <CkJsonObjectW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
bool success;
http.SetRequestHeader(L"Authorization",L"");
CkStringBuilderW sbResponseBody;
success = http.QuickGetSb(L"https://api.squadcast.com/v3users/:userID",sbResponseBody);
if (success == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkJsonObjectW jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jResp.emit());
int respStatusCode = http.get_LastStatus();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",http.lastHeader());
wprintf(L"Failed.\n");
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
// }
// }
// 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.
const wchar_t *v_type = 0;
int time;
const wchar_t *Id = jResp.stringOf(L"data.id");
const wchar_t *First_name = jResp.stringOf(L"data.first_name");
const wchar_t *Last_name = jResp.stringOf(L"data.last_name");
const wchar_t *v_Email = jResp.stringOf(L"data.email");
const wchar_t *Dial_code = jResp.stringOf(L"data.contact.dial_code");
const wchar_t *Phone_number = jResp.stringOf(L"data.contact.phone_number");
bool Email_verified = jResp.BoolOf(L"data.email_verified");
const wchar_t *Time_zone = jResp.stringOf(L"data.time_zone");
const wchar_t *Title = jResp.stringOf(L"data.title");
const wchar_t *Bio = jResp.stringOf(L"data.bio");
bool User_image = jResp.BoolOf(L"data.user_image");
int i = 0;
int count_i = jResp.SizeOfArray(L"data.secondary_emails");
while (i < count_i) {
jResp.put_I(i);
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray(L"data.notification_rules");
while (i < count_i) {
jResp.put_I(i);
v_type = jResp.stringOf(L"data.notification_rules[i].type");
time = jResp.IntOf(L"data.notification_rules[i].time");
i = i + 1;
}
}
Curl Command
curl -X GET
-H "Authorization: "
https://api.squadcast.com/v3users/:userID
Postman Collection Item JSON
{
"name": "Get User By ID",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [
{
"key": "Authorization",
"value": ""
}
],
"url": {
"raw": "{{baseUrl}}users/:userID",
"host": [
"{{baseUrl}}users"
],
"path": [
":userID"
],
"variable": [
{
"key": "userID",
"value": "<string>",
"type": "string",
"description": "(Required) user id"
}
]
},
"description": "Returns a users details of the given `userID` in the request param.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope."
},
"response": [
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/users/:userID",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userID"
],
"variable": [
{
"key": "userID"
}
]
}
},
"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}"
},
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/users/:userID",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userID"
],
"variable": [
{
"key": "userID"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\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 }\n}"
},
{
"name": "Not Found",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/users/:userID",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userID"
],
"variable": [
{
"key": "userID"
}
]
}
},
"status": "Not Found",
"code": 404,
"_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/:userID",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userID"
],
"variable": [
{
"key": "userID"
}
]
}
},
"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": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/users/:userID",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userID"
],
"variable": [
{
"key": "userID"
}
]
}
},
"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}"
}
]
}
