unicodeCpp / Support API / Incremental Sample Export
Back to Collection Items
#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
bool success;
http.put_BasicAuth(true);
http.put_Login(L"login");
http.put_Password(L"password");
CkJsonObjectW queryParams;
queryParams.UpdateString(L"start_time",L"<integer>");
http.SetRequestHeader(L"Accept",L"application/json");
CkHttpResponseW *resp = http.QuickRequestParams(L"GET",L"https://example.zendesk.com/api/v2/incremental/:incremental_resource/sample",queryParams);
if (http.get_LastMethodSuccess() == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkStringBuilderW sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonObjectW jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jResp.emit());
int respStatusCode = resp->get_StatusCode();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",resp->header());
wprintf(L"Failed.\n");
delete resp;
return;
}
delete resp;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "count": "<integer>",
// "end_of_stream": "<boolean>",
// "end_time": "<integer>",
// "next_page": "<string>",
// "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": "high",
// "problem_id": "<integer>",
// "raw_subject": "<string>",
// "recipient": "<string>",
// "requester": {},
// "safe_update": "<boolean>",
// "satisfaction_rating": {
// "aliquad0": false
// },
// "sharing_agreement_ids": "<array>",
// "status": "pending",
// "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": {
// "elit2f": -86657295.30733354
// }
// },
// "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": {
// "minim_01": "minim tempor",
// "ipsum8c2": false
// },
// "sharing_agreement_ids": "<array>",
// "status": "open",
// "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": {
// "nostrud_ee": "dolore veniam consequat"
// }
// },
// "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.
const wchar_t *requester_id = 0;
const wchar_t *allow_attachments = 0;
const wchar_t *allow_channelback = 0;
const wchar_t *assignee_email = 0;
const wchar_t *assignee_id = 0;
const wchar_t *attribute_value_ids = 0;
const wchar_t *brand_id = 0;
const wchar_t *collaborator_ids = 0;
const wchar_t *created_at = 0;
const wchar_t *custom_fields = 0;
const wchar_t *custom_status_id = 0;
const wchar_t *description = 0;
const wchar_t *due_at = 0;
const wchar_t *email_cc_ids = 0;
const wchar_t *external_id = 0;
const wchar_t *follower_ids = 0;
const wchar_t *followup_ids = 0;
const wchar_t *forum_topic_id = 0;
const wchar_t *from_messaging_channel = 0;
const wchar_t *group_id = 0;
const wchar_t *has_incidents = 0;
const wchar_t *id = 0;
const wchar_t *is_public = 0;
const wchar_t *macro_id = 0;
const wchar_t *macro_ids = 0;
const wchar_t *organization_id = 0;
const wchar_t *priority = 0;
const wchar_t *problem_id = 0;
const wchar_t *raw_subject = 0;
const wchar_t *recipient = 0;
const wchar_t *safe_update = 0;
bool Aliquad0;
const wchar_t *sharing_agreement_ids = 0;
const wchar_t *status = 0;
const wchar_t *subject = 0;
const wchar_t *submitter_id = 0;
const wchar_t *tags = 0;
const wchar_t *ticket_form_id = 0;
const wchar_t *v_type = 0;
const wchar_t *updated_at = 0;
const wchar_t *updated_stamp = 0;
const wchar_t *url = 0;
const wchar_t *Channel = 0;
const wchar_t *Elit2f = 0;
const wchar_t *via_followup_source_id = 0;
const wchar_t *via_id = 0;
const wchar_t *Minim_01 = 0;
bool Ipsum8c2;
const wchar_t *Nostrud_ee = 0;
int j;
int count_j;
const wchar_t *email = 0;
const wchar_t *name = 0;
const wchar_t *count = jResp.stringOf(L"count");
const wchar_t *end_of_stream = jResp.stringOf(L"end_of_stream");
const wchar_t *end_time = jResp.stringOf(L"end_time");
const wchar_t *next_page = jResp.stringOf(L"next_page");
int i = 0;
int count_i = jResp.SizeOfArray(L"tickets");
while (i < count_i) {
jResp.put_I(i);
requester_id = jResp.stringOf(L"tickets[i].requester_id");
allow_attachments = jResp.stringOf(L"tickets[i].allow_attachments");
allow_channelback = jResp.stringOf(L"tickets[i].allow_channelback");
assignee_email = jResp.stringOf(L"tickets[i].assignee_email");
assignee_id = jResp.stringOf(L"tickets[i].assignee_id");
attribute_value_ids = jResp.stringOf(L"tickets[i].attribute_value_ids");
brand_id = jResp.stringOf(L"tickets[i].brand_id");
collaborator_ids = jResp.stringOf(L"tickets[i].collaborator_ids");
created_at = jResp.stringOf(L"tickets[i].created_at");
custom_fields = jResp.stringOf(L"tickets[i].custom_fields");
custom_status_id = jResp.stringOf(L"tickets[i].custom_status_id");
description = jResp.stringOf(L"tickets[i].description");
due_at = jResp.stringOf(L"tickets[i].due_at");
email_cc_ids = jResp.stringOf(L"tickets[i].email_cc_ids");
external_id = jResp.stringOf(L"tickets[i].external_id");
follower_ids = jResp.stringOf(L"tickets[i].follower_ids");
followup_ids = jResp.stringOf(L"tickets[i].followup_ids");
forum_topic_id = jResp.stringOf(L"tickets[i].forum_topic_id");
from_messaging_channel = jResp.stringOf(L"tickets[i].from_messaging_channel");
group_id = jResp.stringOf(L"tickets[i].group_id");
has_incidents = jResp.stringOf(L"tickets[i].has_incidents");
id = jResp.stringOf(L"tickets[i].id");
is_public = jResp.stringOf(L"tickets[i].is_public");
macro_id = jResp.stringOf(L"tickets[i].macro_id");
macro_ids = jResp.stringOf(L"tickets[i].macro_ids");
organization_id = jResp.stringOf(L"tickets[i].organization_id");
priority = jResp.stringOf(L"tickets[i].priority");
problem_id = jResp.stringOf(L"tickets[i].problem_id");
raw_subject = jResp.stringOf(L"tickets[i].raw_subject");
recipient = jResp.stringOf(L"tickets[i].recipient");
safe_update = jResp.stringOf(L"tickets[i].safe_update");
Aliquad0 = jResp.BoolOf(L"tickets[i].satisfaction_rating.aliquad0");
sharing_agreement_ids = jResp.stringOf(L"tickets[i].sharing_agreement_ids");
status = jResp.stringOf(L"tickets[i].status");
subject = jResp.stringOf(L"tickets[i].subject");
submitter_id = jResp.stringOf(L"tickets[i].submitter_id");
tags = jResp.stringOf(L"tickets[i].tags");
ticket_form_id = jResp.stringOf(L"tickets[i].ticket_form_id");
v_type = jResp.stringOf(L"tickets[i].type");
updated_at = jResp.stringOf(L"tickets[i].updated_at");
updated_stamp = jResp.stringOf(L"tickets[i].updated_stamp");
url = jResp.stringOf(L"tickets[i].url");
Channel = jResp.stringOf(L"tickets[i].via.channel");
Elit2f = jResp.stringOf(L"tickets[i].via.source.elit2f");
via_followup_source_id = jResp.stringOf(L"tickets[i].via_followup_source_id");
via_id = jResp.stringOf(L"tickets[i].via_id");
Minim_01 = jResp.stringOf(L"tickets[i].satisfaction_rating.minim_01");
Ipsum8c2 = jResp.BoolOf(L"tickets[i].satisfaction_rating.ipsum8c2");
Nostrud_ee = jResp.stringOf(L"tickets[i].via.source.nostrud_ee");
j = 0;
count_j = jResp.SizeOfArray(L"tickets[i].collaborators");
while (j < count_j) {
jResp.put_J(j);
email = jResp.stringOf(L"tickets[i].collaborators[j].email");
name = jResp.stringOf(L"tickets[i].collaborators[j].name");
j = j + 1;
}
i = i + 1;
}
}
Curl Command
curl -u login:password -G -d "start_time=%3Cinteger%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/incremental/:incremental_resource/sample
Postman Collection Item JSON
{
"name": "Incremental Sample Export",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/incremental/:incremental_resource/sample?start_time=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
":incremental_resource",
"sample"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
}
],
"variable": [
{
"key": "incremental_resource",
"value": "<string>"
}
]
},
"description": "Use this endpoint to test the incremental export format. It's more strict in terms of rate limiting,\nat 10 requests per 20 minutes instead of 10 requests per minute. It also returns only up to 50\nresults per request. Otherwise, it's identical to the above APIs.\n\nUse the `incremental_resource` parameter to specify the resource. Possible values are \"tickets\", \"ticket_events\", \"users\", or \"organizations\".\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/incremental/:incremental_resource/sample?start_time=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"incremental",
":incremental_resource",
"sample"
],
"query": [
{
"key": "start_time",
"value": "<integer>",
"description": "(Required) The time to start the incremental export from"
}
],
"variable": [
{
"key": "incremental_resource"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"end_of_stream\": \"<boolean>\",\n \"end_time\": \"<integer>\",\n \"next_page\": \"<string>\",\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\": \"high\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"aliquad0\": false\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"pending\",\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 \"elit2f\": -86657295.30733354\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 \"minim_01\": \"minim tempor\",\n \"ipsum8c2\": false\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"open\",\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 \"nostrud_ee\": \"dolore veniam consequat\"\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n }\n ]\n}"
}
]
}
