Chilkat Online Tools

unicodeCpp / Support API / Search Organizations by External ID

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"external_id",L"<integer>");

    http.SetRequestHeader(L"Accept",L"application/json");

    CkHttpResponseW *resp = http.QuickRequestParams(L"GET",L"https://example.zendesk.com/api/v2/organizations/search",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>",
    //   "next_page": "<string>",
    //   "organizations": [
    //     {
    //       "created_at": "<string>",
    //       "details": "<string>",
    //       "domain_names": [
    //         "<string>",
    //         "<string>"
    //       ],
    //       "external_id": "<string>",
    //       "group_id": "<integer>",
    //       "id": "<integer>",
    //       "name": "<string>",
    //       "notes": "<string>",
    //       "organization_fields": {
    //         "eiusmod_f": "<string>"
    //       },
    //       "shared_comments": "<boolean>",
    //       "shared_tickets": "<boolean>",
    //       "tags": [
    //         "<string>",
    //         "<string>"
    //       ],
    //       "updated_at": "<string>",
    //       "url": "<string>"
    //     },
    //     {
    //       "created_at": "<string>",
    //       "details": "<string>",
    //       "domain_names": [
    //         "<string>",
    //         "<string>"
    //       ],
    //       "external_id": "<string>",
    //       "group_id": "<integer>",
    //       "id": "<integer>",
    //       "name": "<string>",
    //       "notes": "<string>",
    //       "organization_fields": {
    //         "nulla2": "<string>"
    //       },
    //       "shared_comments": "<boolean>",
    //       "shared_tickets": "<boolean>",
    //       "tags": [
    //         "<string>",
    //         "<string>"
    //       ],
    //       "updated_at": "<string>",
    //       "url": "<string>"
    //     }
    //   ],
    //   "previous_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.

    const wchar_t *created_at = 0;
    const wchar_t *details = 0;
    const wchar_t *external_id = 0;
    const wchar_t *group_id = 0;
    const wchar_t *id = 0;
    const wchar_t *name = 0;
    const wchar_t *notes = 0;
    const wchar_t *Eiusmod_f = 0;
    const wchar_t *shared_comments = 0;
    const wchar_t *shared_tickets = 0;
    const wchar_t *updated_at = 0;
    const wchar_t *url = 0;
    const wchar_t *Nulla2 = 0;
    int j;
    int count_j;
    const wchar_t *strVal = 0;

    const wchar_t *count = jResp.stringOf(L"count");
    const wchar_t *next_page = jResp.stringOf(L"next_page");
    const wchar_t *previous_page = jResp.stringOf(L"previous_page");
    int i = 0;
    int count_i = jResp.SizeOfArray(L"organizations");
    while (i < count_i) {
        jResp.put_I(i);
        created_at = jResp.stringOf(L"organizations[i].created_at");
        details = jResp.stringOf(L"organizations[i].details");
        external_id = jResp.stringOf(L"organizations[i].external_id");
        group_id = jResp.stringOf(L"organizations[i].group_id");
        id = jResp.stringOf(L"organizations[i].id");
        name = jResp.stringOf(L"organizations[i].name");
        notes = jResp.stringOf(L"organizations[i].notes");
        Eiusmod_f = jResp.stringOf(L"organizations[i].organization_fields.eiusmod_f");
        shared_comments = jResp.stringOf(L"organizations[i].shared_comments");
        shared_tickets = jResp.stringOf(L"organizations[i].shared_tickets");
        updated_at = jResp.stringOf(L"organizations[i].updated_at");
        url = jResp.stringOf(L"organizations[i].url");
        Nulla2 = jResp.stringOf(L"organizations[i].organization_fields.nulla2");
        j = 0;
        count_j = jResp.SizeOfArray(L"organizations[i].domain_names");
        while (j < count_j) {
            jResp.put_J(j);
            strVal = jResp.stringOf(L"organizations[i].domain_names[j]");
            j = j + 1;
        }

        j = 0;
        count_j = jResp.SizeOfArray(L"organizations[i].tags");
        while (j < count_j) {
            jResp.put_J(j);
            strVal = jResp.stringOf(L"organizations[i].tags[j]");
            j = j + 1;
        }

        i = i + 1;
    }
    }

Curl Command

curl  -u login:password -G -d "external_id=%3Cinteger%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/organizations/search

Postman Collection Item JSON

{
  "name": "Search Organizations by External ID",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organizations/search?external_id=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organizations",
        "search"
      ],
      "query": [
        {
          "key": "external_id",
          "value": "<integer>",
          "description": "(Required) The external id of an organization"
        }
      ]
    },
    "description": "If you set the `external_id` value of an organization to associate it to an external record, you can use the external id to search for the organization.\n\n#### Allowed For:\n\n* Admins\n* Agents assigned to a custom role with permissions to add or modify organizations (Enterprise only)\n\nSee [Creating custom agent roles](https://support.zendesk.com/hc/en-us/articles/203662026#topic_cxn_hig_bd) in the Support Help Center.\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/organizations/search?external_id=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organizations",
            "search"
          ],
          "query": [
            {
              "key": "external_id",
              "value": "<integer>",
              "description": "(Required) The external id of an organization"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"organizations\": [\n    {\n      \"created_at\": \"<string>\",\n      \"details\": \"<string>\",\n      \"domain_names\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"external_id\": \"<string>\",\n      \"group_id\": \"<integer>\",\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"notes\": \"<string>\",\n      \"organization_fields\": {\n        \"eiusmod_f\": \"<string>\"\n      },\n      \"shared_comments\": \"<boolean>\",\n      \"shared_tickets\": \"<boolean>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"updated_at\": \"<string>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"created_at\": \"<string>\",\n      \"details\": \"<string>\",\n      \"domain_names\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"external_id\": \"<string>\",\n      \"group_id\": \"<integer>\",\n      \"id\": \"<integer>\",\n      \"name\": \"<string>\",\n      \"notes\": \"<string>\",\n      \"organization_fields\": {\n        \"nulla2\": \"<string>\"\n      },\n      \"shared_comments\": \"<boolean>\",\n      \"shared_tickets\": \"<boolean>\",\n      \"tags\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"updated_at\": \"<string>\",\n      \"url\": \"<string>\"\n    }\n  ],\n  \"previous_page\": \"<string>\"\n}"
    }
  ]
}