Back to Collection Items
var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
created_time: PWideChar;
modified_time: PWideChar;
Name: PWideChar;
Id: PWideChar;
parent_id: PWideChar;
criteria: PWideChar;
name: PWideChar;
modified_byName: PWideChar;
modified_byId: PWideChar;
description: PWideChar;
id: PWideChar;
created_byName: PWideChar;
created_byId: PWideChar;
manager: PWideChar;
Comparator: PWideChar;
Field: PWideChar;
Value: PWideChar;
Per_page: Integer;
Count: Integer;
Page: Integer;
More_records: Boolean;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
CkHttp_SetRequestHeader(http,'Authorization','{{authorization-token}}');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://domain.com/crm/v2/settings/territories',sbResponseBody);
if (success = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttp__lastHeader(http));
Memo1.Lines.Add('Failed.');
Exit;
end;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "territories": [
// {
// "created_time": "2021-03-18T09:21:33+00:00",
// "modified_time": "2021-03-18T09:21:33+00:00",
// "manager": {
// "name": "Patricia Boyle",
// "id": "738964000000291009"
// },
// "parent_id": null,
// "criteria": null,
// "name": "Zylker Inc.",
// "modified_by": {
// "name": "Patricia Boyle",
// "id": "738964000000291009"
// },
// "description": "Organization Parent Territory",
// "id": "738964000001977341",
// "created_by": {
// "name": "Patricia Boyle",
// "id": "738964000000291009"
// }
// },
// {
// "created_time": "2021-03-18T09:21:55+00:00",
// "modified_time": "2021-03-18T09:21:55+00:00",
// "manager": null,
// "parent_id": "738964000001977341",
// "criteria": {
// "comparator": "contains",
// "field": "Account_Name",
// "value": "Zylker"
// },
// "name": "South Zone",
// "modified_by": {
// "name": "Patricia Boyle",
// "id": "738964000000291009"
// },
// "description": null,
// "id": "738964000001977355",
// "created_by": {
// "name": "Patricia Boyle",
// "id": "738964000000291009"
// }
// }
// ],
// "info": {
// "per_page": 200,
// "count": 2,
// "page": 1,
// "more_records": false
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Per_page := CkJsonObject_IntOf(jResp,'info.per_page');
Count := CkJsonObject_IntOf(jResp,'info.count');
Page := CkJsonObject_IntOf(jResp,'info.page');
More_records := CkJsonObject_BoolOf(jResp,'info.more_records');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'territories');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
created_time := CkJsonObject__stringOf(jResp,'territories[i].created_time');
modified_time := CkJsonObject__stringOf(jResp,'territories[i].modified_time');
Name := CkJsonObject__stringOf(jResp,'territories[i].manager.name');
Id := CkJsonObject__stringOf(jResp,'territories[i].manager.id');
parent_id := CkJsonObject__stringOf(jResp,'territories[i].parent_id');
criteria := CkJsonObject__stringOf(jResp,'territories[i].criteria');
name := CkJsonObject__stringOf(jResp,'territories[i].name');
modified_byName := CkJsonObject__stringOf(jResp,'territories[i].modified_by.name');
modified_byId := CkJsonObject__stringOf(jResp,'territories[i].modified_by.id');
description := CkJsonObject__stringOf(jResp,'territories[i].description');
id := CkJsonObject__stringOf(jResp,'territories[i].id');
created_byName := CkJsonObject__stringOf(jResp,'territories[i].created_by.name');
created_byId := CkJsonObject__stringOf(jResp,'territories[i].created_by.id');
manager := CkJsonObject__stringOf(jResp,'territories[i].manager');
Comparator := CkJsonObject__stringOf(jResp,'territories[i].criteria.comparator');
Field := CkJsonObject__stringOf(jResp,'territories[i].criteria.field');
Value := CkJsonObject__stringOf(jResp,'territories[i].criteria.value');
i := i + 1;
end;
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Authorization: {{authorization-token}}"
-H "Content-Type: application/json"
https://domain.com/crm/v2/settings/territories
Postman Collection Item JSON
{
"name": "Territories",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/territories",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"territories"
]
},
"description": "To get the list of territories enabled for your organization."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/territories",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"territories"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:20:18 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "908"
},
{
"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-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-11T12:57:36+00:00"
},
{
"key": "clientVersion",
"value": "4023320"
},
{
"key": "clientsubVersion",
"value": "4d8b6ee4f7d1d284c930a4e807480c5c"
},
{
"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 \"territories\": [\n {\n \"created_time\": \"2021-03-18T09:21:33+00:00\",\n \"modified_time\": \"2021-03-18T09:21:33+00:00\",\n \"manager\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"738964000000291009\"\n },\n \"parent_id\": null,\n \"criteria\": null,\n \"name\": \"Zylker Inc.\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"738964000000291009\"\n },\n \"description\": \"Organization Parent Territory\",\n \"id\": \"738964000001977341\",\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"738964000000291009\"\n }\n },\n {\n \"created_time\": \"2021-03-18T09:21:55+00:00\",\n \"modified_time\": \"2021-03-18T09:21:55+00:00\",\n \"manager\": null,\n \"parent_id\": \"738964000001977341\",\n \"criteria\": {\n \"comparator\": \"contains\",\n \"field\": \"Account_Name\",\n \"value\": \"Zylker\"\n },\n \"name\": \"South Zone\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"738964000000291009\"\n },\n \"description\": null,\n \"id\": \"738964000001977355\",\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"738964000000291009\"\n }\n }\n ],\n \"info\": {\n \"per_page\": 200,\n \"count\": 2,\n \"page\": 1,\n \"more_records\": false\n }\n}"
},
{
"name": "INVALID_URL_PATTERN",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/territorie",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"territorie"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:21:05 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "131"
},
{
"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-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-11T12:57:36+00:00"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_URL_PATTERN\",\n \"details\": {},\n \"message\": \"Please check if the URL trying to access is a correct one\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "COPY",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/territorie",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"territorie"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:21:20 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "124"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Frame-Options",
"value": "deny"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_REQUEST_METHOD\",\n \"details\": {},\n \"message\": \"The http request method type is not a valid one\",\n \"status\": \"error\"\n}"
},
{
"name": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/territories",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"territories"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:21:44 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}}"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/territories",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"territories"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 08:28:41 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}"
}
]
}
