Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Handle hoJson
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sCode
String sModified_Time
String sName
String sId
String sCreated_Time
String sDetailsId
String sCreated_ByName
String sCreated_ById
String sMessage
String sStatus
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// 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
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "data": [
// {
// "id": "{{record_id}}",
// "Languages": [
// {
// "id": "{{id of the subform record that does not need any update}}"
// },
// {
// "id": "{{id of the subform record}}",
// "Proficiency": "{{data to be updated}}",
// "Languages_Known": "{{data to be updated}}"
// }
// ],
// "Availability": [
// {
// "id": "{{id of the subform record that does not need any update}}"
// },
// {
// "id": "{{id of the subform record }}",
// "Weekdays": "{{Weekdays}}"
// }
// ]
// }
// ]
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "data[0].id" "{{record_id}}" To iSuccess
Get ComUpdateString Of hoJson "data[0].Languages[0].id" "{{id of the subform record that does not need any update}}" To iSuccess
Get ComUpdateString Of hoJson "data[0].Languages[1].id" "{{id of the subform record}}" To iSuccess
Get ComUpdateString Of hoJson "data[0].Languages[1].Proficiency" "{{data to be updated}}" To iSuccess
Get ComUpdateString Of hoJson "data[0].Languages[1].Languages_Known" "{{data to be updated}}" To iSuccess
Get ComUpdateString Of hoJson "data[0].Availability[0].id" "{{id of the subform record that does not need any update}}" To iSuccess
Get ComUpdateString Of hoJson "data[0].Availability[1].id" "{{id of the subform record }}" To iSuccess
Get ComUpdateString Of hoJson "data[0].Availability[1].Weekdays" "{{Weekdays}}" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComPTextSb Of hoHttp "PUT" "https://domain.com/crm/v2/Leads" vSbRequestBody "utf-8" "application/json" False False To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
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 ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "code": "SUCCESS",
// "details": {
// "Modified_Time": "2021-05-11T13:20:33+00:00",
// "Modified_By": {
// "name": "Patricia Boyle",
// "id": "738964000000291009"
// },
// "Created_Time": "2021-05-07T06:38:15+00:00",
// "id": "738964000002130131",
// "Created_By": {
// "name": "Patricia Boyle",
// "id": "738964000000291009"
// }
// },
// "message": "record updated",
// "status": "success"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
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].code" To sCode
Get ComStringOf Of hoJResp "data[i].details.Modified_Time" To sModified_Time
Get ComStringOf Of hoJResp "data[i].details.Modified_By.name" To sName
Get ComStringOf Of hoJResp "data[i].details.Modified_By.id" To sId
Get ComStringOf Of hoJResp "data[i].details.Created_Time" To sCreated_Time
Get ComStringOf Of hoJResp "data[i].details.id" To sDetailsId
Get ComStringOf Of hoJResp "data[i].details.Created_By.name" To sCreated_ByName
Get ComStringOf Of hoJResp "data[i].details.Created_By.id" To sCreated_ById
Get ComStringOf Of hoJResp "data[i].message" To sMessage
Get ComStringOf Of hoJResp "data[i].status" To sStatus
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -X PUT
-H "Authorization: Bearer <access_token>"
-d '{
"data": [
{
"id": "{{record_id}}",
"Languages": [
{
"id": "{{id of the subform record that does not need any update}}"
},
{
"id": "{{id of the subform record}}",
"Proficiency": "{{data to be updated}}",
"Languages_Known": "{{data to be updated}}"
}
],
"Availability": [
{
"id": "{{id of the subform record that does not need any update}}"
},
{
"id": "{{id of the subform record }}",
"Weekdays": {{data to be updated}}
}
]
}
]
}'
https://domain.com/crm/v2/Leads
Postman Collection Item JSON
{
"name": "Update Subforms",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"{{record_id}}\",\n \"Languages\": [\n {\n \"id\": \"{{id of the subform record that does not need any update}}\"\n },\n {\n \"id\": \"{{id of the subform record}}\",\n \"Proficiency\": \"{{data to be updated}}\",\n \"Languages_Known\": \"{{data to be updated}}\"\n }\n ],\n \"Availability\": [\n {\n \"id\": \"{{id of the subform record that does not need any update}}\"\n },\n {\n \"id\": \"{{id of the subform record }}\",\n \"Weekdays\": {{data to be updated}}\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads"
]
},
"description": "To update a record with subforms in a module."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"738964000002130131\",\n \"Languages\": [\n {\n \"Proficiency\": \"Native\",\n \"Languages_Known\": \"English\"\n },\n {\n \"Proficiency\": \"Professional\",\n \"Languages_Known\": \"French\"\n }\n ],\n \"Availability\": [\n {\n \"Weekends\": false,\n \"Weekdays\": true\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 13:20:33 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "331"
},
{
"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": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"code\": \"SUCCESS\",\n \"details\": {\n \"Modified_Time\": \"2021-05-11T13:20:33+00:00\",\n \"Modified_By\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"738964000000291009\"\n },\n \"Created_Time\": \"2021-05-07T06:38:15+00:00\",\n \"id\": \"738964000002130131\",\n \"Created_By\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"738964000000291009\"\n }\n },\n \"message\": \"record updated\",\n \"status\": \"success\"\n }\n ]\n}"
},
{
"name": "INVALID_MODULE",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"738964000002130131\",\n \"Languages\": [\n {\n \"Proficiency\": \"Native\",\n \"Languages_Known\": \"English\"\n },\n {\n \"Proficiency\": \"Professional\",\n \"Languages_Known\": \"French\"\n }\n ],\n \"Availability\": [\n {\n \"Weekends\": false,\n \"Weekdays\": true\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Lead",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Lead"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 13:20:51 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": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"738964000002130131\",\n \"Languages\": [\n {\n \"Proficiency\": \"Native\",\n \"Languages_Known\": \"English\"\n },\n {\n \"Proficiency\": \"Professional\",\n \"Languages_Known\": \"French\"\n }\n ],\n \"Availability\": [\n {\n \"Weekends\": false,\n \"Weekdays\": true\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 13:21:02 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": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"738964000002130131\",\n \"Languages\": [\n {\n \"Proficiency\": \"Native\",\n \"Languages_Known\": \"English\"\n },\n {\n \"Proficiency\": \"Professional\",\n \"Languages_Known\": \"French\"\n }\n ],\n \"Availability\": [\n {\n \"Weekends\": false,\n \"Weekdays\": true\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 13:21: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": "MANDATORY_NOT_FOUND",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"Languages\": [\n {\n \"Proficiency\": \"Native\",\n \"Languages_Known\": \"English\"\n },\n {\n \"Proficiency\": \"Professional\",\n \"Languages_Known\": \"French\"\n }\n ],\n \"Availability\": [\n {\n \"Weekends\": false,\n \"Weekdays\": true\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 13:21:50 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "123"
},
{
"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": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"code\": \"MANDATORY_NOT_FOUND\",\n \"details\": {\n \"api_name\": \"id\"\n },\n \"message\": \"required field not found\",\n \"status\": \"error\"\n }\n ]\n}"
},
{
"name": "INVALID_DATA",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": 123\n \"Languages\": [\n {\n \"Proficiency\": \"Native\",\n \"Languages_Known\": \"English\"\n },\n {\n \"Proficiency\": \"Professional\",\n \"Languages_Known\": \"French\"\n }\n ],\n \"Availability\": [\n {\n \"Weekends\": false,\n \"Weekdays\": true\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 13:22:10 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "104"
},
{
"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": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_DATA\",\n \"details\": {\n \"expected_data_type\": \"jsonobject\"\n },\n \"message\": \"body\",\n \"status\": \"error\"\n}"
},
{
"name": "OAUTH_SCOPE_MISMATCH",
"originalRequest": {
"method": "PUT",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"{{record_id}}\",\n \"Languages\": [\n {\n \"id\": \"{{id of the subform record that does not need any update}}\"\n },\n {\n \"id\": \"{{id of the subform record}}\",\n \"Proficiency\": \"{{data to be updated}}\",\n \"Languages_Known\": \"{{data to be updated}}\"\n }\n ],\n \"Availability\": [\n {\n \"id\": \"{{id of the subform record that does not need any update}}\"\n },\n {\n \"id\": \"{{id of the subform record }}\",\n \"Weekdays\": {{data to be updated}}\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Leads"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 06:36:03 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}"
}
]
}
