Chilkat Online Tools

C / Support API / Incremental Attributes Export

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 *attribute_id;
    const char *id;
    const char *name;
    const char *time;
    const char *v_type;
    const char *attribute_value_id;
    const char *instance_id;
    const char *count;
    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");

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

    sbResponseBody = CkStringBuilder_Create();
    success = CkHttp_QuickGetSb(http,"https://example.zendesk.com/api/v2/incremental/routing/attributes",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)

    // {
    //   "attribute_values": [
    //     {
    //       "attribute_id": "<string>",
    //       "id": "<string>",
    //       "name": "<string>",
    //       "time": "<dateTime>",
    //       "type": "<string>"
    //     },
    //     {
    //       "attribute_id": "<string>",
    //       "id": "<string>",
    //       "name": "<string>",
    //       "time": "<dateTime>",
    //       "type": "<string>"
    //     }
    //   ],
    //   "attributes": [
    //     {
    //       "id": "<string>",
    //       "name": "<string>",
    //       "time": "<dateTime>",
    //       "type": "<string>"
    //     },
    //     {
    //       "id": "<string>",
    //       "name": "<string>",
    //       "time": "<dateTime>",
    //       "type": "<string>"
    //     }
    //   ],
    //   "count": "<integer>",
    //   "end_time": "<integer>",
    //   "instance_values": [
    //     {
    //       "attribute_value_id": "<string>",
    //       "id": "<string>",
    //       "instance_id": "<string>",
    //       "time": "<dateTime>",
    //       "type": "<string>"
    //     },
    //     {
    //       "attribute_value_id": "<string>",
    //       "id": "<string>",
    //       "instance_id": "<string>",
    //       "time": "<dateTime>",
    //       "type": "<string>"
    //     }
    //   ],
    //   "next_page": "<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.

    count = CkJsonObject_stringOf(jResp,"count");
    end_time = CkJsonObject_stringOf(jResp,"end_time");
    next_page = CkJsonObject_stringOf(jResp,"next_page");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"attribute_values");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        attribute_id = CkJsonObject_stringOf(jResp,"attribute_values[i].attribute_id");
        id = CkJsonObject_stringOf(jResp,"attribute_values[i].id");
        name = CkJsonObject_stringOf(jResp,"attribute_values[i].name");
        time = CkJsonObject_stringOf(jResp,"attribute_values[i].time");
        v_type = CkJsonObject_stringOf(jResp,"attribute_values[i].type");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"attributes");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        id = CkJsonObject_stringOf(jResp,"attributes[i].id");
        name = CkJsonObject_stringOf(jResp,"attributes[i].name");
        time = CkJsonObject_stringOf(jResp,"attributes[i].time");
        v_type = CkJsonObject_stringOf(jResp,"attributes[i].type");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"instance_values");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        attribute_value_id = CkJsonObject_stringOf(jResp,"instance_values[i].attribute_value_id");
        id = CkJsonObject_stringOf(jResp,"instance_values[i].id");
        instance_id = CkJsonObject_stringOf(jResp,"instance_values[i].instance_id");
        time = CkJsonObject_stringOf(jResp,"instance_values[i].time");
        v_type = CkJsonObject_stringOf(jResp,"instance_values[i].type");
        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/incremental/routing/attributes

Postman Collection Item JSON

{
  "name": "Incremental Attributes Export",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/incremental/routing/attributes",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "incremental",
        "routing",
        "attributes"
      ]
    },
    "description": "Returns a stream of changes that occurred on routing attributes.\n\n#### Allowed For\n\n* Admins\n\n#### Parameters\n\nOptional\n\n\n| Name   | Type   | Comment\n| ------ | ------ | -------\n| cursor | string | The `cursor` parameter is a non-human-readable argument you can use to move forward or backward in time. The cursor is a read-only URL parameter that's only available in API responses. See [Pagination](#pagination).\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/routing/attributes",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "incremental",
            "routing",
            "attributes"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"attribute_values\": [\n    {\n      \"attribute_id\": \"<string>\",\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    },\n    {\n      \"attribute_id\": \"<string>\",\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"attributes\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"count\": \"<integer>\",\n  \"end_time\": \"<integer>\",\n  \"instance_values\": [\n    {\n      \"attribute_value_id\": \"<string>\",\n      \"id\": \"<string>\",\n      \"instance_id\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    },\n    {\n      \"attribute_value_id\": \"<string>\",\n      \"id\": \"<string>\",\n      \"instance_id\": \"<string>\",\n      \"time\": \"<dateTime>\",\n      \"type\": \"<string>\"\n    }\n  ],\n  \"next_page\": \"<string>\"\n}"
    }
  ]
}