Chilkat Online Tools

unicodeC / Support API / Autocomplete Users

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 *name;
    const wchar_t *active;
    const wchar_t *alias;
    const wchar_t *chat_only;
    const wchar_t *created_at;
    const wchar_t *custom_role_id;
    const wchar_t *default_group_id;
    const wchar_t *details;
    const wchar_t *email;
    const wchar_t *external_id;
    const wchar_t *iana_time_zone;
    const wchar_t *id;
    const wchar_t *last_login_at;
    const wchar_t *locale;
    const wchar_t *locale_id;
    const wchar_t *moderator;
    const wchar_t *notes;
    const wchar_t *only_private_comments;
    const wchar_t *organization_id;
    const wchar_t *phone;
    BOOL In1f;
    BOOL Cillumb5;
    const wchar_t *remote_photo_url;
    const wchar_t *report_csv;
    const wchar_t *restricted_agent;
    const wchar_t *role;
    const wchar_t *role_type;
    const wchar_t *v_shared;
    const wchar_t *shared_agent;
    const wchar_t *shared_phone_number;
    const wchar_t *signature;
    const wchar_t *suspended;
    const wchar_t *tags;
    const wchar_t *ticket_restriction;
    const wchar_t *time_zone;
    const wchar_t *two_factor_auth_enabled;
    const wchar_t *updated_at;
    const wchar_t *url;
    const wchar_t *Nisi_e;
    const wchar_t *verified;
    BOOL Ut69;
    int Magna_4;
    int Loremcc;
    BOOL Dolore7;
    const wchar_t *Pariaturf;
    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"name",L"<string>");
    CkJsonObjectW_UpdateString(queryParams,L"field_id",L"<string>");
    CkJsonObjectW_UpdateString(queryParams,L"source",L"<string>");

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

    resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://example.zendesk.com/api/v2/users/autocomplete",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)

    // {
    //   "users": [
    //     {
    //       "name": "<string>",
    //       "active": "<boolean>",
    //       "alias": "<string>",
    //       "chat_only": "<boolean>",
    //       "created_at": "<string>",
    //       "custom_role_id": "<integer>",
    //       "default_group_id": "<integer>",
    //       "details": "<string>",
    //       "email": "<string>",
    //       "external_id": "<string>",
    //       "iana_time_zone": "<string>",
    //       "id": "<integer>",
    //       "last_login_at": "<string>",
    //       "locale": "<string>",
    //       "locale_id": "<integer>",
    //       "moderator": "<boolean>",
    //       "notes": "<string>",
    //       "only_private_comments": "<boolean>",
    //       "organization_id": "<integer>",
    //       "phone": "<string>",
    //       "photo": {
    //         "in1f": false,
    //         "cillumb5": true
    //       },
    //       "remote_photo_url": "<string>",
    //       "report_csv": "<boolean>",
    //       "restricted_agent": "<boolean>",
    //       "role": "<string>",
    //       "role_type": "<integer>",
    //       "shared": "<boolean>",
    //       "shared_agent": "<boolean>",
    //       "shared_phone_number": "<boolean>",
    //       "signature": "<string>",
    //       "suspended": "<boolean>",
    //       "tags": "<array>",
    //       "ticket_restriction": "<string>",
    //       "time_zone": "<string>",
    //       "two_factor_auth_enabled": "<boolean>",
    //       "updated_at": "<string>",
    //       "url": "<string>",
    //       "user_fields": {
    //         "nisi_e": "commodo exercitation consequat"
    //       },
    //       "verified": "<boolean>"
    //     },
    //     {
    //       "name": "<string>",
    //       "active": "<boolean>",
    //       "alias": "<string>",
    //       "chat_only": "<boolean>",
    //       "created_at": "<string>",
    //       "custom_role_id": "<integer>",
    //       "default_group_id": "<integer>",
    //       "details": "<string>",
    //       "email": "<string>",
    //       "external_id": "<string>",
    //       "iana_time_zone": "<string>",
    //       "id": "<integer>",
    //       "last_login_at": "<string>",
    //       "locale": "<string>",
    //       "locale_id": "<integer>",
    //       "moderator": "<boolean>",
    //       "notes": "<string>",
    //       "only_private_comments": "<boolean>",
    //       "organization_id": "<integer>",
    //       "phone": "<string>",
    //       "photo": {
    //         "ut69": true,
    //         "magna_4": -92520384
    //       },
    //       "remote_photo_url": "<string>",
    //       "report_csv": "<boolean>",
    //       "restricted_agent": "<boolean>",
    //       "role": "<string>",
    //       "role_type": "<integer>",
    //       "shared": "<boolean>",
    //       "shared_agent": "<boolean>",
    //       "shared_phone_number": "<boolean>",
    //       "signature": "<string>",
    //       "suspended": "<boolean>",
    //       "tags": "<array>",
    //       "ticket_restriction": "<string>",
    //       "time_zone": "<string>",
    //       "two_factor_auth_enabled": "<boolean>",
    //       "updated_at": "<string>",
    //       "url": "<string>",
    //       "user_fields": {
    //         "Loremcc": 52379422,
    //         "dolore7": true,
    //         "pariaturf": "magna consectet"
    //       },
    //       "verified": "<boolean>"
    //     }
    //   ]
    // }

    // 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"users");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        name = CkJsonObjectW_stringOf(jResp,L"users[i].name");
        active = CkJsonObjectW_stringOf(jResp,L"users[i].active");
        alias = CkJsonObjectW_stringOf(jResp,L"users[i].alias");
        chat_only = CkJsonObjectW_stringOf(jResp,L"users[i].chat_only");
        created_at = CkJsonObjectW_stringOf(jResp,L"users[i].created_at");
        custom_role_id = CkJsonObjectW_stringOf(jResp,L"users[i].custom_role_id");
        default_group_id = CkJsonObjectW_stringOf(jResp,L"users[i].default_group_id");
        details = CkJsonObjectW_stringOf(jResp,L"users[i].details");
        email = CkJsonObjectW_stringOf(jResp,L"users[i].email");
        external_id = CkJsonObjectW_stringOf(jResp,L"users[i].external_id");
        iana_time_zone = CkJsonObjectW_stringOf(jResp,L"users[i].iana_time_zone");
        id = CkJsonObjectW_stringOf(jResp,L"users[i].id");
        last_login_at = CkJsonObjectW_stringOf(jResp,L"users[i].last_login_at");
        locale = CkJsonObjectW_stringOf(jResp,L"users[i].locale");
        locale_id = CkJsonObjectW_stringOf(jResp,L"users[i].locale_id");
        moderator = CkJsonObjectW_stringOf(jResp,L"users[i].moderator");
        notes = CkJsonObjectW_stringOf(jResp,L"users[i].notes");
        only_private_comments = CkJsonObjectW_stringOf(jResp,L"users[i].only_private_comments");
        organization_id = CkJsonObjectW_stringOf(jResp,L"users[i].organization_id");
        phone = CkJsonObjectW_stringOf(jResp,L"users[i].phone");
        In1f = CkJsonObjectW_BoolOf(jResp,L"users[i].photo.in1f");
        Cillumb5 = CkJsonObjectW_BoolOf(jResp,L"users[i].photo.cillumb5");
        remote_photo_url = CkJsonObjectW_stringOf(jResp,L"users[i].remote_photo_url");
        report_csv = CkJsonObjectW_stringOf(jResp,L"users[i].report_csv");
        restricted_agent = CkJsonObjectW_stringOf(jResp,L"users[i].restricted_agent");
        role = CkJsonObjectW_stringOf(jResp,L"users[i].role");
        role_type = CkJsonObjectW_stringOf(jResp,L"users[i].role_type");
        v_shared = CkJsonObjectW_stringOf(jResp,L"users[i].shared");
        shared_agent = CkJsonObjectW_stringOf(jResp,L"users[i].shared_agent");
        shared_phone_number = CkJsonObjectW_stringOf(jResp,L"users[i].shared_phone_number");
        signature = CkJsonObjectW_stringOf(jResp,L"users[i].signature");
        suspended = CkJsonObjectW_stringOf(jResp,L"users[i].suspended");
        tags = CkJsonObjectW_stringOf(jResp,L"users[i].tags");
        ticket_restriction = CkJsonObjectW_stringOf(jResp,L"users[i].ticket_restriction");
        time_zone = CkJsonObjectW_stringOf(jResp,L"users[i].time_zone");
        two_factor_auth_enabled = CkJsonObjectW_stringOf(jResp,L"users[i].two_factor_auth_enabled");
        updated_at = CkJsonObjectW_stringOf(jResp,L"users[i].updated_at");
        url = CkJsonObjectW_stringOf(jResp,L"users[i].url");
        Nisi_e = CkJsonObjectW_stringOf(jResp,L"users[i].user_fields.nisi_e");
        verified = CkJsonObjectW_stringOf(jResp,L"users[i].verified");
        Ut69 = CkJsonObjectW_BoolOf(jResp,L"users[i].photo.ut69");
        Magna_4 = CkJsonObjectW_IntOf(jResp,L"users[i].photo.magna_4");
        Loremcc = CkJsonObjectW_IntOf(jResp,L"users[i].user_fields.Loremcc");
        Dolore7 = CkJsonObjectW_BoolOf(jResp,L"users[i].user_fields.dolore7");
        Pariaturf = CkJsonObjectW_stringOf(jResp,L"users[i].user_fields.pariaturf");
        i = i + 1;
    }



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

    }

Curl Command

curl  -u login:password -G -d "name=%3Cstring%3E"
	-d "field_id=%3Cstring%3E"
	-d "source=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/autocomplete

Postman Collection Item JSON

{
  "name": "Autocomplete Users",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/users/autocomplete?name=<string>&field_id=<string>&source=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        "autocomplete"
      ],
      "query": [
        {
          "key": "name",
          "value": "<string>",
          "description": "(Required) The name to search for the user.\n"
        },
        {
          "key": "field_id",
          "value": "<string>",
          "description": "The id of a lookup relationship field.  The type of field is determined\nby the `source` param\n"
        },
        {
          "key": "source",
          "value": "<string>",
          "description": "If a `field_id` is provided, this specifies the type of the field.\nFor example, if the field is on a \"zen:user\", it references a field on a user\n"
        }
      ]
    },
    "description": "Returns an array of users whose name starts with the value specified in the `name` parameter.\nIt only returns users with no foreign identities.\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/users/autocomplete?name=<string>&field_id=<string>&source=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            "autocomplete"
          ],
          "query": [
            {
              "key": "name",
              "value": "<string>",
              "description": "(Required) The name to search for the user.\n"
            },
            {
              "key": "field_id",
              "value": "<string>",
              "description": "The id of a lookup relationship field.  The type of field is determined\nby the `source` param\n"
            },
            {
              "key": "source",
              "value": "<string>",
              "description": "If a `field_id` is provided, this specifies the type of the field.\nFor example, if the field is on a \"zen:user\", it references a field on a user\n"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"users\": [\n    {\n      \"name\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"alias\": \"<string>\",\n      \"chat_only\": \"<boolean>\",\n      \"created_at\": \"<string>\",\n      \"custom_role_id\": \"<integer>\",\n      \"default_group_id\": \"<integer>\",\n      \"details\": \"<string>\",\n      \"email\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"iana_time_zone\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"last_login_at\": \"<string>\",\n      \"locale\": \"<string>\",\n      \"locale_id\": \"<integer>\",\n      \"moderator\": \"<boolean>\",\n      \"notes\": \"<string>\",\n      \"only_private_comments\": \"<boolean>\",\n      \"organization_id\": \"<integer>\",\n      \"phone\": \"<string>\",\n      \"photo\": {\n        \"in1f\": false,\n        \"cillumb5\": true\n      },\n      \"remote_photo_url\": \"<string>\",\n      \"report_csv\": \"<boolean>\",\n      \"restricted_agent\": \"<boolean>\",\n      \"role\": \"<string>\",\n      \"role_type\": \"<integer>\",\n      \"shared\": \"<boolean>\",\n      \"shared_agent\": \"<boolean>\",\n      \"shared_phone_number\": \"<boolean>\",\n      \"signature\": \"<string>\",\n      \"suspended\": \"<boolean>\",\n      \"tags\": \"<array>\",\n      \"ticket_restriction\": \"<string>\",\n      \"time_zone\": \"<string>\",\n      \"two_factor_auth_enabled\": \"<boolean>\",\n      \"updated_at\": \"<string>\",\n      \"url\": \"<string>\",\n      \"user_fields\": {\n        \"nisi_e\": \"commodo exercitation consequat\"\n      },\n      \"verified\": \"<boolean>\"\n    },\n    {\n      \"name\": \"<string>\",\n      \"active\": \"<boolean>\",\n      \"alias\": \"<string>\",\n      \"chat_only\": \"<boolean>\",\n      \"created_at\": \"<string>\",\n      \"custom_role_id\": \"<integer>\",\n      \"default_group_id\": \"<integer>\",\n      \"details\": \"<string>\",\n      \"email\": \"<string>\",\n      \"external_id\": \"<string>\",\n      \"iana_time_zone\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"last_login_at\": \"<string>\",\n      \"locale\": \"<string>\",\n      \"locale_id\": \"<integer>\",\n      \"moderator\": \"<boolean>\",\n      \"notes\": \"<string>\",\n      \"only_private_comments\": \"<boolean>\",\n      \"organization_id\": \"<integer>\",\n      \"phone\": \"<string>\",\n      \"photo\": {\n        \"ut69\": true,\n        \"magna_4\": -92520384\n      },\n      \"remote_photo_url\": \"<string>\",\n      \"report_csv\": \"<boolean>\",\n      \"restricted_agent\": \"<boolean>\",\n      \"role\": \"<string>\",\n      \"role_type\": \"<integer>\",\n      \"shared\": \"<boolean>\",\n      \"shared_agent\": \"<boolean>\",\n      \"shared_phone_number\": \"<boolean>\",\n      \"signature\": \"<string>\",\n      \"suspended\": \"<boolean>\",\n      \"tags\": \"<array>\",\n      \"ticket_restriction\": \"<string>\",\n      \"time_zone\": \"<string>\",\n      \"two_factor_auth_enabled\": \"<boolean>\",\n      \"updated_at\": \"<string>\",\n      \"url\": \"<string>\",\n      \"user_fields\": {\n        \"Loremcc\": 52379422,\n        \"dolore7\": true,\n        \"pariaturf\": \"magna consectet\"\n      },\n      \"verified\": \"<boolean>\"\n    }\n  ]\n}"
    }
  ]
}