C / Support API / List Routing Attribute Definitions
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 *v_Type;
const char *Conditions_allType;
const char *ItemsType;
const char *SubjectType;
const char *Default;
const char *TitleType;
const char *TitleDefault;
int MaxItems;
const char *Conditions_anyType;
const char *SubjectDefault;
int Conditions_anyMaxItems;
// 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/routing/attributes/definitions",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)
// {
// "definitions": {
// "type": "object",
// "properties": {
// "conditions_all": {
// "type": "array",
// "items": {
// "type": "object",
// "properties": {
// "subject": {
// "type": "string",
// "default": "<string>"
// },
// "title": {
// "type": "string",
// "default": "<string>"
// }
// }
// },
// "maxItems": 2
// },
// "conditions_any": {
// "type": "array",
// "items": {
// "type": "object",
// "properties": {
// "subject": {
// "type": "string",
// "default": "<string>"
// },
// "title": {
// "type": "string",
// "default": "<string>"
// }
// }
// },
// "maxItems": 2
// }
// }
// }
// }
// 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.
v_Type = CkJsonObject_stringOf(jResp,"definitions.type");
Conditions_allType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.type");
ItemsType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.type");
SubjectType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.subject.type");
Default = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.subject.default");
TitleType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.title.type");
TitleDefault = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_all.items.properties.title.default");
MaxItems = CkJsonObject_IntOf(jResp,"definitions.properties.conditions_all.maxItems");
Conditions_anyType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_any.type");
ItemsType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_any.items.type");
SubjectType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_any.items.properties.subject.type");
SubjectDefault = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_any.items.properties.subject.default");
TitleType = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_any.items.properties.title.type");
TitleDefault = CkJsonObject_stringOf(jResp,"definitions.properties.conditions_any.items.properties.title.default");
Conditions_anyMaxItems = CkJsonObject_IntOf(jResp,"definitions.properties.conditions_any.maxItems");
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/routing/attributes/definitions
Postman Collection Item JSON
{
"name": "List Routing Attribute Definitions",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/routing/attributes/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"routing",
"attributes",
"definitions"
]
},
"description": "Returns the condition definitions that can be configured to apply attributes to a ticket.\n\n#### 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/routing/attributes/definitions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"routing",
"attributes",
"definitions"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"definitions\": {\n \"type\": \"object\",\n \"properties\": {\n \"conditions_all\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"subject\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n },\n \"conditions_any\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"subject\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n },\n \"title\": {\n \"type\": \"string\",\n \"default\": \"<string>\"\n }\n }\n },\n \"maxItems\": 2\n }\n }\n }\n}"
}
]
}