Back to Collection Items
var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Name: PWideChar;
Id: PWideChar;
v_Email: PWideChar;
Company: PWideChar;
Scurrency_symbol: PWideChar;
Interested_Leads: PWideChar;
Last_Activity_Time: PWideChar;
Industry: PWideChar;
Sstate: PWideChar;
Unsubscribed_Mode: PWideChar;
Sconverted: Boolean;
Sprocess_flow: Boolean;
Exchange_Rate: Integer;
v_Currency: PWideChar;
Street: PWideChar;
Zip_Code: PWideChar;
Data_Processing_Basis_Details: PWideChar;
id: PWideChar;
Data_Source: PWideChar;
Sapproved: Boolean;
Delegate: Boolean;
Approve: Boolean;
Reject: Boolean;
Resubmit: Boolean;
Sdata_source_details: PWideChar;
Created_Time: PWideChar;
Seditable: Boolean;
City: PWideChar;
No_of_Employees: Integer;
State: PWideChar;
Country: PWideChar;
Created_ByName: PWideChar;
Created_ById: PWideChar;
Created_ByEmail: PWideChar;
Annual_Revenue: Integer;
Secondary_Email: PWideChar;
Description: PWideChar;
Rating: PWideChar;
Sreview_processApprove: Boolean;
Sreview_processReject: Boolean;
Sreview_processResubmit: Boolean;
Website: PWideChar;
Twitter: PWideChar;
Scanvas_id: PWideChar;
Salutation: PWideChar;
First_Name: PWideChar;
Lead_Status: PWideChar;
Full_Name: PWideChar;
Record_Image: PWideChar;
Modified_ByName: PWideChar;
Modified_ById: PWideChar;
Modified_ByEmail: PWideChar;
Sreview: PWideChar;
Skype_ID: PWideChar;
Phone: PWideChar;
HIPAA: PWideChar;
Email_Opt_Out: Boolean;
Designation: PWideChar;
Modified_Time: PWideChar;
Unsubscribed_Time: PWideChar;
Mobile: PWideChar;
Sorchestration: Boolean;
Sstop_processing: Boolean;
Last_Name: PWideChar;
Sin_merge: Boolean;
Lead_Source: PWideChar;
Fax: PWideChar;
Sapproval_state: PWideChar;
j: Integer;
count_j: Integer;
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/Leads/{{record_id}}',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 Boyle",
// "id": "738964000000291009",
// "email": "patricia.ss@zylker.com"
// },
// "Company": null,
// "Email": null,
// "$currency_symbol": "Af",
// "Interested_Leads": null,
// "Last_Activity_Time": "2021-05-07T13:10:11+00:00",
// "Industry": null,
// "$state": "save",
// "Unsubscribed_Mode": null,
// "$converted": false,
// "$process_flow": false,
// "Exchange_Rate": 1,
// "Currency": "AFN",
// "Street": null,
// "Zip_Code": "1234",
// "Data_Processing_Basis_Details": null,
// "id": "738964000002131001",
// "Data_Source": "Manual",
// "$approved": true,
// "$approval": {
// "delegate": false,
// "approve": false,
// "reject": false,
// "resubmit": false
// },
// "$data_source_details": null,
// "Created_Time": "2021-05-07T06:23:10+00:00",
// "$editable": true,
// "City": null,
// "No_of_Employees": 1000,
// "State": "Colorado",
// "Country": null,
// "Created_By": {
// "name": "Patricia Boyle",
// "id": "738964000000291009",
// "email": "patricia.ss@zylker.com"
// },
// "Annual_Revenue": 1,
// "Secondary_Email": null,
// "Description": null,
// "Rating": null,
// "$review_process": {
// "approve": false,
// "reject": false,
// "resubmit": false
// },
// "Website": "https://yaythisworked.com",
// "Twitter": null,
// "$canvas_id": null,
// "Salutation": null,
// "First_Name": null,
// "Lead_Status": null,
// "Full_Name": "sample",
// "Record_Image": null,
// "Modified_By": {
// "name": "Patricia Boyle",
// "id": "738964000000291009",
// "email": "patricia.ss@zylker.com"
// },
// "$review": null,
// "Skype_ID": null,
// "Phone": null,
// "HIPAA": null,
// "Email_Opt_Out": false,
// "Designation": null,
// "Modified_Time": "2021-05-07T13:10:11+00:00",
// "$converted_detail": {},
// "Unsubscribed_Time": null,
// "Mobile": "9898989898",
// "$orchestration": false,
// "$stop_processing": false,
// "Last_Name": "sample",
// "$in_merge": false,
// "Lead_Source": null,
// "Tag": [
// ],
// "Fax": null,
// "$approval_state": "approved"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
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');
Company := CkJsonObject__stringOf(jResp,'data[i].Company');
v_Email := CkJsonObject__stringOf(jResp,'data[i].Email');
Scurrency_symbol := CkJsonObject__stringOf(jResp,'data[i].$currency_symbol');
Interested_Leads := CkJsonObject__stringOf(jResp,'data[i].Interested_Leads');
Last_Activity_Time := CkJsonObject__stringOf(jResp,'data[i].Last_Activity_Time');
Industry := CkJsonObject__stringOf(jResp,'data[i].Industry');
Sstate := CkJsonObject__stringOf(jResp,'data[i].$state');
Unsubscribed_Mode := CkJsonObject__stringOf(jResp,'data[i].Unsubscribed_Mode');
Sconverted := CkJsonObject_BoolOf(jResp,'data[i].$converted');
Sprocess_flow := CkJsonObject_BoolOf(jResp,'data[i].$process_flow');
Exchange_Rate := CkJsonObject_IntOf(jResp,'data[i].Exchange_Rate');
v_Currency := CkJsonObject__stringOf(jResp,'data[i].Currency');
Street := CkJsonObject__stringOf(jResp,'data[i].Street');
Zip_Code := CkJsonObject__stringOf(jResp,'data[i].Zip_Code');
Data_Processing_Basis_Details := CkJsonObject__stringOf(jResp,'data[i].Data_Processing_Basis_Details');
id := CkJsonObject__stringOf(jResp,'data[i].id');
Data_Source := CkJsonObject__stringOf(jResp,'data[i].Data_Source');
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');
Sdata_source_details := CkJsonObject__stringOf(jResp,'data[i].$data_source_details');
Created_Time := CkJsonObject__stringOf(jResp,'data[i].Created_Time');
Seditable := CkJsonObject_BoolOf(jResp,'data[i].$editable');
City := CkJsonObject__stringOf(jResp,'data[i].City');
No_of_Employees := CkJsonObject_IntOf(jResp,'data[i].No_of_Employees');
State := CkJsonObject__stringOf(jResp,'data[i].State');
Country := CkJsonObject__stringOf(jResp,'data[i].Country');
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');
Secondary_Email := CkJsonObject__stringOf(jResp,'data[i].Secondary_Email');
Description := CkJsonObject__stringOf(jResp,'data[i].Description');
Rating := CkJsonObject__stringOf(jResp,'data[i].Rating');
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');
Twitter := CkJsonObject__stringOf(jResp,'data[i].Twitter');
Scanvas_id := CkJsonObject__stringOf(jResp,'data[i].$canvas_id');
Salutation := CkJsonObject__stringOf(jResp,'data[i].Salutation');
First_Name := CkJsonObject__stringOf(jResp,'data[i].First_Name');
Lead_Status := CkJsonObject__stringOf(jResp,'data[i].Lead_Status');
Full_Name := CkJsonObject__stringOf(jResp,'data[i].Full_Name');
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');
Skype_ID := CkJsonObject__stringOf(jResp,'data[i].Skype_ID');
Phone := CkJsonObject__stringOf(jResp,'data[i].Phone');
HIPAA := CkJsonObject__stringOf(jResp,'data[i].HIPAA');
Email_Opt_Out := CkJsonObject_BoolOf(jResp,'data[i].Email_Opt_Out');
Designation := CkJsonObject__stringOf(jResp,'data[i].Designation');
Modified_Time := CkJsonObject__stringOf(jResp,'data[i].Modified_Time');
Unsubscribed_Time := CkJsonObject__stringOf(jResp,'data[i].Unsubscribed_Time');
Mobile := CkJsonObject__stringOf(jResp,'data[i].Mobile');
Sorchestration := CkJsonObject_BoolOf(jResp,'data[i].$orchestration');
Sstop_processing := CkJsonObject_BoolOf(jResp,'data[i].$stop_processing');
Last_Name := CkJsonObject__stringOf(jResp,'data[i].Last_Name');
Sin_merge := CkJsonObject_BoolOf(jResp,'data[i].$in_merge');
Lead_Source := CkJsonObject__stringOf(jResp,'data[i].Lead_Source');
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].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/Leads/{{record_id}}
Postman Collection Item JSON
{
"name": "Subforms",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/Leads/{{record_id}}",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads",
"{{record_id}}"
]
},
"description": "To get the subform data in a record."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/Leads/738964000002131001",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads",
"738964000002131001"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 13:16:36 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-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-11T13:58:39+00:00"
},
{
"key": "clientVersion",
"value": "4023320"
},
{
"key": "clientsubVersion",
"value": "4d8b6ee4f7d1d284c930a4e807480c5c"
},
{
"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 Boyle\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"Company\": null,\n \"Email\": null,\n \"$currency_symbol\": \"Af\",\n \"Interested_Leads\": null,\n \"Last_Activity_Time\": \"2021-05-07T13:10:11+00:00\",\n \"Industry\": null,\n \"$state\": \"save\",\n \"Unsubscribed_Mode\": null,\n \"$converted\": false,\n \"$process_flow\": false,\n \"Exchange_Rate\": 1,\n \"Currency\": \"AFN\",\n \"Street\": null,\n \"Zip_Code\": \"1234\",\n \"Data_Processing_Basis_Details\": null,\n \"id\": \"738964000002131001\",\n \"Data_Source\": \"Manual\",\n \"$approved\": true,\n \"$approval\": {\n \"delegate\": false,\n \"approve\": false,\n \"reject\": false,\n \"resubmit\": false\n },\n \"$data_source_details\": null,\n \"Created_Time\": \"2021-05-07T06:23:10+00:00\",\n \"$editable\": true,\n \"City\": null,\n \"No_of_Employees\": 1000,\n \"State\": \"Colorado\",\n \"Country\": null,\n \"Created_By\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"Annual_Revenue\": 1,\n \"Secondary_Email\": null,\n \"Description\": null,\n \"Rating\": null,\n \"$review_process\": {\n \"approve\": false,\n \"reject\": false,\n \"resubmit\": false\n },\n \"Website\": \"https://yaythisworked.com\",\n \"Twitter\": null,\n \"$canvas_id\": null,\n \"Salutation\": null,\n \"First_Name\": null,\n \"Lead_Status\": null,\n \"Full_Name\": \"sample\",\n \"Record_Image\": null,\n \"Modified_By\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$review\": null,\n \"Skype_ID\": null,\n \"Phone\": null,\n \"HIPAA\": null,\n \"Email_Opt_Out\": false,\n \"Designation\": null,\n \"Modified_Time\": \"2021-05-07T13:10:11+00:00\",\n \"$converted_detail\": {},\n \"Unsubscribed_Time\": null,\n \"Mobile\": \"9898989898\",\n \"$orchestration\": false,\n \"$stop_processing\": false,\n \"Last_Name\": \"sample\",\n \"$in_merge\": false,\n \"Lead_Source\": null,\n \"Tag\": [],\n \"Fax\": null,\n \"$approval_state\": \"approved\"\n }\n ]\n}"
},
{
"name": "INVALID_MODULE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/Lead/738964000002131001",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Lead",
"738964000002131001"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 13:16:54 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "110"
},
{
"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-11T13:58:39+00:00"
},
{
"key": "clientVersion",
"value": "4023320"
},
{
"key": "clientsubVersion",
"value": "4d8b6ee4f7d1d284c930a4e807480c5c"
},
{
"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_MODULE\",\n \"details\": {},\n \"message\": \"the module name given seems to be invalid\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "COPY",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/Leads/738964000002131001",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads",
"738964000002131001"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 13:17:14 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": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/Leads/738964000002131001",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads",
"738964000002131001"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 13:17:33 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": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/Leads/{{record_id}}",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads",
"{{record_id}}"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 06:35:48 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}"
}
]
}
