Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://domain.com/crm/v2/Leads/{{record_id}}",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
Name.s
Id.s
v_Email.s
Company.s
Scurrency_symbol.s
Interested_Leads.s
Last_Activity_Time.s
Industry.s
Sstate.s
Unsubscribed_Mode.s
Sconverted.i
Sprocess_flow.i
Exchange_Rate.i
v_Currency.s
Street.s
Zip_Code.s
Data_Processing_Basis_Details.s
id.s
Data_Source.s
Sapproved.i
Delegate.i
Approve.i
Reject.i
Resubmit.i
Sdata_source_details.s
Created_Time.s
Seditable.i
City.s
No_of_Employees.i
State.s
Country.s
Created_ByName.s
Created_ById.s
Created_ByEmail.s
Annual_Revenue.i
Secondary_Email.s
Description.s
Rating.s
Sreview_processApprove.i
Sreview_processReject.i
Sreview_processResubmit.i
Website.s
Twitter.s
Scanvas_id.s
Salutation.s
First_Name.s
Lead_Status.s
Full_Name.s
Record_Image.s
Modified_ByName.s
Modified_ById.s
Modified_ByEmail.s
Sreview.s
Skype_ID.s
Phone.s
HIPAA.s
Email_Opt_Out.i
Designation.s
Modified_Time.s
Unsubscribed_Time.s
Mobile.s
Sorchestration.i
Sstop_processing.i
Last_Name.s
Sin_merge.i
Lead_Source.s
Fax.s
Sapproval_state.s
j.i
count_j.i
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Name = CkJsonObject::ckStringOf(jResp,"data[i].Owner.name")
Id = CkJsonObject::ckStringOf(jResp,"data[i].Owner.id")
v_Email = CkJsonObject::ckStringOf(jResp,"data[i].Owner.email")
Company = CkJsonObject::ckStringOf(jResp,"data[i].Company")
v_Email = CkJsonObject::ckStringOf(jResp,"data[i].Email")
Scurrency_symbol = CkJsonObject::ckStringOf(jResp,"data[i].$currency_symbol")
Interested_Leads = CkJsonObject::ckStringOf(jResp,"data[i].Interested_Leads")
Last_Activity_Time = CkJsonObject::ckStringOf(jResp,"data[i].Last_Activity_Time")
Industry = CkJsonObject::ckStringOf(jResp,"data[i].Industry")
Sstate = CkJsonObject::ckStringOf(jResp,"data[i].$state")
Unsubscribed_Mode = CkJsonObject::ckStringOf(jResp,"data[i].Unsubscribed_Mode")
Sconverted = CkJsonObject::ckBoolOf(jResp,"data[i].$converted")
Sprocess_flow = CkJsonObject::ckBoolOf(jResp,"data[i].$process_flow")
Exchange_Rate = CkJsonObject::ckIntOf(jResp,"data[i].Exchange_Rate")
v_Currency = CkJsonObject::ckStringOf(jResp,"data[i].Currency")
Street = CkJsonObject::ckStringOf(jResp,"data[i].Street")
Zip_Code = CkJsonObject::ckStringOf(jResp,"data[i].Zip_Code")
Data_Processing_Basis_Details = CkJsonObject::ckStringOf(jResp,"data[i].Data_Processing_Basis_Details")
id = CkJsonObject::ckStringOf(jResp,"data[i].id")
Data_Source = CkJsonObject::ckStringOf(jResp,"data[i].Data_Source")
Sapproved = CkJsonObject::ckBoolOf(jResp,"data[i].$approved")
Delegate = CkJsonObject::ckBoolOf(jResp,"data[i].$approval.delegate")
Approve = CkJsonObject::ckBoolOf(jResp,"data[i].$approval.approve")
Reject = CkJsonObject::ckBoolOf(jResp,"data[i].$approval.reject")
Resubmit = CkJsonObject::ckBoolOf(jResp,"data[i].$approval.resubmit")
Sdata_source_details = CkJsonObject::ckStringOf(jResp,"data[i].$data_source_details")
Created_Time = CkJsonObject::ckStringOf(jResp,"data[i].Created_Time")
Seditable = CkJsonObject::ckBoolOf(jResp,"data[i].$editable")
City = CkJsonObject::ckStringOf(jResp,"data[i].City")
No_of_Employees = CkJsonObject::ckIntOf(jResp,"data[i].No_of_Employees")
State = CkJsonObject::ckStringOf(jResp,"data[i].State")
Country = CkJsonObject::ckStringOf(jResp,"data[i].Country")
Created_ByName = CkJsonObject::ckStringOf(jResp,"data[i].Created_By.name")
Created_ById = CkJsonObject::ckStringOf(jResp,"data[i].Created_By.id")
Created_ByEmail = CkJsonObject::ckStringOf(jResp,"data[i].Created_By.email")
Annual_Revenue = CkJsonObject::ckIntOf(jResp,"data[i].Annual_Revenue")
Secondary_Email = CkJsonObject::ckStringOf(jResp,"data[i].Secondary_Email")
Description = CkJsonObject::ckStringOf(jResp,"data[i].Description")
Rating = CkJsonObject::ckStringOf(jResp,"data[i].Rating")
Sreview_processApprove = CkJsonObject::ckBoolOf(jResp,"data[i].$review_process.approve")
Sreview_processReject = CkJsonObject::ckBoolOf(jResp,"data[i].$review_process.reject")
Sreview_processResubmit = CkJsonObject::ckBoolOf(jResp,"data[i].$review_process.resubmit")
Website = CkJsonObject::ckStringOf(jResp,"data[i].Website")
Twitter = CkJsonObject::ckStringOf(jResp,"data[i].Twitter")
Scanvas_id = CkJsonObject::ckStringOf(jResp,"data[i].$canvas_id")
Salutation = CkJsonObject::ckStringOf(jResp,"data[i].Salutation")
First_Name = CkJsonObject::ckStringOf(jResp,"data[i].First_Name")
Lead_Status = CkJsonObject::ckStringOf(jResp,"data[i].Lead_Status")
Full_Name = CkJsonObject::ckStringOf(jResp,"data[i].Full_Name")
Record_Image = CkJsonObject::ckStringOf(jResp,"data[i].Record_Image")
Modified_ByName = CkJsonObject::ckStringOf(jResp,"data[i].Modified_By.name")
Modified_ById = CkJsonObject::ckStringOf(jResp,"data[i].Modified_By.id")
Modified_ByEmail = CkJsonObject::ckStringOf(jResp,"data[i].Modified_By.email")
Sreview = CkJsonObject::ckStringOf(jResp,"data[i].$review")
Skype_ID = CkJsonObject::ckStringOf(jResp,"data[i].Skype_ID")
Phone = CkJsonObject::ckStringOf(jResp,"data[i].Phone")
HIPAA = CkJsonObject::ckStringOf(jResp,"data[i].HIPAA")
Email_Opt_Out = CkJsonObject::ckBoolOf(jResp,"data[i].Email_Opt_Out")
Designation = CkJsonObject::ckStringOf(jResp,"data[i].Designation")
Modified_Time = CkJsonObject::ckStringOf(jResp,"data[i].Modified_Time")
Unsubscribed_Time = CkJsonObject::ckStringOf(jResp,"data[i].Unsubscribed_Time")
Mobile = CkJsonObject::ckStringOf(jResp,"data[i].Mobile")
Sorchestration = CkJsonObject::ckBoolOf(jResp,"data[i].$orchestration")
Sstop_processing = CkJsonObject::ckBoolOf(jResp,"data[i].$stop_processing")
Last_Name = CkJsonObject::ckStringOf(jResp,"data[i].Last_Name")
Sin_merge = CkJsonObject::ckBoolOf(jResp,"data[i].$in_merge")
Lead_Source = CkJsonObject::ckStringOf(jResp,"data[i].Lead_Source")
Fax = CkJsonObject::ckStringOf(jResp,"data[i].Fax")
Sapproval_state = CkJsonObject::ckStringOf(jResp,"data[i].$approval_state")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"data[i].Tag")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
