Chilkat Online Tools

unicodeC / Support API / List User Fields

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *key;
    const wchar_t *v_type;
    const wchar_t *title;
    const wchar_t *active;
    const wchar_t *created_at;
    const wchar_t *description;
    const wchar_t *id;
    const wchar_t *position;
    const wchar_t *raw_description;
    const wchar_t *raw_title;
    const wchar_t *regexp_for_validation;
    const wchar_t *relationship_target_type;
    const wchar_t *system;
    const wchar_t *tag;
    const wchar_t *updated_at;
    const wchar_t *url;
    int j;
    int count_j;
    const wchar_t *name;
    const wchar_t *value;
    const wchar_t *raw_name;
    const wchar_t *count;
    const wchar_t *next_page;
    const wchar_t *previous_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 = CkHttpW_Create();

    CkHttpW_putBasicAuth(http,TRUE);
    CkHttpW_putLogin(http,L"login");
    CkHttpW_putPassword(http,L"password");

    CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");

    sbResponseBody = CkStringBuilderW_Create();
    success = CkHttpW_QuickGetSb(http,L"https://example.zendesk.com/api/v2/user_fields",sbResponseBody);
    if (success == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpW_getLastStatus(http);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpW_lastHeader(http));
        wprintf(L"Failed.\n");
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "count": "<integer>",
    //   "next_page": "<string>",
    //   "previous_page": "<string>",
    //   "user_fields": [
    //     {
    //       "key": "<string>",
    //       "type": "<string>",
    //       "title": "<string>",
    //       "active": "<boolean>",
    //       "created_at": "<dateTime>",
    //       "custom_field_options": [
    //         {
    //           "name": "<string>",
    //           "value": "<string>",
    //           "id": "<integer>",
    //           "position": "<integer>",
    //           "raw_name": "<string>",
    //           "url": "<string>"
    //         },
    //         {
    //           "name": "<string>",
    //           "value": "<string>",
    //           "id": "<integer>",
    //           "position": "<integer>",
    //           "raw_name": "<string>",
    //           "url": "<string>"
    //         }
    //       ],
    //       "description": "<string>",
    //       "id": "<integer>",
    //       "position": "<integer>",
    //       "raw_description": "<string>",
    //       "raw_title": "<string>",
    //       "regexp_for_validation": "<string>",
    //       "relationship_filter": {},
    //       "relationship_target_type": "<string>",
    //       "system": "<boolean>",
    //       "tag": "<string>",
    //       "updated_at": "<dateTime>",
    //       "url": "<string>"
    //     },
    //     {
    //       "key": "<string>",
    //       "type": "<string>",
    //       "title": "<string>",
    //       "active": "<boolean>",
    //       "created_at": "<dateTime>",
    //       "custom_field_options": [
    //         {
    //           "name": "<string>",
    //           "value": "<string>",
    //           "id": "<integer>",
    //           "position": "<integer>",
    //           "raw_name": "<string>",
    //           "url": "<string>"
    //         },
    //         {
    //           "name": "<string>",
    //           "value": "<string>",
    //           "id": "<integer>",
    //           "position": "<integer>",
    //           "raw_name": "<string>",
    //           "url": "<string>"
    //         }
    //       ],
    //       "description": "<string>",
    //       "id": "<integer>",
    //       "position": "<integer>",
    //       "raw_description": "<string>",
    //       "raw_title": "<string>",
    //       "regexp_for_validation": "<string>",
    //       "relationship_filter": {},
    //       "relationship_target_type": "<string>",
    //       "system": "<boolean>",
    //       "tag": "<string>",
    //       "updated_at": "<dateTime>",
    //       "url": "<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 = CkJsonObjectW_stringOf(jResp,L"count");
    next_page = CkJsonObjectW_stringOf(jResp,L"next_page");
    previous_page = CkJsonObjectW_stringOf(jResp,L"previous_page");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"user_fields");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        key = CkJsonObjectW_stringOf(jResp,L"user_fields[i].key");
        v_type = CkJsonObjectW_stringOf(jResp,L"user_fields[i].type");
        title = CkJsonObjectW_stringOf(jResp,L"user_fields[i].title");
        active = CkJsonObjectW_stringOf(jResp,L"user_fields[i].active");
        created_at = CkJsonObjectW_stringOf(jResp,L"user_fields[i].created_at");
        description = CkJsonObjectW_stringOf(jResp,L"user_fields[i].description");
        id = CkJsonObjectW_stringOf(jResp,L"user_fields[i].id");
        position = CkJsonObjectW_stringOf(jResp,L"user_fields[i].position");
        raw_description = CkJsonObjectW_stringOf(jResp,L"user_fields[i].raw_description");
        raw_title = CkJsonObjectW_stringOf(jResp,L"user_fields[i].raw_title");
        regexp_for_validation = CkJsonObjectW_stringOf(jResp,L"user_fields[i].regexp_for_validation");
        relationship_target_type = CkJsonObjectW_stringOf(jResp,L"user_fields[i].relationship_target_type");
        system = CkJsonObjectW_stringOf(jResp,L"user_fields[i].system");
        tag = CkJsonObjectW_stringOf(jResp,L"user_fields[i].tag");
        updated_at = CkJsonObjectW_stringOf(jResp,L"user_fields[i].updated_at");
        url = CkJsonObjectW_stringOf(jResp,L"user_fields[i].url");
        j = 0;
        count_j = CkJsonObjectW_SizeOfArray(jResp,L"user_fields[i].custom_field_options");
        while (j < count_j) {
            CkJsonObjectW_putJ(jResp,j);
            name = CkJsonObjectW_stringOf(jResp,L"user_fields[i].custom_field_options[j].name");
            value = CkJsonObjectW_stringOf(jResp,L"user_fields[i].custom_field_options[j].value");
            id = CkJsonObjectW_stringOf(jResp,L"user_fields[i].custom_field_options[j].id");
            position = CkJsonObjectW_stringOf(jResp,L"user_fields[i].custom_field_options[j].position");
            raw_name = CkJsonObjectW_stringOf(jResp,L"user_fields[i].custom_field_options[j].raw_name");
            url = CkJsonObjectW_stringOf(jResp,L"user_fields[i].custom_field_options[j].url");
            j = j + 1;
        }

        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/user_fields

Postman Collection Item JSON

{
  "name": "List User Fields",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/user_fields",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "user_fields"
      ]
    },
    "description": "Returns a list of custom user fields in your account. Fields are returned in the order that you specify in your user fields configuration in Zendesk Support. Clients should cache this resource for the duration of their API usage and map the key for each User Field to the values returned under the `user_fields` attribute on the [User](/api-reference/ticketing/users/users/) resource.\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\n* Agents\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/user_fields",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "user_fields"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"previous_page\": \"<string>\",\n  \"user_fields\": [\n    {\n      \"key\": \"<string>\",\n      \"type\": \"<string>\",\n      \"title\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"created_at\": \"<dateTime>\",\n      \"custom_field_options\": [\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"position\": \"<integer>\",\n          \"raw_name\": \"<string>\",\n          \"url\": \"<string>\"\n        },\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"position\": \"<integer>\",\n          \"raw_name\": \"<string>\",\n          \"url\": \"<string>\"\n        }\n      ],\n      \"description\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"position\": \"<integer>\",\n      \"raw_description\": \"<string>\",\n      \"raw_title\": \"<string>\",\n      \"regexp_for_validation\": \"<string>\",\n      \"relationship_filter\": {},\n      \"relationship_target_type\": \"<string>\",\n      \"system\": \"<boolean>\",\n      \"tag\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"key\": \"<string>\",\n      \"type\": \"<string>\",\n      \"title\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"created_at\": \"<dateTime>\",\n      \"custom_field_options\": [\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"position\": \"<integer>\",\n          \"raw_name\": \"<string>\",\n          \"url\": \"<string>\"\n        },\n        {\n          \"name\": \"<string>\",\n          \"value\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"position\": \"<integer>\",\n          \"raw_name\": \"<string>\",\n          \"url\": \"<string>\"\n        }\n      ],\n      \"description\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"position\": \"<integer>\",\n      \"raw_description\": \"<string>\",\n      \"raw_title\": \"<string>\",\n      \"regexp_for_validation\": \"<string>\",\n      \"relationship_filter\": {},\n      \"relationship_target_type\": \"<string>\",\n      \"system\": \"<boolean>\",\n      \"tag\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}