Back to Collection Items
var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Name: PWideChar;
Id: PWideChar;
v_Email: PWideChar;
Scurrency_symbol: PWideChar;
Account_Type: PWideChar;
SIC_Code: PWideChar;
Ssharing_permission: PWideChar;
Last_Activity_Time: PWideChar;
Industry: PWideChar;
Account_Site: PWideChar;
Sstate: PWideChar;
Sprocess_flow: Boolean;
Exchange_Rate: Integer;
Billing_Country: PWideChar;
v_Currency: PWideChar;
id: PWideChar;
Sapproved: Boolean;
Delegate: Boolean;
Approve: Boolean;
Reject: Boolean;
Resubmit: Boolean;
Billing_Street: PWideChar;
Created_Time: PWideChar;
Seditable: Boolean;
Billing_Code: PWideChar;
Shipping_City: PWideChar;
Shipping_Country: PWideChar;
Shipping_Code: PWideChar;
Billing_City: PWideChar;
Created_ByName: PWideChar;
Created_ById: PWideChar;
Created_ByEmail: PWideChar;
Annual_Revenue: Integer;
Shipping_Street: PWideChar;
territory_updated_time: PWideChar;
Ownership: PWideChar;
Description: PWideChar;
Rating: PWideChar;
Shipping_State: PWideChar;
Sreview_processApprove: Boolean;
Sreview_processReject: Boolean;
Sreview_processResubmit: Boolean;
Website: PWideChar;
Employees: PWideChar;
Record_Image: PWideChar;
Modified_ByName: PWideChar;
Modified_ById: PWideChar;
Modified_ByEmail: PWideChar;
Sreview: PWideChar;
Phone: PWideChar;
Account_Name: PWideChar;
Account_Number: PWideChar;
Ticker_Symbol: PWideChar;
Modified_Time: PWideChar;
Sorchestration: Boolean;
Parent_Account: PWideChar;
Sin_merge: Boolean;
Billing_State: PWideChar;
Fax: PWideChar;
Sapproval_state: PWideChar;
j: Integer;
count_j: Integer;
Sassigned: PWideChar;
Sassigned_time: PWideChar;
Sassigned_by: 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();
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://domain.com/crm/v2.1/Accounts',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)
// {
// "data": [
// {
// "Owner": {
// "name": "patricia patricia",
// "id": "738964000000291009",
// "email": "patricia.ss@zylker.com"
// },
// "$currency_symbol": "Af",
// "Account_Type": null,
// "SIC_Code": null,
// "$sharing_permission": "full_access",
// "Last_Activity_Time": "2021-04-21T08:53:58+00:00",
// "Industry": null,
// "Account_Site": null,
// "$state": "save",
// "$process_flow": false,
// "Exchange_Rate": 1,
// "Billing_Country": null,
// "Currency": "AFN",
// "id": "738964000002058030",
// "$approved": true,
// "$approval": {
// "delegate": false,
// "approve": false,
// "reject": false,
// "resubmit": false
// },
// "Billing_Street": null,
// "Created_Time": "2021-04-21T08:53:58+00:00",
// "$editable": true,
// "Billing_Code": "1234",
// "Shipping_City": null,
// "Shipping_Country": null,
// "Shipping_Code": null,
// "Billing_City": null,
// "Created_By": {
// "name": "patricia patricia",
// "id": "738964000000291009",
// "email": "patricia.ss@zylker.com"
// },
// "Annual_Revenue": 1,
// "Shipping_Street": null,
// "territory_updated_time": null,
// "Ownership": null,
// "Description": null,
// "Rating": null,
// "Shipping_State": null,
// "$review_process": {
// "approve": false,
// "reject": false,
// "resubmit": false
// },
// "Website": "https://yaythisworked.com",
// "Employees": null,
// "Record_Image": null,
// "Modified_By": {
// "name": "patricia patricia",
// "id": "738964000000291009",
// "email": "patricia.ss@zylker.com"
// },
// "$review": null,
// "Phone": null,
// "Account_Name": "Zylker",
// "Account_Number": "0",
// "Ticker_Symbol": null,
// "Modified_Time": "2021-04-21T08:53:58+00:00",
// "Territories": [
// {
// "$assigned": "automatically",
// "$assigned_time": "2021-04-21T08:54:13+00:00",
// "id": "738964000001977355",
// "$assigned_by": null,
// "Name": "South Zone"
// }
// ],
// "$orchestration": false,
// "Parent_Account": null,
// "$in_merge": false,
// "Billing_State": "Colorado",
// "Tag": [
// ],
// "Fax": null,
// "$approval_state": "approved"
// }
// ],
// "info": {
// "per_page": 200,
// "count": 1,
// "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,'data');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
Name := CkJsonObject__stringOf(jResp,'data[i].Owner.name');
Id := CkJsonObject__stringOf(jResp,'data[i].Owner.id');
v_Email := CkJsonObject__stringOf(jResp,'data[i].Owner.email');
Scurrency_symbol := CkJsonObject__stringOf(jResp,'data[i].$currency_symbol');
Account_Type := CkJsonObject__stringOf(jResp,'data[i].Account_Type');
SIC_Code := CkJsonObject__stringOf(jResp,'data[i].SIC_Code');
Ssharing_permission := CkJsonObject__stringOf(jResp,'data[i].$sharing_permission');
Last_Activity_Time := CkJsonObject__stringOf(jResp,'data[i].Last_Activity_Time');
Industry := CkJsonObject__stringOf(jResp,'data[i].Industry');
Account_Site := CkJsonObject__stringOf(jResp,'data[i].Account_Site');
Sstate := CkJsonObject__stringOf(jResp,'data[i].$state');
Sprocess_flow := CkJsonObject_BoolOf(jResp,'data[i].$process_flow');
Exchange_Rate := CkJsonObject_IntOf(jResp,'data[i].Exchange_Rate');
Billing_Country := CkJsonObject__stringOf(jResp,'data[i].Billing_Country');
v_Currency := CkJsonObject__stringOf(jResp,'data[i].Currency');
id := CkJsonObject__stringOf(jResp,'data[i].id');
Sapproved := CkJsonObject_BoolOf(jResp,'data[i].$approved');
Delegate := CkJsonObject_BoolOf(jResp,'data[i].$approval.delegate');
Approve := CkJsonObject_BoolOf(jResp,'data[i].$approval.approve');
Reject := CkJsonObject_BoolOf(jResp,'data[i].$approval.reject');
Resubmit := CkJsonObject_BoolOf(jResp,'data[i].$approval.resubmit');
Billing_Street := CkJsonObject__stringOf(jResp,'data[i].Billing_Street');
Created_Time := CkJsonObject__stringOf(jResp,'data[i].Created_Time');
Seditable := CkJsonObject_BoolOf(jResp,'data[i].$editable');
Billing_Code := CkJsonObject__stringOf(jResp,'data[i].Billing_Code');
Shipping_City := CkJsonObject__stringOf(jResp,'data[i].Shipping_City');
Shipping_Country := CkJsonObject__stringOf(jResp,'data[i].Shipping_Country');
Shipping_Code := CkJsonObject__stringOf(jResp,'data[i].Shipping_Code');
Billing_City := CkJsonObject__stringOf(jResp,'data[i].Billing_City');
Created_ByName := CkJsonObject__stringOf(jResp,'data[i].Created_By.name');
Created_ById := CkJsonObject__stringOf(jResp,'data[i].Created_By.id');
Created_ByEmail := CkJsonObject__stringOf(jResp,'data[i].Created_By.email');
Annual_Revenue := CkJsonObject_IntOf(jResp,'data[i].Annual_Revenue');
Shipping_Street := CkJsonObject__stringOf(jResp,'data[i].Shipping_Street');
territory_updated_time := CkJsonObject__stringOf(jResp,'data[i].territory_updated_time');
Ownership := CkJsonObject__stringOf(jResp,'data[i].Ownership');
Description := CkJsonObject__stringOf(jResp,'data[i].Description');
Rating := CkJsonObject__stringOf(jResp,'data[i].Rating');
Shipping_State := CkJsonObject__stringOf(jResp,'data[i].Shipping_State');
Sreview_processApprove := CkJsonObject_BoolOf(jResp,'data[i].$review_process.approve');
Sreview_processReject := CkJsonObject_BoolOf(jResp,'data[i].$review_process.reject');
Sreview_processResubmit := CkJsonObject_BoolOf(jResp,'data[i].$review_process.resubmit');
Website := CkJsonObject__stringOf(jResp,'data[i].Website');
Employees := CkJsonObject__stringOf(jResp,'data[i].Employees');
Record_Image := CkJsonObject__stringOf(jResp,'data[i].Record_Image');
Modified_ByName := CkJsonObject__stringOf(jResp,'data[i].Modified_By.name');
Modified_ById := CkJsonObject__stringOf(jResp,'data[i].Modified_By.id');
Modified_ByEmail := CkJsonObject__stringOf(jResp,'data[i].Modified_By.email');
Sreview := CkJsonObject__stringOf(jResp,'data[i].$review');
Phone := CkJsonObject__stringOf(jResp,'data[i].Phone');
Account_Name := CkJsonObject__stringOf(jResp,'data[i].Account_Name');
Account_Number := CkJsonObject__stringOf(jResp,'data[i].Account_Number');
Ticker_Symbol := CkJsonObject__stringOf(jResp,'data[i].Ticker_Symbol');
Modified_Time := CkJsonObject__stringOf(jResp,'data[i].Modified_Time');
Sorchestration := CkJsonObject_BoolOf(jResp,'data[i].$orchestration');
Parent_Account := CkJsonObject__stringOf(jResp,'data[i].Parent_Account');
Sin_merge := CkJsonObject_BoolOf(jResp,'data[i].$in_merge');
Billing_State := CkJsonObject__stringOf(jResp,'data[i].Billing_State');
Fax := CkJsonObject__stringOf(jResp,'data[i].Fax');
Sapproval_state := CkJsonObject__stringOf(jResp,'data[i].$approval_state');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'data[i].Territories');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
Sassigned := CkJsonObject__stringOf(jResp,'data[i].Territories[j].$assigned');
Sassigned_time := CkJsonObject__stringOf(jResp,'data[i].Territories[j].$assigned_time');
id := CkJsonObject__stringOf(jResp,'data[i].Territories[j].id');
Sassigned_by := CkJsonObject__stringOf(jResp,'data[i].Territories[j].$assigned_by');
Name := CkJsonObject__stringOf(jResp,'data[i].Territories[j].Name');
j := j + 1;
end;
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'data[i].Tag');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
j := j + 1;
end;
i := i + 1;
end;
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2.1/Accounts
Postman Collection Item JSON
{
"name": "Accounts",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Accounts",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Accounts"
]
},
"description": "To get the list of available records in the Accounts module."
},
"response": [
{
"name": "P8: territory_id",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Accounts?territory_id=738964000001977355",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Accounts"
],
"query": [
{
"key": "territory_id",
"value": "738964000001977355"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:44:50 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"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-05T07:39:40+00:00"
},
{
"key": "clientVersion",
"value": "4009533"
},
{
"key": "clientsubVersion",
"value": "cfa914635a0a376a1322139140e8bf37"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"Owner\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$currency_symbol\": \"Af\",\n \"Account_Type\": null,\n \"SIC_Code\": null,\n \"$sharing_permission\": \"full_access\",\n \"Last_Activity_Time\": \"2021-04-21T08:53:58+00:00\",\n \"Industry\": null,\n \"Account_Site\": null,\n \"$state\": \"save\",\n \"$process_flow\": false,\n \"Exchange_Rate\": 1,\n \"Billing_Country\": null,\n \"Currency\": \"AFN\",\n \"id\": \"738964000002058030\",\n \"$approved\": true,\n \"$approval\": {\n \"delegate\": false,\n \"approve\": false,\n \"reject\": false,\n \"resubmit\": false\n },\n \"Billing_Street\": null,\n \"Created_Time\": \"2021-04-21T08:53:58+00:00\",\n \"$editable\": true,\n \"Billing_Code\": \"1234\",\n \"Shipping_City\": null,\n \"Shipping_Country\": null,\n \"Shipping_Code\": null,\n \"Billing_City\": null,\n \"Created_By\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"Annual_Revenue\": 1,\n \"Shipping_Street\": null,\n \"territory_updated_time\": null,\n \"Ownership\": null,\n \"Description\": null,\n \"Rating\": null,\n \"Shipping_State\": null,\n \"$review_process\": {\n \"approve\": false,\n \"reject\": false,\n \"resubmit\": false\n },\n \"Website\": \"https://yaythisworked.com\",\n \"Employees\": null,\n \"Record_Image\": null,\n \"Modified_By\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$review\": null,\n \"Phone\": null,\n \"Account_Name\": \"Zylker\",\n \"Account_Number\": \"0\",\n \"Ticker_Symbol\": null,\n \"Modified_Time\": \"2021-04-21T08:53:58+00:00\",\n \"Territories\": [\n {\n \"$assigned\": \"automatically\",\n \"$assigned_time\": \"2021-04-21T08:54:13+00:00\",\n \"id\": \"738964000001977355\",\n \"$assigned_by\": null,\n \"Name\": \"South Zone\"\n }\n ],\n \"$orchestration\": false,\n \"Parent_Account\": null,\n \"$in_merge\": false,\n \"Billing_State\": \"Colorado\",\n \"Tag\": [],\n \"Fax\": null,\n \"$approval_state\": \"approved\"\n }\n ],\n \"info\": {\n \"per_page\": 200,\n \"count\": 1,\n \"page\": 1,\n \"more_records\": false\n }\n}"
},
{
"name": "P9: include_child",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Accounts?territory_id=738964000001977355&include_child=true",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Accounts"
],
"query": [
{
"key": "territory_id",
"value": "738964000001977355"
},
{
"key": "include_child",
"value": "true"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:45:34 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"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-05T07:39:40+00:00"
},
{
"key": "clientVersion",
"value": "4009533"
},
{
"key": "clientsubVersion",
"value": "cfa914635a0a376a1322139140e8bf37"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"Owner\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$currency_symbol\": \"Af\",\n \"Account_Type\": null,\n \"SIC_Code\": null,\n \"$sharing_permission\": \"full_access\",\n \"Last_Activity_Time\": \"2021-04-21T08:53:58+00:00\",\n \"Industry\": null,\n \"Account_Site\": null,\n \"$state\": \"save\",\n \"$process_flow\": false,\n \"Exchange_Rate\": 1,\n \"Billing_Country\": null,\n \"Currency\": \"AFN\",\n \"id\": \"738964000002058030\",\n \"$approved\": true,\n \"$approval\": {\n \"delegate\": false,\n \"approve\": false,\n \"reject\": false,\n \"resubmit\": false\n },\n \"Billing_Street\": null,\n \"Created_Time\": \"2021-04-21T08:53:58+00:00\",\n \"$editable\": true,\n \"Billing_Code\": \"1234\",\n \"Shipping_City\": null,\n \"Shipping_Country\": null,\n \"Shipping_Code\": null,\n \"Billing_City\": null,\n \"Created_By\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"Annual_Revenue\": 1,\n \"Shipping_Street\": null,\n \"territory_updated_time\": null,\n \"Ownership\": null,\n \"Description\": null,\n \"Rating\": null,\n \"Shipping_State\": null,\n \"$review_process\": {\n \"approve\": false,\n \"reject\": false,\n \"resubmit\": false\n },\n \"Website\": \"https://yaythisworked.com\",\n \"Employees\": null,\n \"Record_Image\": null,\n \"Modified_By\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$review\": null,\n \"Phone\": null,\n \"Account_Name\": \"Zylker\",\n \"Account_Number\": \"0\",\n \"Ticker_Symbol\": null,\n \"Modified_Time\": \"2021-04-21T08:53:58+00:00\",\n \"Territories\": [\n {\n \"$assigned\": \"automatically\",\n \"$assigned_time\": \"2021-04-21T08:54:13+00:00\",\n \"id\": \"738964000001977355\",\n \"$assigned_by\": null,\n \"Name\": \"South Zone\"\n }\n ],\n \"$orchestration\": false,\n \"Parent_Account\": null,\n \"$in_merge\": false,\n \"Billing_State\": \"Colorado\",\n \"Tag\": [],\n \"Fax\": null,\n \"$approval_state\": \"approved\"\n }\n ],\n \"info\": {\n \"per_page\": 200,\n \"count\": 1,\n \"page\": 1,\n \"more_records\": false\n }\n}"
}
]
}
