C++ / Support API / List Trigger Categories
Back to Collection Items
#include <CkHttp.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.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");
CkJsonObject queryParams;
queryParams.UpdateString("page[after]","<string>");
queryParams.UpdateString("page[before]","<string>");
queryParams.UpdateString("page[size]","<integer>");
queryParams.UpdateString("sort","-updated_at");
queryParams.UpdateString("include","rule_counts");
http.SetRequestHeader("Accept","application/json");
CkHttpResponse *resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/trigger_categories",queryParams);
if (http.get_LastMethodSuccess() == false) {
std::cout << http.lastErrorText() << "\r\n";
return;
}
CkStringBuilder sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonObject jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
std::cout << "Response Body:" << "\r\n";
std::cout << jResp.emit() << "\r\n";
int respStatusCode = resp->get_StatusCode();
std::cout << "Response Status Code = " << respStatusCode << "\r\n";
if (respStatusCode >= 400) {
std::cout << "Response Header:" << "\r\n";
std::cout << resp->header() << "\r\n";
std::cout << "Failed." << "\r\n";
delete resp;
return;
}
delete resp;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "trigger_categories": [
// {
// "active_count": "<long>",
// "inactive_count": "<long>"
// },
// {
// "active_count": "<long>",
// "inactive_count": "<long>"
// }
// ],
// "links": {
// "next": "<string>",
// "prev": "<string>"
// },
// "meta": {
// "after_cursor": "<string>",
// "before_cursor": "<string>",
// "has_more": "<boolean>"
// }
// }
// 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_count = 0;
const char *inactive_count = 0;
const char *v_Next = jResp.stringOf("links.next");
const char *Prev = jResp.stringOf("links.prev");
const char *After_cursor = jResp.stringOf("meta.after_cursor");
const char *Before_cursor = jResp.stringOf("meta.before_cursor");
const char *Has_more = jResp.stringOf("meta.has_more");
int i = 0;
int count_i = jResp.SizeOfArray("trigger_categories");
while (i < count_i) {
jResp.put_I(i);
active_count = jResp.stringOf("trigger_categories[i].active_count");
inactive_count = jResp.stringOf("trigger_categories[i].inactive_count");
i = i + 1;
}
}
Curl Command
curl -u login:password -G -d "page[after]=%3Cstring%3E"
-d "page[before]=%3Cstring%3E"
-d "page[size]=%3Cinteger%3E"
-d "sort=-updated_at"
-d "include=rule_counts"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/trigger_categories
Postman Collection Item JSON
{
"name": "List Trigger Categories",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/trigger_categories?page[after]=<string>&page[before]=<string>&page[size]=<integer>&sort=-updated_at&include=rule_counts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"trigger_categories"
],
"query": [
{
"key": "page[after]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[before]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "Pagination parameters"
},
{
"key": "sort",
"value": "-updated_at",
"description": "Sort parameters"
},
{
"key": "include",
"value": "rule_counts",
"description": "Allowed sideloads"
}
]
},
"description": "Returns all the trigger categories in the account."
},
"response": [
{
"name": "A paged array of trigger categories",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/trigger_categories?page[after]=<string>&page[before]=<string>&page[size]=<integer>&sort=-updated_at&include=rule_counts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"trigger_categories"
],
"query": [
{
"key": "page[after]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[before]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "Pagination parameters"
},
{
"key": "sort",
"value": "-updated_at",
"description": "Sort parameters"
},
{
"key": "include",
"value": "rule_counts",
"description": "Allowed sideloads"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"trigger_categories\": [\n {\n \"active_count\": \"<long>\",\n \"inactive_count\": \"<long>\"\n },\n {\n \"active_count\": \"<long>\",\n \"inactive_count\": \"<long>\"\n }\n ],\n \"links\": {\n \"next\": \"<string>\",\n \"prev\": \"<string>\"\n },\n \"meta\": {\n \"after_cursor\": \"<string>\",\n \"before_cursor\": \"<string>\",\n \"has_more\": \"<boolean>\"\n }\n}"
},
{
"name": "Error",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/trigger_categories?page[after]=<string>&page[before]=<string>&page[size]=<integer>&sort=-updated_at&include=rule_counts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"trigger_categories"
],
"query": [
{
"key": "page[after]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[before]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "Pagination parameters"
},
{
"key": "sort",
"value": "-updated_at",
"description": "Sort parameters"
},
{
"key": "include",
"value": "rule_counts",
"description": "Allowed sideloads"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Error",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/trigger_categories?page[after]=<string>&page[before]=<string>&page[size]=<integer>&sort=-updated_at&include=rule_counts",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"trigger_categories"
],
"query": [
{
"key": "page[after]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[before]",
"value": "<string>",
"description": "Pagination parameters"
},
{
"key": "page[size]",
"value": "<integer>",
"description": "Pagination parameters"
},
{
"key": "sort",
"value": "-updated_at",
"description": "Sort parameters"
},
{
"key": "include",
"value": "rule_counts",
"description": "Allowed sideloads"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n },\n {\n \"code\": \"<string>\",\n \"title\": \"<string>\",\n \"detail\": \"<string>\",\n \"id\": \"<string>\",\n \"links\": {},\n \"source\": {},\n \"status\": \"<string>\"\n }\n ]\n}"
}
]
}
