unicodeC / Support API / List Ticket Skips
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 *created_at;
const wchar_t *id;
const wchar_t *reason;
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;
int In_56;
const wchar_t *Magnae7;
BOOL Deseruntc1e;
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 *v_Url;
const wchar_t *Channel;
const wchar_t *Utacc;
BOOL Enim049;
const wchar_t *In__;
int Reprehenderit_06;
const wchar_t *Via_followup_source_id;
const wchar_t *Via_id;
const wchar_t *ticket_id;
const wchar_t *updated_at;
const wchar_t *user_id;
int Velit_05;
int Tempor__e;
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"sort_order",L"asc");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://example.zendesk.com/api/v2/users/:user_id/skips",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)
// {
// "skips": [
// {
// "created_at": "<dateTime>",
// "id": "<integer>",
// "reason": "<string>",
// "ticket": {
// "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": "urgent",
// "problem_id": "<integer>",
// "raw_subject": "<string>",
// "recipient": "<string>",
// "requester": {},
// "safe_update": "<boolean>",
// "satisfaction_rating": {
// "in_56": -77996997,
// "magnae7": "quis aliqua voluptate et",
// "deseruntc1e": false
// },
// "sharing_agreement_ids": "<array>",
// "status": "closed",
// "subject": "<string>",
// "submitter_id": "<integer>",
// "tags": "<array>",
// "ticket_form_id": "<integer>",
// "type": "task",
// "updated_at": "<dateTime>",
// "updated_stamp": "<string>",
// "url": "<string>",
// "via": {
// "channel": "<string>",
// "source": {
// "utacc": "do aliqua magn",
// "enim049": false,
// "in__": "culpa officia ex non",
// "reprehenderit_06": -27967024
// }
// },
// "via_followup_source_id": "<integer>",
// "via_id": "<integer>",
// "voice_comment": {}
// },
// "ticket_id": "<integer>",
// "updated_at": "<dateTime>",
// "user_id": "<integer>"
// },
// {
// "created_at": "<dateTime>",
// "id": "<integer>",
// "reason": "<string>",
// "ticket": {
// "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": "urgent",
// "problem_id": "<integer>",
// "raw_subject": "<string>",
// "recipient": "<string>",
// "requester": {},
// "safe_update": "<boolean>",
// "satisfaction_rating": {
// "velit_05": -77931495
// },
// "sharing_agreement_ids": "<array>",
// "status": "closed",
// "subject": "<string>",
// "submitter_id": "<integer>",
// "tags": "<array>",
// "ticket_form_id": "<integer>",
// "type": "problem",
// "updated_at": "<dateTime>",
// "updated_stamp": "<string>",
// "url": "<string>",
// "via": {
// "channel": "<string>",
// "source": {
// "tempor__e": -69130011
// }
// },
// "via_followup_source_id": "<integer>",
// "via_id": "<integer>",
// "voice_comment": {}
// },
// "ticket_id": "<integer>",
// "updated_at": "<dateTime>",
// "user_id": "<integer>"
// }
// ]
// }
// 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"skips");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
created_at = CkJsonObjectW_stringOf(jResp,L"skips[i].created_at");
id = CkJsonObjectW_stringOf(jResp,L"skips[i].id");
reason = CkJsonObjectW_stringOf(jResp,L"skips[i].reason");
Requester_id = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.requester_id");
Allow_attachments = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.allow_attachments");
Allow_channelback = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.allow_channelback");
Assignee_email = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.assignee_email");
Assignee_id = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.assignee_id");
Attribute_value_ids = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.attribute_value_ids");
Brand_id = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.brand_id");
Collaborator_ids = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.collaborator_ids");
Created_at = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.created_at");
Custom_fields = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.custom_fields");
Custom_status_id = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.custom_status_id");
Description = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.description");
Due_at = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.due_at");
Email_cc_ids = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.email_cc_ids");
External_id = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.external_id");
Follower_ids = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.follower_ids");
Followup_ids = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.followup_ids");
Forum_topic_id = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.forum_topic_id");
From_messaging_channel = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.from_messaging_channel");
Group_id = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.group_id");
Has_incidents = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.has_incidents");
Id = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.id");
Is_public = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.is_public");
Macro_id = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.macro_id");
Macro_ids = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.macro_ids");
Organization_id = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.organization_id");
Priority = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.priority");
Problem_id = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.problem_id");
Raw_subject = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.raw_subject");
Recipient = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.recipient");
Safe_update = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.safe_update");
In_56 = CkJsonObjectW_IntOf(jResp,L"skips[i].ticket.satisfaction_rating.in_56");
Magnae7 = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.satisfaction_rating.magnae7");
Deseruntc1e = CkJsonObjectW_BoolOf(jResp,L"skips[i].ticket.satisfaction_rating.deseruntc1e");
Sharing_agreement_ids = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.sharing_agreement_ids");
Status = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.status");
Subject = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.subject");
Submitter_id = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.submitter_id");
Tags = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.tags");
Ticket_form_id = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.ticket_form_id");
v_Type = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.type");
Updated_at = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.updated_at");
Updated_stamp = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.updated_stamp");
v_Url = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.url");
Channel = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.via.channel");
Utacc = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.via.source.utacc");
Enim049 = CkJsonObjectW_BoolOf(jResp,L"skips[i].ticket.via.source.enim049");
In__ = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.via.source.in__");
Reprehenderit_06 = CkJsonObjectW_IntOf(jResp,L"skips[i].ticket.via.source.reprehenderit_06");
Via_followup_source_id = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.via_followup_source_id");
Via_id = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.via_id");
ticket_id = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket_id");
updated_at = CkJsonObjectW_stringOf(jResp,L"skips[i].updated_at");
user_id = CkJsonObjectW_stringOf(jResp,L"skips[i].user_id");
Velit_05 = CkJsonObjectW_IntOf(jResp,L"skips[i].ticket.satisfaction_rating.velit_05");
Tempor__e = CkJsonObjectW_IntOf(jResp,L"skips[i].ticket.via.source.tempor__e");
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"skips[i].ticket.collaborators");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
email = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.collaborators[j].email");
name = CkJsonObjectW_stringOf(jResp,L"skips[i].ticket.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 "sort_order=asc"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/:user_id/skips
Postman Collection Item JSON
{
"name": "List Ticket Skips",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/skips?sort_order=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"skips"
],
"query": [
{
"key": "sort_order",
"value": "asc",
"description": "Sort order. Defaults to \"asc\""
}
],
"variable": [
{
"key": "user_id",
"value": "<integer>"
},
{
"key": "ticket_id",
"value": "<integer>",
"description": "(Required) The ID of the ticket"
}
]
},
"description": "Archived tickets are not included in the response. See\n[About archived tickets](https://support.zendesk.com/hc/en-us/articles/203657756) in\nthe Support Help Center.\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Allowed For\n* Agents with \"View only\" or higher reports permissions in Support.\n These permissions are distinct from Explore permissions.\n* Agents retrieving their own skips\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/users/:user_id/skips?sort_order=asc",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"skips"
],
"query": [
{
"key": "sort_order",
"value": "asc",
"description": "Sort order. Defaults to \"asc\""
}
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"skips\": [\n {\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"reason\": \"<string>\",\n \"ticket\": {\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\": \"urgent\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"in_56\": -77996997,\n \"magnae7\": \"quis aliqua voluptate et\",\n \"deseruntc1e\": false\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"closed\",\n \"subject\": \"<string>\",\n \"submitter_id\": \"<integer>\",\n \"tags\": \"<array>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"task\",\n \"updated_at\": \"<dateTime>\",\n \"updated_stamp\": \"<string>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"utacc\": \"do aliqua magn\",\n \"enim049\": false,\n \"in__\": \"culpa officia ex non\",\n \"reprehenderit_06\": -27967024\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n },\n \"ticket_id\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"user_id\": \"<integer>\"\n },\n {\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"reason\": \"<string>\",\n \"ticket\": {\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\": \"urgent\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"velit_05\": -77931495\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"closed\",\n \"subject\": \"<string>\",\n \"submitter_id\": \"<integer>\",\n \"tags\": \"<array>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"problem\",\n \"updated_at\": \"<dateTime>\",\n \"updated_stamp\": \"<string>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"tempor__e\": -69130011\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n },\n \"ticket_id\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"user_id\": \"<integer>\"\n }\n ]\n}"
}
]
}
