Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/crm/v2.1/Leads/{{record_id}}",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print http.lastHeader() + "\n";
print "Failed." + "\n";
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"
# },
# "Company": null,
# "Email": null,
# "$currency_symbol": "Af",
# "Interested_Leads": [
# ],
# "Image123": null,
# "$sharing_permission": "full_access",
# "Image": null,
# "Last_Activity_Time": null,
# "Industry": null,
# "$state": "save",
# "Unsubscribed_Mode": null,
# "$converted": false,
# "$process_flow": false,
# "Exchange_Rate": 1,
# "Currency": "AFN",
# "Street": null,
# "Zip_Code": null,
# "multiuser": [
# ],
# "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": null,
# "State": null,
# "Country": null,
# "Created_By": {
# "name": "patricia patricia",
# "id": "738964000000291009",
# "email": "patricia.ss@zylker.com"
# },
# "Annual_Revenue": null,
# "Secondary_Email": null,
# "Description": null,
# "Rating": null,
# "$review_process": {
# "approve": false,
# "reject": false,
# "resubmit": false
# },
# "Website": null,
# "Twitter": null,
# "$canvas_id": null,
# "Salutation": null,
# "First_Name": null,
# "Lead_Status": null,
# "Full_Name": "sample",
# "Record_Image": null,
# "Modified_By": {
# "name": "patricia patricia",
# "id": "738964000000291009",
# "email": "patricia.ss@zylker.com"
# },
# "$review": null,
# "Lead_Conversion_Time": null,
# "Skype_ID": null,
# "Phone": null,
# "HIPAA": null,
# "Email_Opt_Out": false,
# "Designation": null,
# "Modified_Time": "2021-05-07T06:23:10+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",
# "$has_more": {
# "Interested_Leads": false,
# "multiuser": false
# }
# }
# ]
# }
# 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 = jResp.SizeOfArray("data")
while i < count_i
jResp.put_I(i)
Name = jResp.stringOf("data[i].Owner.name")
Id = jResp.stringOf("data[i].Owner.id")
v_Email = jResp.stringOf("data[i].Owner.email")
Company = jResp.stringOf("data[i].Company")
v_Email = jResp.stringOf("data[i].Email")
Scurrency_symbol = jResp.stringOf("data[i].$currency_symbol")
Image123 = jResp.stringOf("data[i].Image123")
Ssharing_permission = jResp.stringOf("data[i].$sharing_permission")
Image = jResp.stringOf("data[i].Image")
Last_Activity_Time = jResp.stringOf("data[i].Last_Activity_Time")
Industry = jResp.stringOf("data[i].Industry")
Sstate = jResp.stringOf("data[i].$state")
Unsubscribed_Mode = jResp.stringOf("data[i].Unsubscribed_Mode")
Sconverted = jResp.BoolOf("data[i].$converted")
Sprocess_flow = jResp.BoolOf("data[i].$process_flow")
Exchange_Rate = jResp.IntOf("data[i].Exchange_Rate")
v_Currency = jResp.stringOf("data[i].Currency")
Street = jResp.stringOf("data[i].Street")
Zip_Code = jResp.stringOf("data[i].Zip_Code")
Data_Processing_Basis_Details = jResp.stringOf("data[i].Data_Processing_Basis_Details")
id = jResp.stringOf("data[i].id")
Data_Source = jResp.stringOf("data[i].Data_Source")
Sapproved = jResp.BoolOf("data[i].$approved")
Delegate = jResp.BoolOf("data[i].$approval.delegate")
Approve = jResp.BoolOf("data[i].$approval.approve")
Reject = jResp.BoolOf("data[i].$approval.reject")
Resubmit = jResp.BoolOf("data[i].$approval.resubmit")
Sdata_source_details = jResp.stringOf("data[i].$data_source_details")
Created_Time = jResp.stringOf("data[i].Created_Time")
Seditable = jResp.BoolOf("data[i].$editable")
City = jResp.stringOf("data[i].City")
No_of_Employees = jResp.stringOf("data[i].No_of_Employees")
State = jResp.stringOf("data[i].State")
Country = jResp.stringOf("data[i].Country")
Created_ByName = jResp.stringOf("data[i].Created_By.name")
Created_ById = jResp.stringOf("data[i].Created_By.id")
Created_ByEmail = jResp.stringOf("data[i].Created_By.email")
Annual_Revenue = jResp.stringOf("data[i].Annual_Revenue")
Secondary_Email = jResp.stringOf("data[i].Secondary_Email")
Description = jResp.stringOf("data[i].Description")
Rating = jResp.stringOf("data[i].Rating")
Sreview_processApprove = jResp.BoolOf("data[i].$review_process.approve")
Sreview_processReject = jResp.BoolOf("data[i].$review_process.reject")
Sreview_processResubmit = jResp.BoolOf("data[i].$review_process.resubmit")
Website = jResp.stringOf("data[i].Website")
Twitter = jResp.stringOf("data[i].Twitter")
Scanvas_id = jResp.stringOf("data[i].$canvas_id")
Salutation = jResp.stringOf("data[i].Salutation")
First_Name = jResp.stringOf("data[i].First_Name")
Lead_Status = jResp.stringOf("data[i].Lead_Status")
Full_Name = jResp.stringOf("data[i].Full_Name")
Record_Image = jResp.stringOf("data[i].Record_Image")
Modified_ByName = jResp.stringOf("data[i].Modified_By.name")
Modified_ById = jResp.stringOf("data[i].Modified_By.id")
Modified_ByEmail = jResp.stringOf("data[i].Modified_By.email")
Sreview = jResp.stringOf("data[i].$review")
Lead_Conversion_Time = jResp.stringOf("data[i].Lead_Conversion_Time")
Skype_ID = jResp.stringOf("data[i].Skype_ID")
Phone = jResp.stringOf("data[i].Phone")
HIPAA = jResp.stringOf("data[i].HIPAA")
Email_Opt_Out = jResp.BoolOf("data[i].Email_Opt_Out")
Designation = jResp.stringOf("data[i].Designation")
Modified_Time = jResp.stringOf("data[i].Modified_Time")
Unsubscribed_Time = jResp.stringOf("data[i].Unsubscribed_Time")
Mobile = jResp.stringOf("data[i].Mobile")
Sorchestration = jResp.BoolOf("data[i].$orchestration")
Sstop_processing = jResp.BoolOf("data[i].$stop_processing")
Last_Name = jResp.stringOf("data[i].Last_Name")
Sin_merge = jResp.BoolOf("data[i].$in_merge")
Lead_Source = jResp.stringOf("data[i].Lead_Source")
Fax = jResp.stringOf("data[i].Fax")
Sapproval_state = jResp.stringOf("data[i].$approval_state")
Interested_Leads = jResp.BoolOf("data[i].$has_more.Interested_Leads")
Multiuser = jResp.BoolOf("data[i].$has_more.multiuser")
j = 0
count_j = jResp.SizeOfArray("data[i].Interested_Leads")
while j < count_j
jResp.put_J(j)
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("data[i].multiuser")
while j < count_j
jResp.put_J(j)
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("data[i].Tag")
while j < count_j
jResp.put_J(j)
j = j + 1
end
i = i + 1
end
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2.1/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.1/Leads/{{record_id}}",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"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.1/Leads/738964000002131001",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads",
"738964000002131001"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 06:32:59 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-07T06:44:53+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"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 \"Company\": null,\n \"Email\": null,\n \"$currency_symbol\": \"Af\",\n \"Interested_Leads\": [],\n \"Image123\": null,\n \"$sharing_permission\": \"full_access\",\n \"Image\": null,\n \"Last_Activity_Time\": null,\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\": null,\n \"multiuser\": [],\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\": null,\n \"State\": null,\n \"Country\": null,\n \"Created_By\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"Annual_Revenue\": null,\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\": null,\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 patricia\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$review\": null,\n \"Lead_Conversion_Time\": null,\n \"Skype_ID\": null,\n \"Phone\": null,\n \"HIPAA\": null,\n \"Email_Opt_Out\": false,\n \"Designation\": null,\n \"Modified_Time\": \"2021-05-07T06:23:10+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 \"$has_more\": {\n \"Interested_Leads\": false,\n \"multiuser\": false\n }\n }\n ]\n}"
},
{
"name": "INVALID_MODULE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Lead/738964000002131001",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Lead",
"738964000002131001"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 06:33:30 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "133"
},
{
"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-07T06:44:53+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"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 \"resource_path_index\": 0\n },\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.1/Leads/738964000002131001",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads",
"738964000002131001"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 06:34:10 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.1/Leads/738964000002131001",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads",
"738964000002131001"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 06:34:28 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": "INVALID_REQUEST",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Leads/{{record_id}}",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads",
"{{record_id}}"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 06:51:53 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "192"
},
{
"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\": \"INVALID_REQUEST\",\n \"details\": {},\n \"message\": \"unable to process your request. please verify whether you have entered proper method name, parameter and parameter values.\",\n \"status\": \"error\"\n}"
}
]
}
