Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject queryParams;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *name;
const char *default_locale_id;
const char *created_at;
const char *id;
const char *outdated;
const char *placeholder;
const char *updated_at;
const char *url;
int j;
int count_j;
const char *content;
const char *locale_id;
const char *active;
const char *default;
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");
queryParams = CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,"identifiers","<string>");
CkHttp_SetRequestHeader(http,"Accept","application/json");
resp = CkHttp_QuickRequestParams(http,"GET","https://example.zendesk.com/api/v2/dynamic_content/items/show_many",queryParams);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "items": [
// {
// "name": "<string>",
// "default_locale_id": "<integer>",
// "variants": [
// {
// "content": "<string>",
// "locale_id": "<integer>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// },
// {
// "content": "<string>",
// "locale_id": "<integer>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// ],
// "created_at": "<dateTime>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "placeholder": "<string>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// },
// {
// "name": "<string>",
// "default_locale_id": "<integer>",
// "variants": [
// {
// "content": "<string>",
// "locale_id": "<integer>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// },
// {
// "content": "<string>",
// "locale_id": "<integer>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "updated_at": "<dateTime>",
// "url": "<string>"
// }
// ],
// "created_at": "<dateTime>",
// "id": "<integer>",
// "outdated": "<boolean>",
// "placeholder": "<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.
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"items");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
name = CkJsonObject_stringOf(jResp,"items[i].name");
default_locale_id = CkJsonObject_stringOf(jResp,"items[i].default_locale_id");
created_at = CkJsonObject_stringOf(jResp,"items[i].created_at");
id = CkJsonObject_stringOf(jResp,"items[i].id");
outdated = CkJsonObject_stringOf(jResp,"items[i].outdated");
placeholder = CkJsonObject_stringOf(jResp,"items[i].placeholder");
updated_at = CkJsonObject_stringOf(jResp,"items[i].updated_at");
url = CkJsonObject_stringOf(jResp,"items[i].url");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"items[i].variants");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
content = CkJsonObject_stringOf(jResp,"items[i].variants[j].content");
locale_id = CkJsonObject_stringOf(jResp,"items[i].variants[j].locale_id");
active = CkJsonObject_stringOf(jResp,"items[i].variants[j].active");
created_at = CkJsonObject_stringOf(jResp,"items[i].variants[j].created_at");
default = CkJsonObject_stringOf(jResp,"items[i].variants[j].default");
id = CkJsonObject_stringOf(jResp,"items[i].variants[j].id");
outdated = CkJsonObject_stringOf(jResp,"items[i].variants[j].outdated");
updated_at = CkJsonObject_stringOf(jResp,"items[i].variants[j].updated_at");
url = CkJsonObject_stringOf(jResp,"items[i].variants[j].url");
j = j + 1;
}
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -u login:password -G -d "identifiers=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/dynamic_content/items/show_many
Postman Collection Item JSON
{
"name": "Show Many Items",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/dynamic_content/items/show_many?identifiers=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dynamic_content",
"items",
"show_many"
],
"query": [
{
"key": "identifiers",
"value": "<string>",
"description": "Identifiers for the dynamic contents"
}
]
},
"description": "#### Stability\n\n* Development\n\n#### Allowed For\n\n* Admins, 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/dynamic_content/items/show_many?identifiers=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"dynamic_content",
"items",
"show_many"
],
"query": [
{
"key": "identifiers",
"value": "<string>",
"description": "Identifiers for the dynamic contents"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"items\": [\n {\n \"name\": \"<string>\",\n \"default_locale_id\": \"<integer>\",\n \"variants\": [\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ],\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"placeholder\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"default_locale_id\": \"<integer>\",\n \"variants\": [\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"content\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ],\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"outdated\": \"<boolean>\",\n \"placeholder\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
