Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sCreated_time
String sModified_time
String sName
String sId
String sApi_name
String sModuleId
String sName
String sModified_byName
String sModified_byId
String sDescription
String sId
String sCreated_byName
String sCreated_byId
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.1/settings/automation/assignment_rules" 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)
// {
// "assignment_rules": [
// {
// "created_time": "2020-03-30T00:00:00+05:30",
// "modified_time": "2020-03-30T21:14:07+05:30",
// "default_assignee": {
// "name": "User 3",
// "id": "4150868000001248015"
// },
// "module": {
// "api_name": "Leads",
// "id": "4150868000000002175"
// },
// "name": "test assignment rules",
// "modified_by": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013"
// },
// "description": "Assign owner to a record",
// "id": "4150868000001730013",
// "created_by": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013"
// }
// },
// {
// "created_time": "2020-03-30T00:00:00+05:30",
// "modified_time": "2020-03-30T20:44:25+05:30",
// "default_assignee": {
// "name": "User 3",
// "id": "4150868000001248015"
// },
// "module": {
// "api_name": "Leads",
// "id": "4150868000000002175"
// },
// "name": "test assignment rules2",
// "modified_by": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013"
// },
// "description": "Assign owner to a record",
// "id": "4150868000001741002",
// "created_by": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013"
// }
// },
// {
// "created_time": "2020-03-30T00:00:00+05:30",
// "modified_time": "2020-03-30T00:00:00+05:30",
// "default_assignee": {
// "name": "User 3",
// "id": "4150868000001248015"
// },
// "module": {
// "api_name": "Leads",
// "id": "4150868000000002175"
// },
// "name": "test assignment rules3",
// "modified_by": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013"
// },
// "description": "Assign owner to a record",
// "id": "4150868000001741010",
// "created_by": {
// "name": "Patricia Boyle",
// "id": "4150868000000225013"
// }
// }
// ]
// }
// 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 "assignment_rules" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "assignment_rules[i].created_time" To sCreated_time
Get ComStringOf Of hoJResp "assignment_rules[i].modified_time" To sModified_time
Get ComStringOf Of hoJResp "assignment_rules[i].default_assignee.name" To sName
Get ComStringOf Of hoJResp "assignment_rules[i].default_assignee.id" To sId
Get ComStringOf Of hoJResp "assignment_rules[i].module.api_name" To sApi_name
Get ComStringOf Of hoJResp "assignment_rules[i].module.id" To sModuleId
Get ComStringOf Of hoJResp "assignment_rules[i].name" To sName
Get ComStringOf Of hoJResp "assignment_rules[i].modified_by.name" To sModified_byName
Get ComStringOf Of hoJResp "assignment_rules[i].modified_by.id" To sModified_byId
Get ComStringOf Of hoJResp "assignment_rules[i].description" To sDescription
Get ComStringOf Of hoJResp "assignment_rules[i].id" To sId
Get ComStringOf Of hoJResp "assignment_rules[i].created_by.name" To sCreated_byName
Get ComStringOf Of hoJResp "assignment_rules[i].created_by.id" To sCreated_byId
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2.1/settings/automation/assignment_rules
Postman Collection Item JSON
{
"name": "Assignment Rules",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/automation/assignment_rules",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"automation",
"assignment_rules"
]
}
},
"response": [
{
"name": "P1: module",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/automation/assignment_rules?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"automation",
"assignment_rules"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 10:52:53 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-10T17:05:19+05:30"
},
{
"key": "clientVersion",
"value": "4016246"
},
{
"key": "clientsubVersion",
"value": "59f8474ad0046d6a2f6204e0448818d0"
},
{
"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 \"assignment_rules\": [\n {\n \"created_time\": \"2020-03-30T00:00:00+05:30\",\n \"modified_time\": \"2020-03-30T21:14:07+05:30\",\n \"default_assignee\": {\n \"name\": \"User 3\",\n \"id\": \"4150868000001248015\"\n },\n \"module\": {\n \"api_name\": \"Leads\",\n \"id\": \"4150868000000002175\"\n },\n \"name\": \"test assignment rules\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"description\": \"Assign owner to a record\",\n \"id\": \"4150868000001730013\",\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n }\n },\n {\n \"created_time\": \"2020-03-30T00:00:00+05:30\",\n \"modified_time\": \"2020-03-30T20:44:25+05:30\",\n \"default_assignee\": {\n \"name\": \"User 3\",\n \"id\": \"4150868000001248015\"\n },\n \"module\": {\n \"api_name\": \"Leads\",\n \"id\": \"4150868000000002175\"\n },\n \"name\": \"test assignment rules2\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"description\": \"Assign owner to a record\",\n \"id\": \"4150868000001741002\",\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n }\n },\n {\n \"created_time\": \"2020-03-30T00:00:00+05:30\",\n \"modified_time\": \"2020-03-30T00:00:00+05:30\",\n \"default_assignee\": {\n \"name\": \"User 3\",\n \"id\": \"4150868000001248015\"\n },\n \"module\": {\n \"api_name\": \"Leads\",\n \"id\": \"4150868000000002175\"\n },\n \"name\": \"test assignment rules3\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"description\": \"Assign owner to a record\",\n \"id\": \"4150868000001741010\",\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n }\n }\n ]\n}"
},
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/automation/assignment_rules",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"automation",
"assignment_rules"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 10:51:06 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-10T17:05:19+05:30"
},
{
"key": "clientVersion",
"value": "4016246"
},
{
"key": "clientsubVersion",
"value": "59f8474ad0046d6a2f6204e0448818d0"
},
{
"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 \"assignment_rules\": [\n {\n \"created_time\": \"2020-03-30T00:00:00+05:30\",\n \"modified_time\": \"2020-03-30T21:14:07+05:30\",\n \"default_assignee\": {\n \"name\": \"User 3\",\n \"id\": \"4150868000001248015\"\n },\n \"module\": {\n \"api_name\": \"Leads\",\n \"id\": \"4150868000000002175\"\n },\n \"name\": \"test assignment rules\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"description\": \"Assign owner to a record\",\n \"id\": \"4150868000001730013\",\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n }\n },\n {\n \"created_time\": \"2020-03-30T00:00:00+05:30\",\n \"modified_time\": \"2020-03-30T20:44:25+05:30\",\n \"default_assignee\": {\n \"name\": \"User 3\",\n \"id\": \"4150868000001248015\"\n },\n \"module\": {\n \"api_name\": \"Leads\",\n \"id\": \"4150868000000002175\"\n },\n \"name\": \"test assignment rules2\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"description\": \"Assign owner to a record\",\n \"id\": \"4150868000001741002\",\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n }\n },\n {\n \"created_time\": \"2020-03-30T00:00:00+05:30\",\n \"modified_time\": \"2020-03-30T00:00:00+05:30\",\n \"default_assignee\": {\n \"name\": \"User 3\",\n \"id\": \"4150868000001248015\"\n },\n \"module\": {\n \"api_name\": \"Leads\",\n \"id\": \"4150868000000002175\"\n },\n \"name\": \"test assignment rules3\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"description\": \"Assign owner to a record\",\n \"id\": \"4150868000001741010\",\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n }\n }\n ]\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "COPY",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/automation/assignment_rules",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"automation",
"assignment_rules"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 10:51:35 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": "INVALID_URL_PATTERN",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/automation/assignment_rule",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"automation",
"assignment_rule"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 10:52:31 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "131"
},
{
"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-10T17:05:19+05:30"
},
{
"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_URL_PATTERN\",\n \"details\": {},\n \"message\": \"Please check if the URL trying to access is a correct one\",\n \"status\": \"error\"\n}"
},
{
"name": "OAUTH_SCOPE_MISMATCH",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/automation/assignment_rules",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"automation",
"assignment_rules"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 08:41:22 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}"
}
]
}
