C++ / Support API / List Views - Compact
Back to Collection Items
#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http;
bool success;
http.put_BasicAuth(true);
http.put_Login("login");
http.put_Password("password");
http.SetRequestHeader("Accept","application/json");
CkStringBuilder sbResponseBody;
success = http.QuickGetSb("https://example.zendesk.com/api/v2/views/compact",sbResponseBody);
if (success == false) {
std::cout << http.lastErrorText() << "\r\n";
return;
}
CkJsonObject jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
std::cout << "Response Body:" << "\r\n";
std::cout << jResp.emit() << "\r\n";
int respStatusCode = http.get_LastStatus();
std::cout << "Response Status Code = " << respStatusCode << "\r\n";
if (respStatusCode >= 400) {
std::cout << "Response Header:" << "\r\n";
std::cout << http.lastHeader() << "\r\n";
std::cout << "Failed." << "\r\n";
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "count": "<integer>",
// "next_page": "<string>",
// "previous_page": "<string>",
// "views": [
// {
// "active": "<boolean>",
// "conditions": {
// "amet_b2": "minim et Ut aliquip",
// "pariatur_d74": true,
// "eiusmodd7e": 16274866
// },
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "execution": {
// "sit_bd1": -70845421.92699432,
// "voluptated": -13477997
// },
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "officia_1c": -36345253.13616539
// },
// "title": "<string>",
// "updated_at": "<dateTime>"
// },
// {
// "active": "<boolean>",
// "conditions": {
// "do_99": 75108528,
// "aliqua_ad": true,
// "dolore277": 23927228,
// "labore0": "incididunt ut dolor"
// },
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "execution": {
// "deserunt00": 61902530,
// "velit_90": "consectetur in Excepteur"
// },
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "dolor_58": -88642742.97884612,
// "sed_41": "commodo ut"
// },
// "title": "<string>",
// "updated_at": "<dateTime>"
// }
// ]
// }
// 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 char *active = 0;
const char *Amet_b2 = 0;
bool Pariatur_d74;
int Eiusmodd7e;
const char *created_at = 0;
const char *default = 0;
const char *description = 0;
const char *Sit_bd1 = 0;
int Voluptated;
const char *id = 0;
const char *position = 0;
const char *Officia_1c = 0;
const char *title = 0;
const char *updated_at = 0;
int Do_99;
bool Aliqua_ad;
int Dolore277;
const char *Labore0 = 0;
int Deserunt00;
const char *Velit_90 = 0;
const char *Dolor_58 = 0;
const char *Sed_41 = 0;
const char *count = jResp.stringOf("count");
const char *next_page = jResp.stringOf("next_page");
const char *previous_page = jResp.stringOf("previous_page");
int i = 0;
int count_i = jResp.SizeOfArray("views");
while (i < count_i) {
jResp.put_I(i);
active = jResp.stringOf("views[i].active");
Amet_b2 = jResp.stringOf("views[i].conditions.amet_b2");
Pariatur_d74 = jResp.BoolOf("views[i].conditions.pariatur_d74");
Eiusmodd7e = jResp.IntOf("views[i].conditions.eiusmodd7e");
created_at = jResp.stringOf("views[i].created_at");
default = jResp.stringOf("views[i].default");
description = jResp.stringOf("views[i].description");
Sit_bd1 = jResp.stringOf("views[i].execution.sit_bd1");
Voluptated = jResp.IntOf("views[i].execution.voluptated");
id = jResp.stringOf("views[i].id");
position = jResp.stringOf("views[i].position");
Officia_1c = jResp.stringOf("views[i].restriction.officia_1c");
title = jResp.stringOf("views[i].title");
updated_at = jResp.stringOf("views[i].updated_at");
Do_99 = jResp.IntOf("views[i].conditions.do_99");
Aliqua_ad = jResp.BoolOf("views[i].conditions.aliqua_ad");
Dolore277 = jResp.IntOf("views[i].conditions.dolore277");
Labore0 = jResp.stringOf("views[i].conditions.labore0");
Deserunt00 = jResp.IntOf("views[i].execution.deserunt00");
Velit_90 = jResp.stringOf("views[i].execution.velit_90");
Dolor_58 = jResp.stringOf("views[i].restriction.dolor_58");
Sed_41 = jResp.stringOf("views[i].restriction.sed_41");
i = i + 1;
}
}
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/views/compact
Postman Collection Item JSON
{
"name": "List Views - Compact",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/views/compact",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"views",
"compact"
]
},
"description": "A compacted list of shared and personal views available to the current user. This endpoint never returns more than 32 records and does not respect the \"per_page\" option.\n\n#### Allowed For\n\n* 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/views/compact",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"views",
"compact"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\",\n \"views\": [\n {\n \"active\": \"<boolean>\",\n \"conditions\": {\n \"amet_b2\": \"minim et Ut aliquip\",\n \"pariatur_d74\": true,\n \"eiusmodd7e\": 16274866\n },\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"execution\": {\n \"sit_bd1\": -70845421.92699432,\n \"voluptated\": -13477997\n },\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"officia_1c\": -36345253.13616539\n },\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\"\n },\n {\n \"active\": \"<boolean>\",\n \"conditions\": {\n \"do_99\": 75108528,\n \"aliqua_ad\": true,\n \"dolore277\": 23927228,\n \"labore0\": \"incididunt ut dolor\"\n },\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"execution\": {\n \"deserunt00\": 61902530,\n \"velit_90\": \"consectetur in Excepteur\"\n },\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"dolor_58\": -88642742.97884612,\n \"sed_41\": \"commodo ut\"\n },\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\"\n }\n ]\n}"
}
]
}
