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 *activated;
const char *created_at;
const char *description;
const char *id;
const char *position;
const char *prefer_workspace_app_order;
const char *ticket_form_id;
const char *title;
const char *updated_at;
const char *url;
int j;
int count_j;
BOOL ut_1;
const char *Lorem_ec;
const char *sed_a;
const char *laborum_;
int dolore_72;
BOOL Duis_e27;
BOOL do_7b;
BOOL eu_6;
const char *field;
const char *operator;
const char *value;
const char *strVal;
const char *active;
const char *default;
int Elit_0;
int Loreme7;
const char *app_installation;
const char *categories;
const char *permissions;
const char *usage_1h;
const char *usage_7d;
const char *usage_24h;
const char *usage_30d;
BOOL Ut_2;
BOOL Exf9;
BOOL Magna_5;
BOOL Nostrud_7;
int Ex69c;
const char *Ut_a;
int Mollit__;
BOOL Deseruntc_;
int Consequatd0;
BOOL Id_4a;
int k;
int count_k;
const char *count;
const char *next_page;
const char *previous_page;
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_putBasicAuth(http,TRUE);
CkHttp_putLogin(http,"login");
CkHttp_putPassword(http,"password");
CkHttp_SetRequestHeader(http,"Accept","application/json");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://example.zendesk.com/api/v2/workspaces",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)
// {
// "workspaces": [
// {
// "activated": "<boolean>",
// "apps": [
// {
// "ut_1": true
// },
// {
// "Lorem_ec": "ut ipsum nulla voluptate",
// "sed_a": 38535010.16636646
// }
// ],
// "conditions": {
// "all": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ],
// "any": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ]
// },
// "created_at": "<dateTime>",
// "description": "<string>",
// "id": "<integer>",
// "macro_ids": [
// "<integer>",
// "<integer>"
// ],
// "macros": [
// "<integer>",
// "<integer>"
// ],
// "position": "<integer>",
// "prefer_workspace_app_order": "<boolean>",
// "selected_macros": [
// {
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "elit_0": 95926683,
// "Loreme7": 1915356
// },
// "updated_at": "<dateTime>",
// "url": "<string>",
// "app_installation": "<string>",
// "categories": "<string>",
// "permissions": "<string>",
// "usage_1h": "<integer>",
// "usage_7d": "<integer>",
// "usage_24h": "<integer>",
// "usage_30d": "<integer>"
// },
// {
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "ut_2": true,
// "exf9": false,
// "magna_5": false
// },
// "updated_at": "<dateTime>",
// "url": "<string>",
// "app_installation": "<string>",
// "categories": "<string>",
// "permissions": "<string>",
// "usage_1h": "<integer>",
// "usage_7d": "<integer>",
// "usage_24h": "<integer>",
// "usage_30d": "<integer>"
// }
// ],
// "ticket_form_id": "<integer>",
// "title": "<string>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// },
// {
// "activated": "<boolean>",
// "apps": [
// {
// "laborum_": "esse elit mollit nulla",
// "dolore_72": 44930495
// },
// {
// "Duis_e27": false,
// "do_7b": true,
// "eu_6": true
// }
// ],
// "conditions": {
// "all": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ],
// "any": [
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "operator": "<string>",
// "value": "<string>"
// }
// ]
// },
// "created_at": "<dateTime>",
// "description": "<string>",
// "id": "<integer>",
// "macro_ids": [
// "<integer>",
// "<integer>"
// ],
// "macros": [
// "<integer>",
// "<integer>"
// ],
// "position": "<integer>",
// "prefer_workspace_app_order": "<boolean>",
// "selected_macros": [
// {
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "nostrud_7": false,
// "ex69c": -43731952,
// "ut_a": "anim nostrud pariatur",
// "mollit__": -87941840
// },
// "updated_at": "<dateTime>",
// "url": "<string>",
// "app_installation": "<string>",
// "categories": "<string>",
// "permissions": "<string>",
// "usage_1h": "<integer>",
// "usage_7d": "<integer>",
// "usage_24h": "<integer>",
// "usage_30d": "<integer>"
// },
// {
// "actions": [
// {
// "field": "<string>",
// "value": "<string>"
// },
// {
// "field": "<string>",
// "value": "<string>"
// }
// ],
// "title": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "deseruntc_": false,
// "consequatd0": 17786909,
// "id_4a": false
// },
// "updated_at": "<dateTime>",
// "url": "<string>",
// "app_installation": "<string>",
// "categories": "<string>",
// "permissions": "<string>",
// "usage_1h": "<integer>",
// "usage_7d": "<integer>",
// "usage_24h": "<integer>",
// "usage_30d": "<integer>"
// }
// ],
// "ticket_form_id": "<integer>",
// "title": "<string>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// ],
// "count": "<integer>",
// "next_page": "<string>",
// "previous_page": "<string>"
// }
// 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.
count = CkJsonObject_stringOf(jResp,"count");
next_page = CkJsonObject_stringOf(jResp,"next_page");
previous_page = CkJsonObject_stringOf(jResp,"previous_page");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"workspaces");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
activated = CkJsonObject_stringOf(jResp,"workspaces[i].activated");
created_at = CkJsonObject_stringOf(jResp,"workspaces[i].created_at");
description = CkJsonObject_stringOf(jResp,"workspaces[i].description");
id = CkJsonObject_stringOf(jResp,"workspaces[i].id");
position = CkJsonObject_stringOf(jResp,"workspaces[i].position");
prefer_workspace_app_order = CkJsonObject_stringOf(jResp,"workspaces[i].prefer_workspace_app_order");
ticket_form_id = CkJsonObject_stringOf(jResp,"workspaces[i].ticket_form_id");
title = CkJsonObject_stringOf(jResp,"workspaces[i].title");
updated_at = CkJsonObject_stringOf(jResp,"workspaces[i].updated_at");
url = CkJsonObject_stringOf(jResp,"workspaces[i].url");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"workspaces[i].apps");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
ut_1 = CkJsonObject_BoolOf(jResp,"workspaces[i].apps[j].ut_1");
Lorem_ec = CkJsonObject_stringOf(jResp,"workspaces[i].apps[j].Lorem_ec");
sed_a = CkJsonObject_stringOf(jResp,"workspaces[i].apps[j].sed_a");
laborum_ = CkJsonObject_stringOf(jResp,"workspaces[i].apps[j].laborum_");
dolore_72 = CkJsonObject_IntOf(jResp,"workspaces[i].apps[j].dolore_72");
Duis_e27 = CkJsonObject_BoolOf(jResp,"workspaces[i].apps[j].Duis_e27");
do_7b = CkJsonObject_BoolOf(jResp,"workspaces[i].apps[j].do_7b");
eu_6 = CkJsonObject_BoolOf(jResp,"workspaces[i].apps[j].eu_6");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"workspaces[i].conditions.all");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
field = CkJsonObject_stringOf(jResp,"workspaces[i].conditions.all[j].field");
operator = CkJsonObject_stringOf(jResp,"workspaces[i].conditions.all[j].operator");
value = CkJsonObject_stringOf(jResp,"workspaces[i].conditions.all[j].value");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"workspaces[i].conditions.any");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
field = CkJsonObject_stringOf(jResp,"workspaces[i].conditions.any[j].field");
operator = CkJsonObject_stringOf(jResp,"workspaces[i].conditions.any[j].operator");
value = CkJsonObject_stringOf(jResp,"workspaces[i].conditions.any[j].value");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"workspaces[i].macro_ids");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
strVal = CkJsonObject_stringOf(jResp,"workspaces[i].macro_ids[j]");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"workspaces[i].macros");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
strVal = CkJsonObject_stringOf(jResp,"workspaces[i].macros[j]");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"workspaces[i].selected_macros");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
title = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].title");
active = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].active");
created_at = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].created_at");
default = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].default");
description = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].description");
id = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].id");
position = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].position");
Elit_0 = CkJsonObject_IntOf(jResp,"workspaces[i].selected_macros[j].restriction.elit_0");
Loreme7 = CkJsonObject_IntOf(jResp,"workspaces[i].selected_macros[j].restriction.Loreme7");
updated_at = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].updated_at");
url = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].url");
app_installation = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].app_installation");
categories = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].categories");
permissions = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].permissions");
usage_1h = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].usage_1h");
usage_7d = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].usage_7d");
usage_24h = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].usage_24h");
usage_30d = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].usage_30d");
Ut_2 = CkJsonObject_BoolOf(jResp,"workspaces[i].selected_macros[j].restriction.ut_2");
Exf9 = CkJsonObject_BoolOf(jResp,"workspaces[i].selected_macros[j].restriction.exf9");
Magna_5 = CkJsonObject_BoolOf(jResp,"workspaces[i].selected_macros[j].restriction.magna_5");
Nostrud_7 = CkJsonObject_BoolOf(jResp,"workspaces[i].selected_macros[j].restriction.nostrud_7");
Ex69c = CkJsonObject_IntOf(jResp,"workspaces[i].selected_macros[j].restriction.ex69c");
Ut_a = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].restriction.ut_a");
Mollit__ = CkJsonObject_IntOf(jResp,"workspaces[i].selected_macros[j].restriction.mollit__");
Deseruntc_ = CkJsonObject_BoolOf(jResp,"workspaces[i].selected_macros[j].restriction.deseruntc_");
Consequatd0 = CkJsonObject_IntOf(jResp,"workspaces[i].selected_macros[j].restriction.consequatd0");
Id_4a = CkJsonObject_BoolOf(jResp,"workspaces[i].selected_macros[j].restriction.id_4a");
k = 0;
count_k = CkJsonObject_SizeOfArray(jResp,"workspaces[i].selected_macros[j].actions");
while (k < count_k) {
CkJsonObject_putK(jResp,k);
field = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].actions[k].field");
value = CkJsonObject_stringOf(jResp,"workspaces[i].selected_macros[j].actions[k].value");
k = k + 1;
}
j = j + 1;
}
i = i + 1;
}
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/workspaces
Postman Collection Item JSON
{
"name": "List Workspaces",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workspaces",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workspaces"
]
},
"description": "#### Allowed For\n\n* Admins, Agents\n"
},
"response": [
{
"name": "Success Response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workspaces",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workspaces"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"workspaces\": [\n {\n \"activated\": \"<boolean>\",\n \"apps\": [\n {\n \"ut_1\": true\n },\n {\n \"Lorem_ec\": \"ut ipsum nulla voluptate\",\n \"sed_a\": 38535010.16636646\n }\n ],\n \"conditions\": {\n \"all\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"any\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"macro_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"macros\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"position\": \"<integer>\",\n \"prefer_workspace_app_order\": \"<boolean>\",\n \"selected_macros\": [\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"elit_0\": 95926683,\n \"Loreme7\": 1915356\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n },\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"ut_2\": true,\n \"exf9\": false,\n \"magna_5\": false\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n }\n ],\n \"ticket_form_id\": \"<integer>\",\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"activated\": \"<boolean>\",\n \"apps\": [\n {\n \"laborum_\": \"esse elit mollit nulla\",\n \"dolore_72\": 44930495\n },\n {\n \"Duis_e27\": false,\n \"do_7b\": true,\n \"eu_6\": true\n }\n ],\n \"conditions\": {\n \"all\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"any\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"macro_ids\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"macros\": [\n \"<integer>\",\n \"<integer>\"\n ],\n \"position\": \"<integer>\",\n \"prefer_workspace_app_order\": \"<boolean>\",\n \"selected_macros\": [\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"nostrud_7\": false,\n \"ex69c\": -43731952,\n \"ut_a\": \"anim nostrud pariatur\",\n \"mollit__\": -87941840\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n },\n {\n \"actions\": [\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n },\n {\n \"field\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"deseruntc_\": false,\n \"consequatd0\": 17786909,\n \"id_4a\": false\n },\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\",\n \"app_installation\": \"<string>\",\n \"categories\": \"<string>\",\n \"permissions\": \"<string>\",\n \"usage_1h\": \"<integer>\",\n \"usage_7d\": \"<integer>\",\n \"usage_24h\": \"<integer>\",\n \"usage_30d\": \"<integer>\"\n }\n ],\n \"ticket_form_id\": \"<integer>\",\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ],\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\"\n}"
}
]
}
