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 *country;
const wchar_t *v_Type;
const wchar_t *photo_id;
const wchar_t *city;
const wchar_t *description;
BOOL mc_status;
BOOL gapps_enabled;
const wchar_t *domain_name;
BOOL translation_enabled;
const wchar_t *street;
const wchar_t *alias;
const wchar_t *v_currency;
const wchar_t *id;
const wchar_t *state;
const wchar_t *fax;
const wchar_t *employee_count;
const wchar_t *zip;
const wchar_t *website;
const wchar_t *currency_symbol;
const wchar_t *mobile;
const wchar_t *currency_locale;
const wchar_t *primary_zuid;
const wchar_t *zia_portal_id;
const wchar_t *time_zone;
const wchar_t *zgid;
const wchar_t *country_code;
const wchar_t *Paid_expiry;
int Users_license_purchased;
const wchar_t *Trial_type;
const wchar_t *Trial_expiry;
BOOL Paid;
const wchar_t *Paid_type;
const wchar_t *phone;
const wchar_t *company_name;
BOOL privacy_settings;
const wchar_t *primary_email;
const wchar_t *iso_code;
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_SetRequestHeader(http,L"Authorization",L"{{authorization-token}}");
sbResponseBody = CkStringBuilderW_Create();
success = CkHttpW_QuickGetSb(http,L"https://domain.com/crm/v2.1/org",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)
// {
// "org": [
// {
// "country": null,
// "hierarchy_preferences": {
// "type": "Role_Hierarchy"
// },
// "photo_id": null,
// "city": null,
// "description": null,
// "mc_status": true,
// "gapps_enabled": false,
// "domain_name": "org60036018",
// "translation_enabled": true,
// "street": null,
// "alias": null,
// "currency": "Indian Rupee",
// "id": "738964000000300043",
// "state": null,
// "fax": null,
// "employee_count": null,
// "zip": null,
// "website": null,
// "currency_symbol": "₹",
// "mobile": null,
// "currency_locale": "en_IN",
// "primary_zuid": "60034346",
// "zia_portal_id": null,
// "time_zone": "Asia/Kolkata",
// "zgid": "60036018",
// "country_code": "IN",
// "license_details": {
// "paid_expiry": "2021-10-20T00:00:00+00:00",
// "users_license_purchased": 25,
// "trial_type": null,
// "trial_expiry": null,
// "paid": true,
// "paid_type": "enterprise"
// },
// "phone": "312",
// "company_name": "Zylker",
// "privacy_settings": false,
// "primary_email": "patricia@zohocorp.com",
// "iso_code": "INR"
// }
// ]
// }
// 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"org");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
country = CkJsonObjectW_stringOf(jResp,L"org[i].country");
v_Type = CkJsonObjectW_stringOf(jResp,L"org[i].hierarchy_preferences.type");
photo_id = CkJsonObjectW_stringOf(jResp,L"org[i].photo_id");
city = CkJsonObjectW_stringOf(jResp,L"org[i].city");
description = CkJsonObjectW_stringOf(jResp,L"org[i].description");
mc_status = CkJsonObjectW_BoolOf(jResp,L"org[i].mc_status");
gapps_enabled = CkJsonObjectW_BoolOf(jResp,L"org[i].gapps_enabled");
domain_name = CkJsonObjectW_stringOf(jResp,L"org[i].domain_name");
translation_enabled = CkJsonObjectW_BoolOf(jResp,L"org[i].translation_enabled");
street = CkJsonObjectW_stringOf(jResp,L"org[i].street");
alias = CkJsonObjectW_stringOf(jResp,L"org[i].alias");
v_currency = CkJsonObjectW_stringOf(jResp,L"org[i].currency");
id = CkJsonObjectW_stringOf(jResp,L"org[i].id");
state = CkJsonObjectW_stringOf(jResp,L"org[i].state");
fax = CkJsonObjectW_stringOf(jResp,L"org[i].fax");
employee_count = CkJsonObjectW_stringOf(jResp,L"org[i].employee_count");
zip = CkJsonObjectW_stringOf(jResp,L"org[i].zip");
website = CkJsonObjectW_stringOf(jResp,L"org[i].website");
currency_symbol = CkJsonObjectW_stringOf(jResp,L"org[i].currency_symbol");
mobile = CkJsonObjectW_stringOf(jResp,L"org[i].mobile");
currency_locale = CkJsonObjectW_stringOf(jResp,L"org[i].currency_locale");
primary_zuid = CkJsonObjectW_stringOf(jResp,L"org[i].primary_zuid");
zia_portal_id = CkJsonObjectW_stringOf(jResp,L"org[i].zia_portal_id");
time_zone = CkJsonObjectW_stringOf(jResp,L"org[i].time_zone");
zgid = CkJsonObjectW_stringOf(jResp,L"org[i].zgid");
country_code = CkJsonObjectW_stringOf(jResp,L"org[i].country_code");
Paid_expiry = CkJsonObjectW_stringOf(jResp,L"org[i].license_details.paid_expiry");
Users_license_purchased = CkJsonObjectW_IntOf(jResp,L"org[i].license_details.users_license_purchased");
Trial_type = CkJsonObjectW_stringOf(jResp,L"org[i].license_details.trial_type");
Trial_expiry = CkJsonObjectW_stringOf(jResp,L"org[i].license_details.trial_expiry");
Paid = CkJsonObjectW_BoolOf(jResp,L"org[i].license_details.paid");
Paid_type = CkJsonObjectW_stringOf(jResp,L"org[i].license_details.paid_type");
phone = CkJsonObjectW_stringOf(jResp,L"org[i].phone");
company_name = CkJsonObjectW_stringOf(jResp,L"org[i].company_name");
privacy_settings = CkJsonObjectW_BoolOf(jResp,L"org[i].privacy_settings");
primary_email = CkJsonObjectW_stringOf(jResp,L"org[i].primary_email");
iso_code = CkJsonObjectW_stringOf(jResp,L"org[i].iso_code");
i = i + 1;
}
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Authorization: {{authorization-token}}"
https://domain.com/crm/v2.1/org
Postman Collection Item JSON
{
"name": "Organization Details",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org"
]
},
"description": "To get the organization data."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 04 May 2021 13:41:05 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "847"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-04T14:40:46+00:00"
},
{
"key": "clientVersion",
"value": "4004813"
},
{
"key": "clientsubVersion",
"value": "fb33599b767b94d06d2bd2529079b386"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"org\": [\n {\n \"country\": null,\n \"hierarchy_preferences\": {\n \"type\": \"Role_Hierarchy\"\n },\n \"photo_id\": null,\n \"city\": null,\n \"description\": null,\n \"mc_status\": true,\n \"gapps_enabled\": false,\n \"domain_name\": \"org60036018\",\n \"translation_enabled\": true,\n \"street\": null,\n \"alias\": null,\n \"currency\": \"Indian Rupee\",\n \"id\": \"738964000000300043\",\n \"state\": null,\n \"fax\": null,\n \"employee_count\": null,\n \"zip\": null,\n \"website\": null,\n \"currency_symbol\": \"₹\",\n \"mobile\": null,\n \"currency_locale\": \"en_IN\",\n \"primary_zuid\": \"60034346\",\n \"zia_portal_id\": null,\n \"time_zone\": \"Asia/Kolkata\",\n \"zgid\": \"60036018\",\n \"country_code\": \"IN\",\n \"license_details\": {\n \"paid_expiry\": \"2021-10-20T00:00:00+00:00\",\n \"users_license_purchased\": 25,\n \"trial_type\": null,\n \"trial_expiry\": null,\n \"paid\": true,\n \"paid_type\": \"enterprise\"\n },\n \"phone\": \"312\",\n \"company_name\": \"Zylker\",\n \"privacy_settings\": false,\n \"primary_email\": \"patricia@zohocorp.com\",\n \"iso_code\": \"INR\"\n }\n ]\n}"
},
{
"name": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 04 May 2021 12:36:48 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "98"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"AUTHENTICATION_FAILURE\",\n \"details\": {},\n \"message\": \"Authentication failed\",\n \"status\": \"error\"\n}"
},
{
"name": "OAUTH_SCOPE_MISMATCH",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 04 May 2021 13:37:11 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "113"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"OAUTH_SCOPE_MISMATCH\",\n \"details\": {},\n \"message\": \"invalid oauth scope to access this URL\",\n \"status\": \"error\"\n}"
}
]
}
