unicodeC / Support API / List Tickets
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *requester_id;
const wchar_t *allow_attachments;
const wchar_t *allow_channelback;
const wchar_t *assignee_email;
const wchar_t *assignee_id;
const wchar_t *attribute_value_ids;
const wchar_t *brand_id;
const wchar_t *collaborator_ids;
const wchar_t *created_at;
const wchar_t *custom_fields;
const wchar_t *custom_status_id;
const wchar_t *description;
const wchar_t *due_at;
const wchar_t *email_cc_ids;
const wchar_t *external_id;
const wchar_t *follower_ids;
const wchar_t *followup_ids;
const wchar_t *forum_topic_id;
const wchar_t *from_messaging_channel;
const wchar_t *group_id;
const wchar_t *has_incidents;
const wchar_t *id;
const wchar_t *is_public;
const wchar_t *macro_id;
const wchar_t *macro_ids;
const wchar_t *organization_id;
const wchar_t *priority;
const wchar_t *problem_id;
const wchar_t *raw_subject;
const wchar_t *recipient;
const wchar_t *safe_update;
const wchar_t *Magnaae;
BOOL Nisi19;
const wchar_t *sharing_agreement_ids;
const wchar_t *status;
const wchar_t *subject;
const wchar_t *submitter_id;
const wchar_t *tags;
const wchar_t *ticket_form_id;
const wchar_t *v_type;
const wchar_t *updated_at;
const wchar_t *updated_stamp;
const wchar_t *url;
const wchar_t *Channel;
const wchar_t *Veniam_79;
const wchar_t *via_followup_source_id;
const wchar_t *via_id;
int Eu_b;
const wchar_t *Id2;
int Eiusmod_13;
const wchar_t *Occaecat1db;
int j;
int count_j;
const wchar_t *email;
const wchar_t *name;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
CkHttpW_putBasicAuth(http,TRUE);
CkHttpW_putLogin(http,L"login");
CkHttpW_putPassword(http,L"password");
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(queryParams,L"external_id",L"<string>");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://example.zendesk.com/api/v2/tickets",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "tickets": [
// {
// "requester_id": "<integer>",
// "allow_attachments": "<boolean>",
// "allow_channelback": "<boolean>",
// "assignee_email": "<string>",
// "assignee_id": "<integer>",
// "attribute_value_ids": "<array>",
// "brand_id": "<integer>",
// "collaborator_ids": "<array>",
// "collaborators": [
// {
// "email": "<email>",
// "name": "<string>"
// },
// {
// "email": "<email>",
// "name": "<string>"
// }
// ],
// "comment": {},
// "created_at": "<dateTime>",
// "custom_fields": "<array>",
// "custom_status_id": "<integer>",
// "description": "<string>",
// "due_at": "<dateTime>",
// "email_cc_ids": "<array>",
// "email_ccs": {},
// "external_id": "<string>",
// "follower_ids": "<array>",
// "followers": {},
// "followup_ids": "<array>",
// "forum_topic_id": "<integer>",
// "from_messaging_channel": "<boolean>",
// "group_id": "<integer>",
// "has_incidents": "<boolean>",
// "id": "<integer>",
// "is_public": "<boolean>",
// "macro_id": "<integer>",
// "macro_ids": "<array>",
// "metadata": {},
// "organization_id": "<integer>",
// "priority": "normal",
// "problem_id": "<integer>",
// "raw_subject": "<string>",
// "recipient": "<string>",
// "requester": {},
// "safe_update": "<boolean>",
// "satisfaction_rating": {
// "magnaae": 84328139.5577608,
// "nisi19": true
// },
// "sharing_agreement_ids": "<array>",
// "status": "new",
// "subject": "<string>",
// "submitter_id": "<integer>",
// "tags": "<array>",
// "ticket_form_id": "<integer>",
// "type": "question",
// "updated_at": "<dateTime>",
// "updated_stamp": "<string>",
// "url": "<string>",
// "via": {
// "channel": "<string>",
// "source": {
// "veniam_79": 90804961.49951228
// }
// },
// "via_followup_source_id": "<integer>",
// "via_id": "<integer>",
// "voice_comment": {}
// },
// {
// "requester_id": "<integer>",
// "allow_attachments": "<boolean>",
// "allow_channelback": "<boolean>",
// "assignee_email": "<string>",
// "assignee_id": "<integer>",
// "attribute_value_ids": "<array>",
// "brand_id": "<integer>",
// "collaborator_ids": "<array>",
// "collaborators": [
// {
// "email": "<email>",
// "name": "<string>"
// },
// {
// "email": "<email>",
// "name": "<string>"
// }
// ],
// "comment": {},
// "created_at": "<dateTime>",
// "custom_fields": "<array>",
// "custom_status_id": "<integer>",
// "description": "<string>",
// "due_at": "<dateTime>",
// "email_cc_ids": "<array>",
// "email_ccs": {},
// "external_id": "<string>",
// "follower_ids": "<array>",
// "followers": {},
// "followup_ids": "<array>",
// "forum_topic_id": "<integer>",
// "from_messaging_channel": "<boolean>",
// "group_id": "<integer>",
// "has_incidents": "<boolean>",
// "id": "<integer>",
// "is_public": "<boolean>",
// "macro_id": "<integer>",
// "macro_ids": "<array>",
// "metadata": {},
// "organization_id": "<integer>",
// "priority": "high",
// "problem_id": "<integer>",
// "raw_subject": "<string>",
// "recipient": "<string>",
// "requester": {},
// "safe_update": "<boolean>",
// "satisfaction_rating": {
// "eu_b": 33777312
// },
// "sharing_agreement_ids": "<array>",
// "status": "hold",
// "subject": "<string>",
// "submitter_id": "<integer>",
// "tags": "<array>",
// "ticket_form_id": "<integer>",
// "type": "incident",
// "updated_at": "<dateTime>",
// "updated_stamp": "<string>",
// "url": "<string>",
// "via": {
// "channel": "<string>",
// "source": {
// "id2": "cillum minim et",
// "eiusmod_13": -64405368,
// "occaecat1db": 1792444.0305951983
// }
// },
// "via_followup_source_id": "<integer>",
// "via_id": "<integer>",
// "voice_comment": {}
// }
// ]
// }
// 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 = CkJsonObjectW_SizeOfArray(jResp,L"tickets");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
requester_id = CkJsonObjectW_stringOf(jResp,L"tickets[i].requester_id");
allow_attachments = CkJsonObjectW_stringOf(jResp,L"tickets[i].allow_attachments");
allow_channelback = CkJsonObjectW_stringOf(jResp,L"tickets[i].allow_channelback");
assignee_email = CkJsonObjectW_stringOf(jResp,L"tickets[i].assignee_email");
assignee_id = CkJsonObjectW_stringOf(jResp,L"tickets[i].assignee_id");
attribute_value_ids = CkJsonObjectW_stringOf(jResp,L"tickets[i].attribute_value_ids");
brand_id = CkJsonObjectW_stringOf(jResp,L"tickets[i].brand_id");
collaborator_ids = CkJsonObjectW_stringOf(jResp,L"tickets[i].collaborator_ids");
created_at = CkJsonObjectW_stringOf(jResp,L"tickets[i].created_at");
custom_fields = CkJsonObjectW_stringOf(jResp,L"tickets[i].custom_fields");
custom_status_id = CkJsonObjectW_stringOf(jResp,L"tickets[i].custom_status_id");
description = CkJsonObjectW_stringOf(jResp,L"tickets[i].description");
due_at = CkJsonObjectW_stringOf(jResp,L"tickets[i].due_at");
email_cc_ids = CkJsonObjectW_stringOf(jResp,L"tickets[i].email_cc_ids");
external_id = CkJsonObjectW_stringOf(jResp,L"tickets[i].external_id");
follower_ids = CkJsonObjectW_stringOf(jResp,L"tickets[i].follower_ids");
followup_ids = CkJsonObjectW_stringOf(jResp,L"tickets[i].followup_ids");
forum_topic_id = CkJsonObjectW_stringOf(jResp,L"tickets[i].forum_topic_id");
from_messaging_channel = CkJsonObjectW_stringOf(jResp,L"tickets[i].from_messaging_channel");
group_id = CkJsonObjectW_stringOf(jResp,L"tickets[i].group_id");
has_incidents = CkJsonObjectW_stringOf(jResp,L"tickets[i].has_incidents");
id = CkJsonObjectW_stringOf(jResp,L"tickets[i].id");
is_public = CkJsonObjectW_stringOf(jResp,L"tickets[i].is_public");
macro_id = CkJsonObjectW_stringOf(jResp,L"tickets[i].macro_id");
macro_ids = CkJsonObjectW_stringOf(jResp,L"tickets[i].macro_ids");
organization_id = CkJsonObjectW_stringOf(jResp,L"tickets[i].organization_id");
priority = CkJsonObjectW_stringOf(jResp,L"tickets[i].priority");
problem_id = CkJsonObjectW_stringOf(jResp,L"tickets[i].problem_id");
raw_subject = CkJsonObjectW_stringOf(jResp,L"tickets[i].raw_subject");
recipient = CkJsonObjectW_stringOf(jResp,L"tickets[i].recipient");
safe_update = CkJsonObjectW_stringOf(jResp,L"tickets[i].safe_update");
Magnaae = CkJsonObjectW_stringOf(jResp,L"tickets[i].satisfaction_rating.magnaae");
Nisi19 = CkJsonObjectW_BoolOf(jResp,L"tickets[i].satisfaction_rating.nisi19");
sharing_agreement_ids = CkJsonObjectW_stringOf(jResp,L"tickets[i].sharing_agreement_ids");
status = CkJsonObjectW_stringOf(jResp,L"tickets[i].status");
subject = CkJsonObjectW_stringOf(jResp,L"tickets[i].subject");
submitter_id = CkJsonObjectW_stringOf(jResp,L"tickets[i].submitter_id");
tags = CkJsonObjectW_stringOf(jResp,L"tickets[i].tags");
ticket_form_id = CkJsonObjectW_stringOf(jResp,L"tickets[i].ticket_form_id");
v_type = CkJsonObjectW_stringOf(jResp,L"tickets[i].type");
updated_at = CkJsonObjectW_stringOf(jResp,L"tickets[i].updated_at");
updated_stamp = CkJsonObjectW_stringOf(jResp,L"tickets[i].updated_stamp");
url = CkJsonObjectW_stringOf(jResp,L"tickets[i].url");
Channel = CkJsonObjectW_stringOf(jResp,L"tickets[i].via.channel");
Veniam_79 = CkJsonObjectW_stringOf(jResp,L"tickets[i].via.source.veniam_79");
via_followup_source_id = CkJsonObjectW_stringOf(jResp,L"tickets[i].via_followup_source_id");
via_id = CkJsonObjectW_stringOf(jResp,L"tickets[i].via_id");
Eu_b = CkJsonObjectW_IntOf(jResp,L"tickets[i].satisfaction_rating.eu_b");
Id2 = CkJsonObjectW_stringOf(jResp,L"tickets[i].via.source.id2");
Eiusmod_13 = CkJsonObjectW_IntOf(jResp,L"tickets[i].via.source.eiusmod_13");
Occaecat1db = CkJsonObjectW_stringOf(jResp,L"tickets[i].via.source.occaecat1db");
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"tickets[i].collaborators");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
email = CkJsonObjectW_stringOf(jResp,L"tickets[i].collaborators[j].email");
name = CkJsonObjectW_stringOf(jResp,L"tickets[i].collaborators[j].name");
j = j + 1;
}
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -u login:password -G -d "external_id=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/tickets
Postman Collection Item JSON
{
"name": "List Tickets",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets?external_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets"
],
"query": [
{
"key": "external_id",
"value": "<string>",
"description": "Lists tickets by external id. External ids don't have to be unique for each ticket. As a result, the request may return multiple tickets with the same external id."
}
]
}
},
"response": [
{
"name": "List tickets",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets?external_id=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets"
],
"query": [
{
"key": "external_id",
"value": "<string>",
"description": "Lists tickets by external id. External ids don't have to be unique for each ticket. As a result, the request may return multiple tickets with the same external id."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"tickets\": [\n {\n \"requester_id\": \"<integer>\",\n \"allow_attachments\": \"<boolean>\",\n \"allow_channelback\": \"<boolean>\",\n \"assignee_email\": \"<string>\",\n \"assignee_id\": \"<integer>\",\n \"attribute_value_ids\": \"<array>\",\n \"brand_id\": \"<integer>\",\n \"collaborator_ids\": \"<array>\",\n \"collaborators\": [\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n },\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n }\n ],\n \"comment\": {},\n \"created_at\": \"<dateTime>\",\n \"custom_fields\": \"<array>\",\n \"custom_status_id\": \"<integer>\",\n \"description\": \"<string>\",\n \"due_at\": \"<dateTime>\",\n \"email_cc_ids\": \"<array>\",\n \"email_ccs\": {},\n \"external_id\": \"<string>\",\n \"follower_ids\": \"<array>\",\n \"followers\": {},\n \"followup_ids\": \"<array>\",\n \"forum_topic_id\": \"<integer>\",\n \"from_messaging_channel\": \"<boolean>\",\n \"group_id\": \"<integer>\",\n \"has_incidents\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"is_public\": \"<boolean>\",\n \"macro_id\": \"<integer>\",\n \"macro_ids\": \"<array>\",\n \"metadata\": {},\n \"organization_id\": \"<integer>\",\n \"priority\": \"normal\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"magnaae\": 84328139.5577608,\n \"nisi19\": true\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"new\",\n \"subject\": \"<string>\",\n \"submitter_id\": \"<integer>\",\n \"tags\": \"<array>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"question\",\n \"updated_at\": \"<dateTime>\",\n \"updated_stamp\": \"<string>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"veniam_79\": 90804961.49951228\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n },\n {\n \"requester_id\": \"<integer>\",\n \"allow_attachments\": \"<boolean>\",\n \"allow_channelback\": \"<boolean>\",\n \"assignee_email\": \"<string>\",\n \"assignee_id\": \"<integer>\",\n \"attribute_value_ids\": \"<array>\",\n \"brand_id\": \"<integer>\",\n \"collaborator_ids\": \"<array>\",\n \"collaborators\": [\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n },\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n }\n ],\n \"comment\": {},\n \"created_at\": \"<dateTime>\",\n \"custom_fields\": \"<array>\",\n \"custom_status_id\": \"<integer>\",\n \"description\": \"<string>\",\n \"due_at\": \"<dateTime>\",\n \"email_cc_ids\": \"<array>\",\n \"email_ccs\": {},\n \"external_id\": \"<string>\",\n \"follower_ids\": \"<array>\",\n \"followers\": {},\n \"followup_ids\": \"<array>\",\n \"forum_topic_id\": \"<integer>\",\n \"from_messaging_channel\": \"<boolean>\",\n \"group_id\": \"<integer>\",\n \"has_incidents\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"is_public\": \"<boolean>\",\n \"macro_id\": \"<integer>\",\n \"macro_ids\": \"<array>\",\n \"metadata\": {},\n \"organization_id\": \"<integer>\",\n \"priority\": \"high\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"eu_b\": 33777312\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"hold\",\n \"subject\": \"<string>\",\n \"submitter_id\": \"<integer>\",\n \"tags\": \"<array>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"incident\",\n \"updated_at\": \"<dateTime>\",\n \"updated_stamp\": \"<string>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"id2\": \"cillum minim et\",\n \"eiusmod_13\": -64405368,\n \"occaecat1db\": 1792444.0305951983\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n }\n ]\n}"
}
]
}
