Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *Name;
const char *Id;
const char *v_Email;
const char *Company;
const char *Scurrency_symbol;
const char *Interested_Leads;
const char *Last_Activity_Time;
const char *Industry;
const char *Sstate;
const char *Unsubscribed_Mode;
BOOL Sconverted;
BOOL Sprocess_flow;
int Exchange_Rate;
const char *v_Currency;
const char *Street;
const char *Zip_Code;
const char *Data_Processing_Basis_Details;
const char *id;
const char *Data_Source;
BOOL Sapproved;
BOOL Delegate;
BOOL Approve;
BOOL Reject;
BOOL Resubmit;
const char *Sdata_source_details;
const char *Created_Time;
BOOL Seditable;
const char *City;
int No_of_Employees;
const char *State;
const char *Country;
const char *Created_ByName;
const char *Created_ById;
const char *Created_ByEmail;
int Annual_Revenue;
const char *Secondary_Email;
const char *Description;
const char *Rating;
BOOL Sreview_processApprove;
BOOL Sreview_processReject;
BOOL Sreview_processResubmit;
const char *Website;
const char *Twitter;
const char *Scanvas_id;
const char *Salutation;
const char *First_Name;
const char *Lead_Status;
const char *Full_Name;
const char *Record_Image;
const char *Modified_ByName;
const char *Modified_ById;
const char *Modified_ByEmail;
const char *Sreview;
const char *Skype_ID;
const char *Phone;
const char *HIPAA;
BOOL Email_Opt_Out;
const char *Designation;
const char *Modified_Time;
const char *Unsubscribed_Time;
const char *Mobile;
BOOL Sorchestration;
BOOL Sstop_processing;
const char *Last_Name;
BOOL Sin_merge;
const char *Lead_Source;
const char *Fax;
const char *Sapproval_state;
int j;
int count_j;
int i;
int count_i;
// 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) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"data");
while (i < count_i) {
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) {
CkJsonObject_putJ(jResp,j);
j = j + 1;
}
i = i + 1;
}
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}"
}
]
}
