Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCreated_time
LOCAL lcPermission_type
LOCAL lcModified_time
LOCAL lcName
LOCAL lcId
LOCAL lcAccount_rule_criteria
LOCAL lcName
LOCAL lcModified_byName
LOCAL lcModified_byId
LOCAL lcDescription
LOCAL lcId
LOCAL lcReporting_to
LOCAL lcDeal_rule_criteria
LOCAL lcCreated_byName
LOCAL lcCreated_byId
LOCAL lcManager
LOCAL lcReporting_toName
LOCAL lcReporting_toId
LOCAL lnPer_page
LOCAL lnCount
LOCAL lnPage
LOCAL lnMore_records
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.SetRequestHeader("Authorization","{{authorization-token}}")
loHttp.SetRequestHeader("Content-Type","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/crm/v2.1/settings/territories",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "territories": [
* {
* "created_time": "2019-08-20T14:30:27+05:30",
* "permission_type": "read_only",
* "modified_time": "2019-08-20T14:30:27+05:30",
* "manager": {
* "name": "Patricia Boyle",
* "id": "4150868000000225013"
* },
* "account_rule_criteria": null,
* "name": "Pink Global Solutions",
* "modified_by": {
* "name": "Patricia Boyle",
* "id": "4150868000000225013"
* },
* "description": "Organization Parent Territory",
* "id": "4150868000000236307",
* "reporting_to": null,
* "deal_rule_criteria": null,
* "created_by": {
* "name": "Patricia Boyle",
* "id": "4150868000000225013"
* }
* },
* {
* "created_time": "2021-04-28T18:39:24+05:30",
* "permission_type": "read_only",
* "modified_time": "2021-04-28T18:39:24+05:30",
* "manager": null,
* "account_rule_criteria": null,
* "name": "sample 6",
* "modified_by": {
* "name": "Patricia Boyle",
* "id": "4150868000000225013"
* },
* "description": null,
* "id": "4150868000005232005",
* "reporting_to": {
* "name": "Pink Global Solutions",
* "id": "4150868000000236307"
* },
* "deal_rule_criteria": null,
* "created_by": {
* "name": "Patricia Boyle",
* "id": "4150868000000225013"
* }
* },
* {
* "created_time": "2021-04-28T18:39:31+05:30",
* "permission_type": "read_only",
* "modified_time": "2021-04-28T18:39:31+05:30",
* "manager": null,
* "account_rule_criteria": null,
* "name": "sample 7",
* "modified_by": {
* "name": "Patricia Boyle",
* "id": "4150868000000225013"
* },
* "description": null,
* "id": "4150868000005232011",
* "reporting_to": {
* "name": "Pink Global Solutions",
* "id": "4150868000000236307"
* },
* "deal_rule_criteria": null,
* "created_by": {
* "name": "Patricia Boyle",
* "id": "4150868000000225013"
* }
* },
* {
* "created_time": "2021-04-28T18:39:37+05:30",
* "permission_type": "read_only",
* "modified_time": "2021-04-28T18:39:37+05:30",
* "manager": null,
* "account_rule_criteria": null,
* "name": "sample 8",
* "modified_by": {
* "name": "Patricia Boyle",
* "id": "4150868000000225013"
* },
* "description": null,
* "id": "4150868000005232017",
* "reporting_to": {
* "name": "Pink Global Solutions",
* "id": "4150868000000236307"
* },
* "deal_rule_criteria": null,
* "created_by": {
* "name": "Patricia Boyle",
* "id": "4150868000000225013"
* }
* },
* {
* "created_time": "2021-04-28T18:39:45+05:30",
* "permission_type": "read_only",
* "modified_time": "2021-04-28T18:39:45+05:30",
* "manager": null,
* "account_rule_criteria": null,
* "name": "sample 9",
* "modified_by": {
* "name": "Patricia Boyle",
* "id": "4150868000000225013"
* },
* "description": null,
* "id": "4150868000005232023",
* "reporting_to": {
* "name": "Pink Global Solutions",
* "id": "4150868000000236307"
* },
* "deal_rule_criteria": null,
* "created_by": {
* "name": "Patricia Boyle",
* "id": "4150868000000225013"
* }
* },
* {
* "created_time": "2021-04-28T18:39:54+05:30",
* "permission_type": "read_only",
* "modified_time": "2021-04-28T18:39:54+05:30",
* "manager": null,
* "account_rule_criteria": null,
* "name": "sample 10",
* "modified_by": {
* "name": "Patricia Boyle",
* "id": "4150868000000225013"
* },
* "description": null,
* "id": "4150868000005232029",
* "reporting_to": {
* "name": "Pink Global Solutions",
* "id": "4150868000000236307"
* },
* "deal_rule_criteria": null,
* "created_by": {
* "name": "Patricia Boyle",
* "id": "4150868000000225013"
* }
* }
* ],
* "info": {
* "per_page": 200,
* "count": 6,
* "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
lnPer_page = loJResp.IntOf("info.per_page")
lnCount = loJResp.IntOf("info.count")
lnPage = loJResp.IntOf("info.page")
lnMore_records = loJResp.BoolOf("info.more_records")
i = 0
lnCount_i = loJResp.SizeOfArray("territories")
DO WHILE i < lnCount_i
loJResp.I = i
lcCreated_time = loJResp.StringOf("territories[i].created_time")
lcPermission_type = loJResp.StringOf("territories[i].permission_type")
lcModified_time = loJResp.StringOf("territories[i].modified_time")
lcName = loJResp.StringOf("territories[i].manager.name")
lcId = loJResp.StringOf("territories[i].manager.id")
lcAccount_rule_criteria = loJResp.StringOf("territories[i].account_rule_criteria")
lcName = loJResp.StringOf("territories[i].name")
lcModified_byName = loJResp.StringOf("territories[i].modified_by.name")
lcModified_byId = loJResp.StringOf("territories[i].modified_by.id")
lcDescription = loJResp.StringOf("territories[i].description")
lcId = loJResp.StringOf("territories[i].id")
lcReporting_to = loJResp.StringOf("territories[i].reporting_to")
lcDeal_rule_criteria = loJResp.StringOf("territories[i].deal_rule_criteria")
lcCreated_byName = loJResp.StringOf("territories[i].created_by.name")
lcCreated_byId = loJResp.StringOf("territories[i].created_by.id")
lcManager = loJResp.StringOf("territories[i].manager")
lcReporting_toName = loJResp.StringOf("territories[i].reporting_to.name")
lcReporting_toId = loJResp.StringOf("territories[i].reporting_to.id")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Authorization: {{authorization-token}}"
-H "Content-Type: application/json"
https://domain.com/crm/v2.1/settings/territories
Postman Collection Item JSON
{
"name": "Territories",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/territories",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"territories"
]
},
"description": "To get the list of territories enabled for your organization."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/territories",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"territories"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 03 May 2021 13:20:03 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-03T19:27:14+05:30"
},
{
"key": "clientVersion",
"value": "4002155"
},
{
"key": "clientsubVersion",
"value": "bfb2326744b42e5c869a705645ac0006"
},
{
"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 \"territories\": [\n {\n \"created_time\": \"2019-08-20T14:30:27+05:30\",\n \"permission_type\": \"read_only\",\n \"modified_time\": \"2019-08-20T14:30:27+05:30\",\n \"manager\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"account_rule_criteria\": null,\n \"name\": \"Pink Global Solutions\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"description\": \"Organization Parent Territory\",\n \"id\": \"4150868000000236307\",\n \"reporting_to\": null,\n \"deal_rule_criteria\": null,\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n }\n },\n {\n \"created_time\": \"2021-04-28T18:39:24+05:30\",\n \"permission_type\": \"read_only\",\n \"modified_time\": \"2021-04-28T18:39:24+05:30\",\n \"manager\": null,\n \"account_rule_criteria\": null,\n \"name\": \"sample 6\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"description\": null,\n \"id\": \"4150868000005232005\",\n \"reporting_to\": {\n \"name\": \"Pink Global Solutions\",\n \"id\": \"4150868000000236307\"\n },\n \"deal_rule_criteria\": null,\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n }\n },\n {\n \"created_time\": \"2021-04-28T18:39:31+05:30\",\n \"permission_type\": \"read_only\",\n \"modified_time\": \"2021-04-28T18:39:31+05:30\",\n \"manager\": null,\n \"account_rule_criteria\": null,\n \"name\": \"sample 7\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"description\": null,\n \"id\": \"4150868000005232011\",\n \"reporting_to\": {\n \"name\": \"Pink Global Solutions\",\n \"id\": \"4150868000000236307\"\n },\n \"deal_rule_criteria\": null,\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n }\n },\n {\n \"created_time\": \"2021-04-28T18:39:37+05:30\",\n \"permission_type\": \"read_only\",\n \"modified_time\": \"2021-04-28T18:39:37+05:30\",\n \"manager\": null,\n \"account_rule_criteria\": null,\n \"name\": \"sample 8\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"description\": null,\n \"id\": \"4150868000005232017\",\n \"reporting_to\": {\n \"name\": \"Pink Global Solutions\",\n \"id\": \"4150868000000236307\"\n },\n \"deal_rule_criteria\": null,\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n }\n },\n {\n \"created_time\": \"2021-04-28T18:39:45+05:30\",\n \"permission_type\": \"read_only\",\n \"modified_time\": \"2021-04-28T18:39:45+05:30\",\n \"manager\": null,\n \"account_rule_criteria\": null,\n \"name\": \"sample 9\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"description\": null,\n \"id\": \"4150868000005232023\",\n \"reporting_to\": {\n \"name\": \"Pink Global Solutions\",\n \"id\": \"4150868000000236307\"\n },\n \"deal_rule_criteria\": null,\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n }\n },\n {\n \"created_time\": \"2021-04-28T18:39:54+05:30\",\n \"permission_type\": \"read_only\",\n \"modified_time\": \"2021-04-28T18:39:54+05:30\",\n \"manager\": null,\n \"account_rule_criteria\": null,\n \"name\": \"sample 10\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"description\": null,\n \"id\": \"4150868000005232029\",\n \"reporting_to\": {\n \"name\": \"Pink Global Solutions\",\n \"id\": \"4150868000000236307\"\n },\n \"deal_rule_criteria\": null,\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n }\n }\n ],\n \"info\": {\n \"per_page\": 200,\n \"count\": 6,\n \"page\": 1,\n \"more_records\": false\n }\n}"
},
{
"name": "INVALID_URL_PATTERN",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/territorie",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"territorie"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 03 May 2021 13:13:26 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-03T19:27:14+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": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/territories",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"territories"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 03 May 2021 13:13:47 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": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/territories",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"territories"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 03 May 2021 13:14:46 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": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
},
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/territories",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"territories"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 03 May 2021 13:34:14 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}"
}
]
}
