Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sName
String sId
String sV_Email
String sModified_Time
String sFile_Name
String sCreated_Time
String sSize
String sParent_IdName
String sParent_IdId
Boolean iSeditable
String sSfile_id
String sStype
String sSse_module
String sModified_ByName
String sModified_ById
String sModified_ByEmail
String sSstate
String sId
String sCreated_ByName
String sCreated_ById
String sCreated_ByEmail
String sSlink_url
Integer iPer_page
Integer iCount
Integer iPage
Boolean iMore_records
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://domain.com/crm/v2/Leads/{{record_id}}/Attachments" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "Owner": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013",
// "email": "patricia.ss@zylker.com"
// },
// "Modified_Time": "2021-05-03T17:59:02+05:30",
// "File_Name": "0f2b4454e6fea3b4c8fcc82e7d2601b0.jpg",
// "Created_Time": "2021-05-03T17:59:02+05:30",
// "Size": "563181",
// "Parent_Id": {
// "name": "Brian Dolan",
// "id": "4150868000004943003"
// },
// "$editable": true,
// "$file_id": "1nvs60c82c750d8564edeaf5093ecadff1c9a",
// "$type": "Attachment",
// "$se_module": "Leads",
// "Modified_By": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013",
// "email": "patricia.ss@zylker.com"
// },
// "$state": "save",
// "id": "4150868000005282007",
// "Created_By": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013",
// "email": "patricia.ss@zylker.com"
// },
// "$link_url": null
// },
// {
// "Owner": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013",
// "email": "patricia.ss@zylker.com"
// },
// "Modified_Time": "2021-05-03T18:05:58+05:30",
// "File_Name": "4150868000001144115.zip",
// "Created_Time": "2021-05-03T18:05:58+05:30",
// "Size": "335",
// "Parent_Id": {
// "name": "Brian Dolan",
// "id": "4150868000004943003"
// },
// "$editable": true,
// "$file_id": "1nvs652667149a3684a938b5e751e55a280f5",
// "$type": "Attachment",
// "$se_module": "Leads",
// "Modified_By": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013",
// "email": "patricia.ss@zylker.com"
// },
// "$state": "save",
// "id": "4150868000005277042",
// "Created_By": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013",
// "email": "patricia.ss@zylker.com"
// },
// "$link_url": null
// },
// {
// "Owner": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013",
// "email": "patricia.ss@zylker.com"
// },
// "Modified_Time": "2021-05-03T18:03:00+05:30",
// "File_Name": "0f2b4454e6fea3b4c8fcc82e7d2601b0.jpg",
// "Created_Time": "2021-05-03T18:03:00+05:30",
// "Size": "563181",
// "Parent_Id": {
// "name": "Brian Dolan",
// "id": "4150868000004943003"
// },
// "$editable": true,
// "$file_id": "1nvs632039a760ec04736b291c070a4a60b11",
// "$type": "Attachment",
// "$se_module": "Leads",
// "Modified_By": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013",
// "email": "patricia.ss@zylker.com"
// },
// "$state": "save",
// "id": "4150868000005277036",
// "Created_By": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013",
// "email": "patricia.ss@zylker.com"
// },
// "$link_url": null
// }
// ],
// "info": {
// "per_page": 200,
// "count": 3,
// "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
Get ComIntOf Of hoJResp "info.per_page" To iPer_page
Get ComIntOf Of hoJResp "info.count" To iCount
Get ComIntOf Of hoJResp "info.page" To iPage
Get ComBoolOf Of hoJResp "info.more_records" To iMore_records
Move 0 To i
Get ComSizeOfArray Of hoJResp "data" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "data[i].Owner.name" To sName
Get ComStringOf Of hoJResp "data[i].Owner.id" To sId
Get ComStringOf Of hoJResp "data[i].Owner.email" To sV_Email
Get ComStringOf Of hoJResp "data[i].Modified_Time" To sModified_Time
Get ComStringOf Of hoJResp "data[i].File_Name" To sFile_Name
Get ComStringOf Of hoJResp "data[i].Created_Time" To sCreated_Time
Get ComStringOf Of hoJResp "data[i].Size" To sSize
Get ComStringOf Of hoJResp "data[i].Parent_Id.name" To sParent_IdName
Get ComStringOf Of hoJResp "data[i].Parent_Id.id" To sParent_IdId
Get ComBoolOf Of hoJResp "data[i].$editable" To iSeditable
Get ComStringOf Of hoJResp "data[i].$file_id" To sSfile_id
Get ComStringOf Of hoJResp "data[i].$type" To sStype
Get ComStringOf Of hoJResp "data[i].$se_module" To sSse_module
Get ComStringOf Of hoJResp "data[i].Modified_By.name" To sModified_ByName
Get ComStringOf Of hoJResp "data[i].Modified_By.id" To sModified_ById
Get ComStringOf Of hoJResp "data[i].Modified_By.email" To sModified_ByEmail
Get ComStringOf Of hoJResp "data[i].$state" To sSstate
Get ComStringOf Of hoJResp "data[i].id" To sId
Get ComStringOf Of hoJResp "data[i].Created_By.name" To sCreated_ByName
Get ComStringOf Of hoJResp "data[i].Created_By.id" To sCreated_ById
Get ComStringOf Of hoJResp "data[i].Created_By.email" To sCreated_ByEmail
Get ComStringOf Of hoJResp "data[i].$link_url" To sSlink_url
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2/Leads/{{record_id}}/Attachments
Postman Collection Item JSON
{
"name": "Leads",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/Leads/{{record_id}}/Attachments",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads",
"{{record_id}}",
"Attachments"
]
},
"description": "To get the list of attachments."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/Leads/4150868000004943003/Attachments",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads",
"4150868000004943003",
"Attachments"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 11:16:13 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-12T17:36:34+05:30"
},
{
"key": "clientVersion",
"value": "4026785"
},
{
"key": "clientsubVersion",
"value": "0881d46feece8d60fdd69acfa4e7918b"
},
{
"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=63072000"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"Owner\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"Modified_Time\": \"2021-05-03T17:59:02+05:30\",\n \"File_Name\": \"0f2b4454e6fea3b4c8fcc82e7d2601b0.jpg\",\n \"Created_Time\": \"2021-05-03T17:59:02+05:30\",\n \"Size\": \"563181\",\n \"Parent_Id\": {\n \"name\": \"Brian Dolan\",\n \"id\": \"4150868000004943003\"\n },\n \"$editable\": true,\n \"$file_id\": \"1nvs60c82c750d8564edeaf5093ecadff1c9a\",\n \"$type\": \"Attachment\",\n \"$se_module\": \"Leads\",\n \"Modified_By\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$state\": \"save\",\n \"id\": \"4150868000005282007\",\n \"Created_By\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$link_url\": null\n },\n {\n \"Owner\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"Modified_Time\": \"2021-05-03T18:05:58+05:30\",\n \"File_Name\": \"4150868000001144115.zip\",\n \"Created_Time\": \"2021-05-03T18:05:58+05:30\",\n \"Size\": \"335\",\n \"Parent_Id\": {\n \"name\": \"Brian Dolan\",\n \"id\": \"4150868000004943003\"\n },\n \"$editable\": true,\n \"$file_id\": \"1nvs652667149a3684a938b5e751e55a280f5\",\n \"$type\": \"Attachment\",\n \"$se_module\": \"Leads\",\n \"Modified_By\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$state\": \"save\",\n \"id\": \"4150868000005277042\",\n \"Created_By\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$link_url\": null\n },\n {\n \"Owner\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"Modified_Time\": \"2021-05-03T18:03:00+05:30\",\n \"File_Name\": \"0f2b4454e6fea3b4c8fcc82e7d2601b0.jpg\",\n \"Created_Time\": \"2021-05-03T18:03:00+05:30\",\n \"Size\": \"563181\",\n \"Parent_Id\": {\n \"name\": \"Brian Dolan\",\n \"id\": \"4150868000004943003\"\n },\n \"$editable\": true,\n \"$file_id\": \"1nvs632039a760ec04736b291c070a4a60b11\",\n \"$type\": \"Attachment\",\n \"$se_module\": \"Leads\",\n \"Modified_By\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$state\": \"save\",\n \"id\": \"4150868000005277036\",\n \"Created_By\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$link_url\": null\n }\n ],\n \"info\": {\n \"per_page\": 200,\n \"count\": 3,\n \"page\": 1,\n \"more_records\": false\n }\n}"
},
{
"name": "INVALID_MODULE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/Lead/4150868000004943003/Attachments",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Lead",
"4150868000004943003",
"Attachments"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 11:16:48 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-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-12T17:36:34+05:30"
},
{
"key": "clientVersion",
"value": "4026785"
},
{
"key": "clientsubVersion",
"value": "0881d46feece8d60fdd69acfa4e7918b"
},
{
"key": "Set-Cookie",
"value": "JSESSIONID=0F072164DEAA5A20B96AF5BA88F3561E; Path=/; Secure"
},
{
"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/4150868000005335091/Attachments",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads",
"4150868000005335091",
"Attachments"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 11:18:40 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/4150868000005335091/Attachments",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads",
"4150868000005335091",
"Attachments"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 11:19:14 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}}/Attachments",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads",
"{{record_id}}",
"Attachments"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 06:40:23 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}"
}
]
}
