Chilkat Online Tools

C / Support API / Incremental Sample Export

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 *requester_id;
    const char *allow_attachments;
    const char *allow_channelback;
    const char *assignee_email;
    const char *assignee_id;
    const char *attribute_value_ids;
    const char *brand_id;
    const char *collaborator_ids;
    const char *created_at;
    const char *custom_fields;
    const char *custom_status_id;
    const char *description;
    const char *due_at;
    const char *email_cc_ids;
    const char *external_id;
    const char *follower_ids;
    const char *followup_ids;
    const char *forum_topic_id;
    const char *from_messaging_channel;
    const char *group_id;
    const char *has_incidents;
    const char *id;
    const char *is_public;
    const char *macro_id;
    const char *macro_ids;
    const char *organization_id;
    const char *priority;
    const char *problem_id;
    const char *raw_subject;
    const char *recipient;
    const char *safe_update;
    BOOL Aliquad0;
    const char *sharing_agreement_ids;
    const char *status;
    const char *subject;
    const char *submitter_id;
    const char *tags;
    const char *ticket_form_id;
    const char *v_type;
    const char *updated_at;
    const char *updated_stamp;
    const char *url;
    const char *Channel;
    const char *Elit2f;
    const char *via_followup_source_id;
    const char *via_id;
    const char *Minim_01;
    BOOL Ipsum8c2;
    const char *Nostrud_ee;
    int j;
    int count_j;
    const char *email;
    const char *name;
    const char *count;
    const char *end_of_stream;
    const char *end_time;
    const char *next_page;
    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,"start_time","<integer>");

    CkHttp_SetRequestHeader(http,"Accept","application/json");

    resp = CkHttp_QuickRequestParams(http,"GET","https://example.zendesk.com/api/v2/incremental/:incremental_resource/sample",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)

    // {
    //   "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.

    count = CkJsonObject_stringOf(jResp,"count");
    end_of_stream = CkJsonObject_stringOf(jResp,"end_of_stream");
    end_time = CkJsonObject_stringOf(jResp,"end_time");
    next_page = CkJsonObject_stringOf(jResp,"next_page");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"tickets");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        requester_id = CkJsonObject_stringOf(jResp,"tickets[i].requester_id");
        allow_attachments = CkJsonObject_stringOf(jResp,"tickets[i].allow_attachments");
        allow_channelback = CkJsonObject_stringOf(jResp,"tickets[i].allow_channelback");
        assignee_email = CkJsonObject_stringOf(jResp,"tickets[i].assignee_email");
        assignee_id = CkJsonObject_stringOf(jResp,"tickets[i].assignee_id");
        attribute_value_ids = CkJsonObject_stringOf(jResp,"tickets[i].attribute_value_ids");
        brand_id = CkJsonObject_stringOf(jResp,"tickets[i].brand_id");
        collaborator_ids = CkJsonObject_stringOf(jResp,"tickets[i].collaborator_ids");
        created_at = CkJsonObject_stringOf(jResp,"tickets[i].created_at");
        custom_fields = CkJsonObject_stringOf(jResp,"tickets[i].custom_fields");
        custom_status_id = CkJsonObject_stringOf(jResp,"tickets[i].custom_status_id");
        description = CkJsonObject_stringOf(jResp,"tickets[i].description");
        due_at = CkJsonObject_stringOf(jResp,"tickets[i].due_at");
        email_cc_ids = CkJsonObject_stringOf(jResp,"tickets[i].email_cc_ids");
        external_id = CkJsonObject_stringOf(jResp,"tickets[i].external_id");
        follower_ids = CkJsonObject_stringOf(jResp,"tickets[i].follower_ids");
        followup_ids = CkJsonObject_stringOf(jResp,"tickets[i].followup_ids");
        forum_topic_id = CkJsonObject_stringOf(jResp,"tickets[i].forum_topic_id");
        from_messaging_channel = CkJsonObject_stringOf(jResp,"tickets[i].from_messaging_channel");
        group_id = CkJsonObject_stringOf(jResp,"tickets[i].group_id");
        has_incidents = CkJsonObject_stringOf(jResp,"tickets[i].has_incidents");
        id = CkJsonObject_stringOf(jResp,"tickets[i].id");
        is_public = CkJsonObject_stringOf(jResp,"tickets[i].is_public");
        macro_id = CkJsonObject_stringOf(jResp,"tickets[i].macro_id");
        macro_ids = CkJsonObject_stringOf(jResp,"tickets[i].macro_ids");
        organization_id = CkJsonObject_stringOf(jResp,"tickets[i].organization_id");
        priority = CkJsonObject_stringOf(jResp,"tickets[i].priority");
        problem_id = CkJsonObject_stringOf(jResp,"tickets[i].problem_id");
        raw_subject = CkJsonObject_stringOf(jResp,"tickets[i].raw_subject");
        recipient = CkJsonObject_stringOf(jResp,"tickets[i].recipient");
        safe_update = CkJsonObject_stringOf(jResp,"tickets[i].safe_update");
        Aliquad0 = CkJsonObject_BoolOf(jResp,"tickets[i].satisfaction_rating.aliquad0");
        sharing_agreement_ids = CkJsonObject_stringOf(jResp,"tickets[i].sharing_agreement_ids");
        status = CkJsonObject_stringOf(jResp,"tickets[i].status");
        subject = CkJsonObject_stringOf(jResp,"tickets[i].subject");
        submitter_id = CkJsonObject_stringOf(jResp,"tickets[i].submitter_id");
        tags = CkJsonObject_stringOf(jResp,"tickets[i].tags");
        ticket_form_id = CkJsonObject_stringOf(jResp,"tickets[i].ticket_form_id");
        v_type = CkJsonObject_stringOf(jResp,"tickets[i].type");
        updated_at = CkJsonObject_stringOf(jResp,"tickets[i].updated_at");
        updated_stamp = CkJsonObject_stringOf(jResp,"tickets[i].updated_stamp");
        url = CkJsonObject_stringOf(jResp,"tickets[i].url");
        Channel = CkJsonObject_stringOf(jResp,"tickets[i].via.channel");
        Elit2f = CkJsonObject_stringOf(jResp,"tickets[i].via.source.elit2f");
        via_followup_source_id = CkJsonObject_stringOf(jResp,"tickets[i].via_followup_source_id");
        via_id = CkJsonObject_stringOf(jResp,"tickets[i].via_id");
        Minim_01 = CkJsonObject_stringOf(jResp,"tickets[i].satisfaction_rating.minim_01");
        Ipsum8c2 = CkJsonObject_BoolOf(jResp,"tickets[i].satisfaction_rating.ipsum8c2");
        Nostrud_ee = CkJsonObject_stringOf(jResp,"tickets[i].via.source.nostrud_ee");
        j = 0;
        count_j = CkJsonObject_SizeOfArray(jResp,"tickets[i].collaborators");
        while (j < count_j) {
            CkJsonObject_putJ(jResp,j);
            email = CkJsonObject_stringOf(jResp,"tickets[i].collaborators[j].email");
            name = CkJsonObject_stringOf(jResp,"tickets[i].collaborators[j].name");
            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 "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}"
    }
  ]
}