Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"module","Leads")
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/crm/v2/settings/custom_views",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "custom_views": [
; {
; "display_value": "All Leads",
; "offline": true,
; "default": false,
; "system_name": "ALLVIEWS",
; "system_defined": true,
; "name": "All Open Leads",
; "id": "738964000000091501",
; "category": "shared_with_me",
; "favorite": null
; },
; {
; "display_value": "Co-Owner Leads",
; "offline": false,
; "default": false,
; "system_name": "COOWNERVIEW",
; "system_defined": true,
; "name": "Co-Owner Leads",
; "id": "738964000001918218",
; "category": "shared_with_me",
; "favorite": null
; },
; {
; "display_value": "Converted Leads",
; "offline": true,
; "default": false,
; "system_name": "CONVERTEDVIEWS",
; "system_defined": true,
; "name": "Converted Leads",
; "id": "738964000000093005",
; "category": "shared_with_me",
; "favorite": null
; },
; {
; "display_value": "Junk Leads",
; "offline": true,
; "default": false,
; "system_name": "JUNKLEADVIEWS",
; "system_defined": true,
; "name": "Junk Leads",
; "id": "738964000000167014",
; "category": "shared_with_me",
; "favorite": null
; },
; {
; "display_value": "Leads in Review",
; "offline": true,
; "default": false,
; "system_name": "REVIEWPROCESS LEADS",
; "system_defined": true,
; "name": "Leads in Review",
; "id": "738964000001661014",
; "category": "shared_with_me",
; "favorite": null
; },
; {
; "display_value": "Mailing Labels",
; "offline": true,
; "default": false,
; "system_name": "ALLVIEWS",
; "system_defined": true,
; "name": "Mailing Labels",
; "id": "738964000000091503",
; "category": "shared_with_me",
; "favorite": null
; },
; {
; "display_value": "My Converted Leads",
; "offline": true,
; "default": false,
; "system_name": "MYCONVERTEDVIEWS",
; "system_defined": true,
; "name": "My Converted Leads",
; "id": "738964000000093007",
; "category": "shared_with_me",
; "favorite": null
; },
; {
; "display_value": "My Leads",
; "offline": true,
; "default": true,
; "system_name": "MYVIEWS",
; "system_defined": true,
; "name": "My Leads",
; "id": "738964000000091563",
; "category": "shared_with_me",
; "favorite": null
; },
; {
; "display_value": "Not Qualified Leads",
; "offline": true,
; "default": false,
; "system_name": "NOTQUALIFIEDLEADVIEWS",
; "system_defined": true,
; "name": "Not Qualified Leads",
; "id": "738964000000167025",
; "category": "shared_with_me",
; "favorite": null
; },
; {
; "display_value": "Open Leads",
; "offline": true,
; "default": false,
; "system_name": "OPENLEADVIEWS",
; "system_defined": true,
; "name": "Open Leads",
; "id": "738964000000167036",
; "category": "shared_with_me",
; "favorite": null
; },
; {
; "display_value": "Recently Created Leads",
; "offline": false,
; "default": false,
; "system_name": "RECENTLYCREATED",
; "system_defined": true,
; "name": "Recently Created Leads",
; "id": "738964000000091509",
; "category": "shared_with_me",
; "favorite": null
; },
; {
; "display_value": "Recently Modified Leads",
; "offline": false,
; "default": false,
; "system_name": "RECENTLYMODIFIED",
; "system_defined": true,
; "name": "Recently Modified Leads",
; "id": "738964000000091511",
; "category": "shared_with_me",
; "favorite": null
; },
; {
; "display_value": "Today's Leads",
; "offline": true,
; "default": false,
; "system_name": "today",
; "system_defined": true,
; "name": "Todays Leads",
; "id": "738964000000091507",
; "category": "shared_with_me",
; "favorite": null
; },
; {
; "display_value": "Unread Leads",
; "offline": false,
; "default": false,
; "system_name": "UNREADVIEWS",
; "system_defined": true,
; "name": "Unread Leads",
; "id": "738964000000091505",
; "category": "shared_with_me",
; "favorite": null
; },
; {
; "display_value": "Unsubscribed Leads",
; "offline": true,
; "default": false,
; "system_name": "UNSUBSCRIBED",
; "system_defined": true,
; "name": "Unsubscribed Leads",
; "id": "738964000001168011",
; "category": "shared_with_me",
; "favorite": null
; }
; ],
; "info": {
; "per_page": 200,
; "default": "738964000000091563",
; "count": 15,
; "translation": {
; "public_views": "Public Views",
; "other_users_views": "Other Users' Views",
; "shared_with_me": "Shared With Me",
; "created_by_me": "Created By Me"
; },
; "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
display_value.s
offline.i
default.i
system_name.s
system_defined.i
name.s
id.s
category.s
favorite.s
Per_page.i = CkJsonObject::ckIntOf(jResp,"info.per_page")
Default.s = CkJsonObject::ckStringOf(jResp,"info.default")
Count.i = CkJsonObject::ckIntOf(jResp,"info.count")
Public_views.s = CkJsonObject::ckStringOf(jResp,"info.translation.public_views")
Other_users_views.s = CkJsonObject::ckStringOf(jResp,"info.translation.other_users_views")
Shared_with_me.s = CkJsonObject::ckStringOf(jResp,"info.translation.shared_with_me")
Created_by_me.s = CkJsonObject::ckStringOf(jResp,"info.translation.created_by_me")
Page.i = CkJsonObject::ckIntOf(jResp,"info.page")
More_records.i = CkJsonObject::ckBoolOf(jResp,"info.more_records")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"custom_views")
While i < count_i
CkJsonObject::setCkI(jResp, i)
display_value = CkJsonObject::ckStringOf(jResp,"custom_views[i].display_value")
offline = CkJsonObject::ckBoolOf(jResp,"custom_views[i].offline")
default = CkJsonObject::ckBoolOf(jResp,"custom_views[i].default")
system_name = CkJsonObject::ckStringOf(jResp,"custom_views[i].system_name")
system_defined = CkJsonObject::ckBoolOf(jResp,"custom_views[i].system_defined")
name = CkJsonObject::ckStringOf(jResp,"custom_views[i].name")
id = CkJsonObject::ckStringOf(jResp,"custom_views[i].id")
category = CkJsonObject::ckStringOf(jResp,"custom_views[i].category")
favorite = CkJsonObject::ckStringOf(jResp,"custom_views[i].favorite")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "module=Leads"
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2/settings/custom_views
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/settings/custom_views?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"custom_views"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
},
"description": "To get the metadata of the Leads Module."
},
"response": [
{
"name": "P1: module",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/custom_views?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"custom_views"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 09:00:51 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-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-13T09:52:40+00:00"
},
{
"key": "clientVersion",
"value": "4031107"
},
{
"key": "clientsubVersion",
"value": "113b962796fc62946d9303284a64efab"
},
{
"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=15768000"
}
],
"cookie": [
],
"body": "{\n \"custom_views\": [\n {\n \"display_value\": \"All Leads\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"ALLVIEWS\",\n \"system_defined\": true,\n \"name\": \"All Open Leads\",\n \"id\": \"738964000000091501\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Co-Owner Leads\",\n \"offline\": false,\n \"default\": false,\n \"system_name\": \"COOWNERVIEW\",\n \"system_defined\": true,\n \"name\": \"Co-Owner Leads\",\n \"id\": \"738964000001918218\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Converted Leads\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"CONVERTEDVIEWS\",\n \"system_defined\": true,\n \"name\": \"Converted Leads\",\n \"id\": \"738964000000093005\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Junk Leads\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"JUNKLEADVIEWS\",\n \"system_defined\": true,\n \"name\": \"Junk Leads\",\n \"id\": \"738964000000167014\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Leads in Review\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"REVIEWPROCESS LEADS\",\n \"system_defined\": true,\n \"name\": \"Leads in Review\",\n \"id\": \"738964000001661014\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Mailing Labels\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"ALLVIEWS\",\n \"system_defined\": true,\n \"name\": \"Mailing Labels\",\n \"id\": \"738964000000091503\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"My Converted Leads\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"MYCONVERTEDVIEWS\",\n \"system_defined\": true,\n \"name\": \"My Converted Leads\",\n \"id\": \"738964000000093007\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"My Leads\",\n \"offline\": true,\n \"default\": true,\n \"system_name\": \"MYVIEWS\",\n \"system_defined\": true,\n \"name\": \"My Leads\",\n \"id\": \"738964000000091563\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Not Qualified Leads\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"NOTQUALIFIEDLEADVIEWS\",\n \"system_defined\": true,\n \"name\": \"Not Qualified Leads\",\n \"id\": \"738964000000167025\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Open Leads\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"OPENLEADVIEWS\",\n \"system_defined\": true,\n \"name\": \"Open Leads\",\n \"id\": \"738964000000167036\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Recently Created Leads\",\n \"offline\": false,\n \"default\": false,\n \"system_name\": \"RECENTLYCREATED\",\n \"system_defined\": true,\n \"name\": \"Recently Created Leads\",\n \"id\": \"738964000000091509\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Recently Modified Leads\",\n \"offline\": false,\n \"default\": false,\n \"system_name\": \"RECENTLYMODIFIED\",\n \"system_defined\": true,\n \"name\": \"Recently Modified Leads\",\n \"id\": \"738964000000091511\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Today's Leads\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"today\",\n \"system_defined\": true,\n \"name\": \"Todays Leads\",\n \"id\": \"738964000000091507\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Unread Leads\",\n \"offline\": false,\n \"default\": false,\n \"system_name\": \"UNREADVIEWS\",\n \"system_defined\": true,\n \"name\": \"Unread Leads\",\n \"id\": \"738964000000091505\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Unsubscribed Leads\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"UNSUBSCRIBED\",\n \"system_defined\": true,\n \"name\": \"Unsubscribed Leads\",\n \"id\": \"738964000001168011\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n }\n ],\n \"info\": {\n \"per_page\": 200,\n \"default\": \"738964000000091563\",\n \"count\": 15,\n \"translation\": {\n \"public_views\": \"Public Views\",\n \"other_users_views\": \"Other Users' Views\",\n \"shared_with_me\": \"Shared With Me\",\n \"created_by_me\": \"Created By Me\"\n },\n \"page\": 1,\n \"more_records\": false\n }\n}"
},
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/custom_views?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"custom_views"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:30:47 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-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-11T12:57:36+00:00"
},
{
"key": "clientVersion",
"value": "4023320"
},
{
"key": "clientsubVersion",
"value": "4d8b6ee4f7d1d284c930a4e807480c5c"
},
{
"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=15768000"
}
],
"cookie": [
],
"body": "{\n \"custom_views\": [\n {\n \"display_value\": \"All Leads\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"ALLVIEWS\",\n \"system_defined\": true,\n \"name\": \"All Open Leads\",\n \"id\": \"738964000000091501\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Co-Owner Leads\",\n \"offline\": false,\n \"default\": false,\n \"system_name\": \"COOWNERVIEW\",\n \"system_defined\": true,\n \"name\": \"Co-Owner Leads\",\n \"id\": \"738964000001918218\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Converted Leads\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"CONVERTEDVIEWS\",\n \"system_defined\": true,\n \"name\": \"Converted Leads\",\n \"id\": \"738964000000093005\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Junk Leads\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"JUNKLEADVIEWS\",\n \"system_defined\": true,\n \"name\": \"Junk Leads\",\n \"id\": \"738964000000167014\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Leads in Review\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"REVIEWPROCESS LEADS\",\n \"system_defined\": true,\n \"name\": \"Leads in Review\",\n \"id\": \"738964000001661014\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Mailing Labels\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"ALLVIEWS\",\n \"system_defined\": true,\n \"name\": \"Mailing Labels\",\n \"id\": \"738964000000091503\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"My Converted Leads\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"MYCONVERTEDVIEWS\",\n \"system_defined\": true,\n \"name\": \"My Converted Leads\",\n \"id\": \"738964000000093007\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"My Leads\",\n \"offline\": true,\n \"default\": true,\n \"system_name\": \"MYVIEWS\",\n \"system_defined\": true,\n \"name\": \"My Leads\",\n \"id\": \"738964000000091563\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Not Qualified Leads\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"NOTQUALIFIEDLEADVIEWS\",\n \"system_defined\": true,\n \"name\": \"Not Qualified Leads\",\n \"id\": \"738964000000167025\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Open Leads\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"OPENLEADVIEWS\",\n \"system_defined\": true,\n \"name\": \"Open Leads\",\n \"id\": \"738964000000167036\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Recently Created Leads\",\n \"offline\": false,\n \"default\": false,\n \"system_name\": \"RECENTLYCREATED\",\n \"system_defined\": true,\n \"name\": \"Recently Created Leads\",\n \"id\": \"738964000000091509\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Recently Modified Leads\",\n \"offline\": false,\n \"default\": false,\n \"system_name\": \"RECENTLYMODIFIED\",\n \"system_defined\": true,\n \"name\": \"Recently Modified Leads\",\n \"id\": \"738964000000091511\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Today's Leads\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"today\",\n \"system_defined\": true,\n \"name\": \"Todays Leads\",\n \"id\": \"738964000000091507\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Unread Leads\",\n \"offline\": false,\n \"default\": false,\n \"system_name\": \"UNREADVIEWS\",\n \"system_defined\": true,\n \"name\": \"Unread Leads\",\n \"id\": \"738964000000091505\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n },\n {\n \"display_value\": \"Unsubscribed Leads\",\n \"offline\": true,\n \"default\": false,\n \"system_name\": \"UNSUBSCRIBED\",\n \"system_defined\": true,\n \"name\": \"Unsubscribed Leads\",\n \"id\": \"738964000001168011\",\n \"category\": \"shared_with_me\",\n \"favorite\": null\n }\n ],\n \"info\": {\n \"per_page\": 200,\n \"default\": \"738964000000091563\",\n \"count\": 15,\n \"translation\": {\n \"public_views\": \"Public Views\",\n \"other_users_views\": \"Other Users' Views\",\n \"shared_with_me\": \"Shared With Me\",\n \"created_by_me\": \"Created By Me\"\n },\n \"page\": 1,\n \"more_records\": false\n }\n}"
},
{
"name": "REQUIRED_PARAM_MISSING",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/custom_views",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"custom_views"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:30:57 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "133"
},
{
"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": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"REQUIRED_PARAM_MISSING\",\n \"details\": {\n \"param\": \"module\"\n },\n \"message\": \"One of the expected parameter is missing\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_MODULE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/custom_views?module=Lead",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"custom_views"
],
"query": [
{
"key": "module",
"value": "Lead"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:31:11 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-11T12:57:36+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_URL_PATTERN",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/custom_view?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"custom_view"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:31:21 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-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-11T12:57:36+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_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": "COPY",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/settings/custom_views?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"custom_views"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:31:34 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/settings/custom_views?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"custom_views"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 12:31:49 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/settings/custom_views?module=Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"settings",
"custom_views"
],
"query": [
{
"key": "module",
"value": "Leads"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 08:29:50 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}"
}
]
}
