unicodeC / Support API / Search Organizations by External ID
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 *created_at;
const wchar_t *details;
const wchar_t *external_id;
const wchar_t *group_id;
const wchar_t *id;
const wchar_t *name;
const wchar_t *notes;
const wchar_t *Eiusmod_f;
const wchar_t *shared_comments;
const wchar_t *shared_tickets;
const wchar_t *updated_at;
const wchar_t *url;
const wchar_t *Nulla2;
int j;
int count_j;
const wchar_t *strVal;
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");
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(queryParams,L"external_id",L"<integer>");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://example.zendesk.com/api/v2/organizations/search",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)
// {
// "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.
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"organizations");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
created_at = CkJsonObjectW_stringOf(jResp,L"organizations[i].created_at");
details = CkJsonObjectW_stringOf(jResp,L"organizations[i].details");
external_id = CkJsonObjectW_stringOf(jResp,L"organizations[i].external_id");
group_id = CkJsonObjectW_stringOf(jResp,L"organizations[i].group_id");
id = CkJsonObjectW_stringOf(jResp,L"organizations[i].id");
name = CkJsonObjectW_stringOf(jResp,L"organizations[i].name");
notes = CkJsonObjectW_stringOf(jResp,L"organizations[i].notes");
Eiusmod_f = CkJsonObjectW_stringOf(jResp,L"organizations[i].organization_fields.eiusmod_f");
shared_comments = CkJsonObjectW_stringOf(jResp,L"organizations[i].shared_comments");
shared_tickets = CkJsonObjectW_stringOf(jResp,L"organizations[i].shared_tickets");
updated_at = CkJsonObjectW_stringOf(jResp,L"organizations[i].updated_at");
url = CkJsonObjectW_stringOf(jResp,L"organizations[i].url");
Nulla2 = CkJsonObjectW_stringOf(jResp,L"organizations[i].organization_fields.nulla2");
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"organizations[i].domain_names");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
strVal = CkJsonObjectW_stringOf(jResp,L"organizations[i].domain_names[j]");
j = j + 1;
}
j = 0;
count_j = CkJsonObjectW_SizeOfArray(jResp,L"organizations[i].tags");
while (j < count_j) {
CkJsonObjectW_putJ(jResp,j);
strVal = CkJsonObjectW_stringOf(jResp,L"organizations[i].tags[j]");
j = j + 1;
}
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
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}"
}
]
}
