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;
BOOL ad_be;
int ead07;
BOOL adipisicinga;
BOOL fugiat_e;
const char *dolorf7;
const char *field;
const char *operator;
const char *value;
const char *strVal;
const char *title;
const char *active;
const char *created_at;
const char *default;
const char *description;
const char *id;
const char *position;
BOOL In_f25;
const char *Nisid81;
BOOL Minim_886;
const char *updated_at;
const char *url;
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 Culpa__d7;
BOOL Ad7;
const char *Esse0;
int Veniam_f;
int j;
int count_j;
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 *v_Url;
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/:workspace_id",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)
// {
// "workspace": {
// "activated": "<boolean>",
// "apps": [
// {
// "ad_be": true,
// "ead07": 69455617,
// "adipisicinga": true
// },
// {
// "fugiat_e": false,
// "dolorf7": -57129708.70016649
// }
// ],
// "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": {
// "in_f25": true,
// "nisid81": "reprehenderit anim nostrud id",
// "minim_886": 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>"
// },
// {
// "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": {
// "culpa__d7": false,
// "ad7": true,
// "esse0": -82046233.9137964,
// "veniam_f": -91185504
// },
// "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>"
// }
// }
// 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.
Activated = CkJsonObject_stringOf(jResp,"workspace.activated");
Created_at = CkJsonObject_stringOf(jResp,"workspace.created_at");
Description = CkJsonObject_stringOf(jResp,"workspace.description");
Id = CkJsonObject_stringOf(jResp,"workspace.id");
Position = CkJsonObject_stringOf(jResp,"workspace.position");
Prefer_workspace_app_order = CkJsonObject_stringOf(jResp,"workspace.prefer_workspace_app_order");
Ticket_form_id = CkJsonObject_stringOf(jResp,"workspace.ticket_form_id");
Title = CkJsonObject_stringOf(jResp,"workspace.title");
Updated_at = CkJsonObject_stringOf(jResp,"workspace.updated_at");
v_Url = CkJsonObject_stringOf(jResp,"workspace.url");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"workspace.apps");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
ad_be = CkJsonObject_BoolOf(jResp,"workspace.apps[i].ad_be");
ead07 = CkJsonObject_IntOf(jResp,"workspace.apps[i].ead07");
adipisicinga = CkJsonObject_BoolOf(jResp,"workspace.apps[i].adipisicinga");
fugiat_e = CkJsonObject_BoolOf(jResp,"workspace.apps[i].fugiat_e");
dolorf7 = CkJsonObject_stringOf(jResp,"workspace.apps[i].dolorf7");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"workspace.conditions.all");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
field = CkJsonObject_stringOf(jResp,"workspace.conditions.all[i].field");
operator = CkJsonObject_stringOf(jResp,"workspace.conditions.all[i].operator");
value = CkJsonObject_stringOf(jResp,"workspace.conditions.all[i].value");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"workspace.conditions.any");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
field = CkJsonObject_stringOf(jResp,"workspace.conditions.any[i].field");
operator = CkJsonObject_stringOf(jResp,"workspace.conditions.any[i].operator");
value = CkJsonObject_stringOf(jResp,"workspace.conditions.any[i].value");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"workspace.macro_ids");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"workspace.macro_ids[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"workspace.macros");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"workspace.macros[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"workspace.selected_macros");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
title = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].title");
active = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].active");
created_at = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].created_at");
default = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].default");
description = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].description");
id = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].id");
position = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].position");
In_f25 = CkJsonObject_BoolOf(jResp,"workspace.selected_macros[i].restriction.in_f25");
Nisid81 = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].restriction.nisid81");
Minim_886 = CkJsonObject_BoolOf(jResp,"workspace.selected_macros[i].restriction.minim_886");
updated_at = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].updated_at");
url = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].url");
app_installation = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].app_installation");
categories = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].categories");
permissions = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].permissions");
usage_1h = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].usage_1h");
usage_7d = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].usage_7d");
usage_24h = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].usage_24h");
usage_30d = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].usage_30d");
Culpa__d7 = CkJsonObject_BoolOf(jResp,"workspace.selected_macros[i].restriction.culpa__d7");
Ad7 = CkJsonObject_BoolOf(jResp,"workspace.selected_macros[i].restriction.ad7");
Esse0 = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].restriction.esse0");
Veniam_f = CkJsonObject_IntOf(jResp,"workspace.selected_macros[i].restriction.veniam_f");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"workspace.selected_macros[i].actions");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
field = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].actions[j].field");
value = CkJsonObject_stringOf(jResp,"workspace.selected_macros[i].actions[j].value");
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/:workspace_id
Postman Collection Item JSON
{
"name": "Show Workspace",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/workspaces/:workspace_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workspaces",
":workspace_id"
],
"variable": [
{
"key": "workspace_id",
"value": "<integer>"
}
]
},
"description": "#### Allowed For\n* Admins\n"
},
"response": [
{
"name": "Successful 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/:workspace_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"workspaces",
":workspace_id"
],
"variable": [
{
"key": "workspace_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"workspace\": {\n \"activated\": \"<boolean>\",\n \"apps\": [\n {\n \"ad_be\": true,\n \"ead07\": 69455617,\n \"adipisicinga\": true\n },\n {\n \"fugiat_e\": false,\n \"dolorf7\": -57129708.70016649\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 \"in_f25\": true,\n \"nisid81\": \"reprehenderit anim nostrud id\",\n \"minim_886\": 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 \"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 \"culpa__d7\": false,\n \"ad7\": true,\n \"esse0\": -82046233.9137964,\n \"veniam_f\": -91185504\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}"
}
]
}
