Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://domain.com/crm/v2.1/settings/wizards",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "wizards": [
; {
; "created_time": "2021-03-03T14:52:27+05:30",
; "modified_time": "2021-03-03T14:52:27+05:30",
; "module": {
; "api_name": "Leads",
; "id": "4150868000000002175"
; },
; "name": "sample",
; "modified_by": {
; "name": "Patricia Boyle",
; "id": "4150868000000225013"
; },
; "profiles": [
; {
; "name": "Administrator",
; "id": "4150868000000026011"
; }
; ],
; "active": true,
; "containers": [
; {
; "layout": {
; "name": "Standard",
; "id": "4150868000000091055"
; },
; "id": "4150868000000091055"
; }
; ],
; "id": "4150868000004805001",
; "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
created_time.s
modified_time.s
Api_name.s
Id.s
name.s
Name.s
modified_byId.s
active.i
id.s
created_byName.s
created_byId.s
j.i
count_j.i
layoutName.s
layoutId.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"wizards")
While i < count_i
CkJsonObject::setCkI(jResp, i)
created_time = CkJsonObject::ckStringOf(jResp,"wizards[i].created_time")
modified_time = CkJsonObject::ckStringOf(jResp,"wizards[i].modified_time")
Api_name = CkJsonObject::ckStringOf(jResp,"wizards[i].module.api_name")
Id = CkJsonObject::ckStringOf(jResp,"wizards[i].module.id")
name = CkJsonObject::ckStringOf(jResp,"wizards[i].name")
Name = CkJsonObject::ckStringOf(jResp,"wizards[i].modified_by.name")
modified_byId = CkJsonObject::ckStringOf(jResp,"wizards[i].modified_by.id")
active = CkJsonObject::ckBoolOf(jResp,"wizards[i].active")
id = CkJsonObject::ckStringOf(jResp,"wizards[i].id")
created_byName = CkJsonObject::ckStringOf(jResp,"wizards[i].created_by.name")
created_byId = CkJsonObject::ckStringOf(jResp,"wizards[i].created_by.id")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"wizards[i].profiles")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
name = CkJsonObject::ckStringOf(jResp,"wizards[i].profiles[j].name")
id = CkJsonObject::ckStringOf(jResp,"wizards[i].profiles[j].id")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"wizards[i].containers")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
layoutName = CkJsonObject::ckStringOf(jResp,"wizards[i].containers[j].layout.name")
layoutId = CkJsonObject::ckStringOf(jResp,"wizards[i].containers[j].layout.id")
id = CkJsonObject::ckStringOf(jResp,"wizards[i].containers[j].id")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2.1/settings/wizards
Postman Collection Item JSON
{
"name": "Wizards",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/wizards",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"wizards"
]
}
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/wizards",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"wizards"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 12:12:29 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "514"
},
{
"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-10T18:42:26+05:30"
},
{
"key": "clientVersion",
"value": "4016246"
},
{
"key": "clientsubVersion",
"value": "59f8474ad0046d6a2f6204e0448818d0"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000"
}
],
"cookie": [
],
"body": "{\n \"wizards\": [\n {\n \"created_time\": \"2021-03-03T14:52:27+05:30\",\n \"modified_time\": \"2021-03-03T14:52:27+05:30\",\n \"module\": {\n \"api_name\": \"Leads\",\n \"id\": \"4150868000000002175\"\n },\n \"name\": \"sample\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"profiles\": [\n {\n \"name\": \"Administrator\",\n \"id\": \"4150868000000026011\"\n }\n ],\n \"active\": true,\n \"containers\": [\n {\n \"layout\": {\n \"name\": \"Standard\",\n \"id\": \"4150868000000091055\"\n },\n \"id\": \"4150868000000091055\"\n }\n ],\n \"id\": \"4150868000004805001\",\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n }\n }\n ]\n}"
},
{
"name": "INVALID_URL_PATTERN",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/wizard",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"wizard"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 12:13:58 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "131"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Set-Cookie",
"value": "1a99390653=3de72b35e5bc2072b2ed1e7217ad253a; Path=/"
},
{
"key": "Set-Cookie",
"value": "JSESSIONID=E6705C98CFC8EDFCC1C0927A28B1D15A; Path=/; Secure"
},
{
"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-10T18:42:26+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": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/wizards",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"wizards"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 12:19:01 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.1/settings/wizards",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"wizards"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 08:43:34 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}"
}
]
}
