C / Support API / List OLA Policies
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 *title;
const char *created_at;
const char *description;
const char *id;
const char *position;
const char *updated_at;
const char *url;
int j;
int count_j;
const char *field;
const char *operator;
const char *value;
const char *business_hours;
const char *metric;
const char *priority;
const char *target;
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/olas/policies",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)
// {
// "count": "<integer>",
// "next_page": "<string>",
// "ola_policies": [
// {
// "title": "<string>",
// "filter": {
// "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>",
// "policy_metrics": [
// {
// "business_hours": "<boolean>",
// "metric": "<string>",
// "priority": "<string>",
// "target": "<integer>"
// },
// {
// "business_hours": "<boolean>",
// "metric": "<string>",
// "priority": "<string>",
// "target": "<integer>"
// }
// ],
// "position": "<integer>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// },
// {
// "title": "<string>",
// "filter": {
// "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>",
// "policy_metrics": [
// {
// "business_hours": "<boolean>",
// "metric": "<string>",
// "priority": "<string>",
// "target": "<integer>"
// },
// {
// "business_hours": "<boolean>",
// "metric": "<string>",
// "priority": "<string>",
// "target": "<integer>"
// }
// ],
// "position": "<integer>",
// "updated_at": "<dateTime>",
// "url": "<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,"ola_policies");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
title = CkJsonObject_stringOf(jResp,"ola_policies[i].title");
created_at = CkJsonObject_stringOf(jResp,"ola_policies[i].created_at");
description = CkJsonObject_stringOf(jResp,"ola_policies[i].description");
id = CkJsonObject_stringOf(jResp,"ola_policies[i].id");
position = CkJsonObject_stringOf(jResp,"ola_policies[i].position");
updated_at = CkJsonObject_stringOf(jResp,"ola_policies[i].updated_at");
url = CkJsonObject_stringOf(jResp,"ola_policies[i].url");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"ola_policies[i].filter.all");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
field = CkJsonObject_stringOf(jResp,"ola_policies[i].filter.all[j].field");
operator = CkJsonObject_stringOf(jResp,"ola_policies[i].filter.all[j].operator");
value = CkJsonObject_stringOf(jResp,"ola_policies[i].filter.all[j].value");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"ola_policies[i].filter.any");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
field = CkJsonObject_stringOf(jResp,"ola_policies[i].filter.any[j].field");
operator = CkJsonObject_stringOf(jResp,"ola_policies[i].filter.any[j].operator");
value = CkJsonObject_stringOf(jResp,"ola_policies[i].filter.any[j].value");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"ola_policies[i].policy_metrics");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
business_hours = CkJsonObject_stringOf(jResp,"ola_policies[i].policy_metrics[j].business_hours");
metric = CkJsonObject_stringOf(jResp,"ola_policies[i].policy_metrics[j].metric");
priority = CkJsonObject_stringOf(jResp,"ola_policies[i].policy_metrics[j].priority");
target = CkJsonObject_stringOf(jResp,"ola_policies[i].policy_metrics[j].target");
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/olas/policies
Postman Collection Item JSON
{
"name": "List OLA Policies",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/olas/policies",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"olas",
"policies"
]
},
"description": "#### Allowed For\n\n* Admins\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/olas/policies",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"olas",
"policies"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"ola_policies\": [\n {\n \"title\": \"<string>\",\n \"filter\": {\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 \"policy_metrics\": [\n {\n \"business_hours\": \"<boolean>\",\n \"metric\": \"<string>\",\n \"priority\": \"<string>\",\n \"target\": \"<integer>\"\n },\n {\n \"business_hours\": \"<boolean>\",\n \"metric\": \"<string>\",\n \"priority\": \"<string>\",\n \"target\": \"<integer>\"\n }\n ],\n \"position\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"title\": \"<string>\",\n \"filter\": {\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 \"policy_metrics\": [\n {\n \"business_hours\": \"<boolean>\",\n \"metric\": \"<string>\",\n \"priority\": \"<string>\",\n \"target\": \"<integer>\"\n },\n {\n \"business_hours\": \"<boolean>\",\n \"metric\": \"<string>\",\n \"priority\": \"<string>\",\n \"target\": \"<integer>\"\n }\n ],\n \"position\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ],\n \"previous_page\": \"<string>\"\n}"
}
]
}
