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 *project_id;
const char *resource;
const char *target_url;
const char *title;
const char *token;
const char *v_type;
const char *active;
const char *created_at;
const char *id;
const char *message_id;
const char *password;
const char *todo_list_id;
const char *username;
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/targets",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)
// {
// "targets": [
// {
// "project_id": "<string>",
// "resource": "<string>",
// "target_url": "<string>",
// "title": "<string>",
// "token": "<string>",
// "type": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "id": "<integer>",
// "message_id": "<string>",
// "password": "<string>",
// "todo_list_id": "<string>",
// "username": "<string>"
// },
// {
// "project_id": "<string>",
// "resource": "<string>",
// "target_url": "<string>",
// "title": "<string>",
// "token": "<string>",
// "type": "<string>",
// "active": "<boolean>",
// "created_at": "<dateTime>",
// "id": "<integer>",
// "message_id": "<string>",
// "password": "<string>",
// "todo_list_id": "<string>",
// "username": "<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,"targets");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
project_id = CkJsonObject_stringOf(jResp,"targets[i].project_id");
resource = CkJsonObject_stringOf(jResp,"targets[i].resource");
target_url = CkJsonObject_stringOf(jResp,"targets[i].target_url");
title = CkJsonObject_stringOf(jResp,"targets[i].title");
token = CkJsonObject_stringOf(jResp,"targets[i].token");
v_type = CkJsonObject_stringOf(jResp,"targets[i].type");
active = CkJsonObject_stringOf(jResp,"targets[i].active");
created_at = CkJsonObject_stringOf(jResp,"targets[i].created_at");
id = CkJsonObject_stringOf(jResp,"targets[i].id");
message_id = CkJsonObject_stringOf(jResp,"targets[i].message_id");
password = CkJsonObject_stringOf(jResp,"targets[i].password");
todo_list_id = CkJsonObject_stringOf(jResp,"targets[i].todo_list_id");
username = CkJsonObject_stringOf(jResp,"targets[i].username");
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/targets
Postman Collection Item JSON
{
"name": "List Targets",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/targets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"targets"
]
},
"description": "#### 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/targets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"targets"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"targets\": [\n {\n \"project_id\": \"<string>\",\n \"resource\": \"<string>\",\n \"target_url\": \"<string>\",\n \"title\": \"<string>\",\n \"token\": \"<string>\",\n \"type\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"message_id\": \"<string>\",\n \"password\": \"<string>\",\n \"todo_list_id\": \"<string>\",\n \"username\": \"<string>\"\n },\n {\n \"project_id\": \"<string>\",\n \"resource\": \"<string>\",\n \"target_url\": \"<string>\",\n \"title\": \"<string>\",\n \"token\": \"<string>\",\n \"type\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"message_id\": \"<string>\",\n \"password\": \"<string>\",\n \"todo_list_id\": \"<string>\",\n \"username\": \"<string>\"\n }\n ]\n}"
}
]
}