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/modules/Leads",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)
; {
; "modules": [
; {
; "global_search_supported": true,
; "kanban_view": false,
; "deletable": true,
; "description": null,
; "creatable": true,
; "filter_status": true,
; "inventory_template_supported": false,
; "modified_time": "2021-04-04T08:54:55+05:30",
; "plural_label": "Leads",
; "presence_sub_menu": true,
; "triggers_supported": true,
; "id": "4150868000000002175",
; "isBlueprintSupported": true,
; "related_list_properties": {
; "sort_by": null,
; "fields": [
; "Full_Name",
; "Company",
; "Email",
; "Lead_Source",
; "Lead_Status",
; "Phone"
; ],
; "sort_order": null
; },
; "per_page": 100,
; "$properties": [
; "$converted",
; "$approved",
; "$approval_state",
; "$state",
; "$converted_detail",
; "$currency_symbol",
; "$review",
; "$review_process",
; "$approval",
; "$in_merge",
; "$followed",
; "$followers",
; "$process_flow",
; "$orchestration",
; "$stop_processing",
; "$data_source_details",
; "$has_more"
; ],
; "visible": true,
; "visibility": 1,
; "convertable": true,
; "editable": true,
; "emailTemplate_support": true,
; "profiles": [
; {
; "name": "Administrator",
; "id": "4150868000000026011"
; },
; {
; "name": "Standard",
; "id": "4150868000000026014"
; },
; {
; "name": "sample",
; "id": "4150868000001623001"
; }
; ],
; "filter_supported": true,
; "$on_demand_properties": [
; "$blocked_reason"
; ],
; "display_field": "Full_Name",
; "search_layout_fields": [
; "Owner",
; "Company",
; "Full_Name",
; "Email",
; "Phone",
; "Lead_Source"
; ],
; "kanban_view_supported": true,
; "show_as_tab": true,
; "web_link": null,
; "sequence_number": 23,
; "singular_label": "Lead",
; "viewable": true,
; "api_supported": true,
; "api_name": "Leads",
; "quick_create": true,
; "modified_by": {
; "name": "Patricia Boyle",
; "id": "4150868000000225013"
; },
; "generated_type": "default",
; "feeds_required": true,
; "scoring_supported": true,
; "webform_supported": true,
; "arguments": [
; ],
; "module_name": "Leads",
; "business_card_field_limit": 5,
; "custom_view": {
; "display_value": "Sample View",
; "access_type": "shared",
; "criteria": null,
; "system_name": null,
; "sort_by": null,
; "created_by": {
; "name": "Patricia Boyle",
; "id": "4150868000000225013"
; },
; "shared_to": [
; {
; "name": "Group1",
; "id": "4150868000000231952",
; "type": "groups",
; "subordinates": null
; },
; {
; "name": "User 3",
; "id": "4150868000001199001",
; "type": "users",
; "subordinates": null
; },
; {
; "name": "User 2",
; "id": "4150868000001248015",
; "type": "users",
; "subordinates": null
; }
; ],
; "default": true,
; "modified_time": "2021-03-04T00:54:53+05:30",
; "name": "Sample View",
; "system_defined": false,
; "modified_by": {
; "name": "Patricia Boyle",
; "id": "4150868000000225013"
; },
; "id": "4150868000004520004",
; "fields": [
; {
; "api_name": "Full_Name",
; "id": "4150868000000002631"
; },
; {
; "api_name": "Company",
; "id": "4150868000000002591"
; },
; {
; "api_name": "Email",
; "id": "4150868000000002599"
; },
; {
; "api_name": "Phone",
; "id": "4150868000000002601"
; },
; {
; "api_name": "Lead_Source",
; "id": "4150868000000002609"
; },
; {
; "api_name": "Owner",
; "id": "4150868000000002589"
; }
; ],
; "category": "created_by_me",
; "last_accessed_time": "2021-05-04T17:11:45+05:30",
; "sort_order": null,
; "favorite": null
; },
; "parent_module": {}
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
global_search_supported.i
kanban_view.i
deletable.i
description.s
creatable.i
filter_status.i
inventory_template_supported.i
modified_time.s
plural_label.s
presence_sub_menu.i
triggers_supported.i
id.s
isBlueprintSupported.i
Sort_by.s
Sort_order.s
per_page.i
visible.i
visibility.i
convertable.i
editable.i
emailTemplate_support.i
filter_supported.i
display_field.s
kanban_view_supported.i
show_as_tab.i
web_link.s
sequence_number.i
singular_label.s
viewable.i
api_supported.i
api_name.s
quick_create.i
Name.s
Id.s
generated_type.s
feeds_required.i
scoring_supported.i
webform_supported.i
module_name.s
business_card_field_limit.i
Display_value.s
Access_type.s
Criteria.s
System_name.s
custom_viewSort_by.s
Created_byName.s
Created_byId.s
Default.i
Modified_time.s
custom_viewName.s
System_defined.i
Modified_byName.s
Modified_byId.s
custom_viewId.s
Category.s
Last_accessed_time.s
custom_viewSort_order.s
Favorite.s
j.i
count_j.i
strVal.s
name.s
v_type.s
subordinates.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"modules")
While i < count_i
CkJsonObject::setCkI(jResp, i)
global_search_supported = CkJsonObject::ckBoolOf(jResp,"modules[i].global_search_supported")
kanban_view = CkJsonObject::ckBoolOf(jResp,"modules[i].kanban_view")
deletable = CkJsonObject::ckBoolOf(jResp,"modules[i].deletable")
description = CkJsonObject::ckStringOf(jResp,"modules[i].description")
creatable = CkJsonObject::ckBoolOf(jResp,"modules[i].creatable")
filter_status = CkJsonObject::ckBoolOf(jResp,"modules[i].filter_status")
inventory_template_supported = CkJsonObject::ckBoolOf(jResp,"modules[i].inventory_template_supported")
modified_time = CkJsonObject::ckStringOf(jResp,"modules[i].modified_time")
plural_label = CkJsonObject::ckStringOf(jResp,"modules[i].plural_label")
presence_sub_menu = CkJsonObject::ckBoolOf(jResp,"modules[i].presence_sub_menu")
triggers_supported = CkJsonObject::ckBoolOf(jResp,"modules[i].triggers_supported")
id = CkJsonObject::ckStringOf(jResp,"modules[i].id")
isBlueprintSupported = CkJsonObject::ckBoolOf(jResp,"modules[i].isBlueprintSupported")
Sort_by = CkJsonObject::ckStringOf(jResp,"modules[i].related_list_properties.sort_by")
Sort_order = CkJsonObject::ckStringOf(jResp,"modules[i].related_list_properties.sort_order")
per_page = CkJsonObject::ckIntOf(jResp,"modules[i].per_page")
visible = CkJsonObject::ckBoolOf(jResp,"modules[i].visible")
visibility = CkJsonObject::ckIntOf(jResp,"modules[i].visibility")
convertable = CkJsonObject::ckBoolOf(jResp,"modules[i].convertable")
editable = CkJsonObject::ckBoolOf(jResp,"modules[i].editable")
emailTemplate_support = CkJsonObject::ckBoolOf(jResp,"modules[i].emailTemplate_support")
filter_supported = CkJsonObject::ckBoolOf(jResp,"modules[i].filter_supported")
display_field = CkJsonObject::ckStringOf(jResp,"modules[i].display_field")
kanban_view_supported = CkJsonObject::ckBoolOf(jResp,"modules[i].kanban_view_supported")
show_as_tab = CkJsonObject::ckBoolOf(jResp,"modules[i].show_as_tab")
web_link = CkJsonObject::ckStringOf(jResp,"modules[i].web_link")
sequence_number = CkJsonObject::ckIntOf(jResp,"modules[i].sequence_number")
singular_label = CkJsonObject::ckStringOf(jResp,"modules[i].singular_label")
viewable = CkJsonObject::ckBoolOf(jResp,"modules[i].viewable")
api_supported = CkJsonObject::ckBoolOf(jResp,"modules[i].api_supported")
api_name = CkJsonObject::ckStringOf(jResp,"modules[i].api_name")
quick_create = CkJsonObject::ckBoolOf(jResp,"modules[i].quick_create")
Name = CkJsonObject::ckStringOf(jResp,"modules[i].modified_by.name")
Id = CkJsonObject::ckStringOf(jResp,"modules[i].modified_by.id")
generated_type = CkJsonObject::ckStringOf(jResp,"modules[i].generated_type")
feeds_required = CkJsonObject::ckBoolOf(jResp,"modules[i].feeds_required")
scoring_supported = CkJsonObject::ckBoolOf(jResp,"modules[i].scoring_supported")
webform_supported = CkJsonObject::ckBoolOf(jResp,"modules[i].webform_supported")
module_name = CkJsonObject::ckStringOf(jResp,"modules[i].module_name")
business_card_field_limit = CkJsonObject::ckIntOf(jResp,"modules[i].business_card_field_limit")
Display_value = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.display_value")
Access_type = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.access_type")
Criteria = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.criteria")
System_name = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.system_name")
custom_viewSort_by = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.sort_by")
Created_byName = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.created_by.name")
Created_byId = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.created_by.id")
Default = CkJsonObject::ckBoolOf(jResp,"modules[i].custom_view.default")
Modified_time = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.modified_time")
custom_viewName = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.name")
System_defined = CkJsonObject::ckBoolOf(jResp,"modules[i].custom_view.system_defined")
Modified_byName = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.modified_by.name")
Modified_byId = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.modified_by.id")
custom_viewId = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.id")
Category = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.category")
Last_accessed_time = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.last_accessed_time")
custom_viewSort_order = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.sort_order")
Favorite = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.favorite")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"modules[i].related_list_properties.fields")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"modules[i].related_list_properties.fields[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"modules[i].$properties")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"modules[i].$properties[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"modules[i].profiles")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
name = CkJsonObject::ckStringOf(jResp,"modules[i].profiles[j].name")
id = CkJsonObject::ckStringOf(jResp,"modules[i].profiles[j].id")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"modules[i].$on_demand_properties")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"modules[i].$on_demand_properties[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"modules[i].search_layout_fields")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"modules[i].search_layout_fields[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"modules[i].arguments")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"modules[i].custom_view.shared_to")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
name = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.shared_to[j].name")
id = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.shared_to[j].id")
v_type = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.shared_to[j].type")
subordinates = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.shared_to[j].subordinates")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"modules[i].custom_view.fields")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
api_name = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.fields[j].api_name")
id = CkJsonObject::ckStringOf(jResp,"modules[i].custom_view.fields[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/modules/Leads
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.1/settings/modules/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"modules",
"Leads"
]
},
"description": "To get the metadata of the Leads Module."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/modules/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"modules",
"Leads"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:05:59 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-05T12:33:08+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 \"modules\": [\n {\n \"global_search_supported\": true,\n \"kanban_view\": false,\n \"deletable\": true,\n \"description\": null,\n \"creatable\": true,\n \"filter_status\": true,\n \"inventory_template_supported\": false,\n \"modified_time\": \"2021-04-04T08:54:55+05:30\",\n \"plural_label\": \"Leads\",\n \"presence_sub_menu\": true,\n \"triggers_supported\": true,\n \"id\": \"4150868000000002175\",\n \"isBlueprintSupported\": true,\n \"related_list_properties\": {\n \"sort_by\": null,\n \"fields\": [\n \"Full_Name\",\n \"Company\",\n \"Email\",\n \"Lead_Source\",\n \"Lead_Status\",\n \"Phone\"\n ],\n \"sort_order\": null\n },\n \"per_page\": 100,\n \"$properties\": [\n \"$converted\",\n \"$approved\",\n \"$approval_state\",\n \"$state\",\n \"$converted_detail\",\n \"$currency_symbol\",\n \"$review\",\n \"$review_process\",\n \"$approval\",\n \"$in_merge\",\n \"$followed\",\n \"$followers\",\n \"$process_flow\",\n \"$orchestration\",\n \"$stop_processing\",\n \"$data_source_details\",\n \"$has_more\"\n ],\n \"visible\": true,\n \"visibility\": 1,\n \"convertable\": true,\n \"editable\": true,\n \"emailTemplate_support\": true,\n \"profiles\": [\n {\n \"name\": \"Administrator\",\n \"id\": \"4150868000000026011\"\n },\n {\n \"name\": \"Standard\",\n \"id\": \"4150868000000026014\"\n },\n {\n \"name\": \"sample\",\n \"id\": \"4150868000001623001\"\n }\n ],\n \"filter_supported\": true,\n \"$on_demand_properties\": [\n \"$blocked_reason\"\n ],\n \"display_field\": \"Full_Name\",\n \"search_layout_fields\": [\n \"Owner\",\n \"Company\",\n \"Full_Name\",\n \"Email\",\n \"Phone\",\n \"Lead_Source\"\n ],\n \"kanban_view_supported\": true,\n \"show_as_tab\": true,\n \"web_link\": null,\n \"sequence_number\": 23,\n \"singular_label\": \"Lead\",\n \"viewable\": true,\n \"api_supported\": true,\n \"api_name\": \"Leads\",\n \"quick_create\": true,\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"generated_type\": \"default\",\n \"feeds_required\": true,\n \"scoring_supported\": true,\n \"webform_supported\": true,\n \"arguments\": [],\n \"module_name\": \"Leads\",\n \"business_card_field_limit\": 5,\n \"custom_view\": {\n \"display_value\": \"Sample View\",\n \"access_type\": \"shared\",\n \"criteria\": null,\n \"system_name\": null,\n \"sort_by\": null,\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"shared_to\": [\n {\n \"name\": \"Group1\",\n \"id\": \"4150868000000231952\",\n \"type\": \"groups\",\n \"subordinates\": null\n },\n {\n \"name\": \"User 3\",\n \"id\": \"4150868000001199001\",\n \"type\": \"users\",\n \"subordinates\": null\n },\n {\n \"name\": \"User 2\",\n \"id\": \"4150868000001248015\",\n \"type\": \"users\",\n \"subordinates\": null\n }\n ],\n \"default\": true,\n \"modified_time\": \"2021-03-04T00:54:53+05:30\",\n \"name\": \"Sample View\",\n \"system_defined\": false,\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"id\": \"4150868000004520004\",\n \"fields\": [\n {\n \"api_name\": \"Full_Name\",\n \"id\": \"4150868000000002631\"\n },\n {\n \"api_name\": \"Company\",\n \"id\": \"4150868000000002591\"\n },\n {\n \"api_name\": \"Email\",\n \"id\": \"4150868000000002599\"\n },\n {\n \"api_name\": \"Phone\",\n \"id\": \"4150868000000002601\"\n },\n {\n \"api_name\": \"Lead_Source\",\n \"id\": \"4150868000000002609\"\n },\n {\n \"api_name\": \"Owner\",\n \"id\": \"4150868000000002589\"\n }\n ],\n \"category\": \"created_by_me\",\n \"last_accessed_time\": \"2021-05-04T17:11:45+05:30\",\n \"sort_order\": null,\n \"favorite\": null\n },\n \"parent_module\": {}\n }\n ]\n}"
},
{
"name": "INVALID_MODULE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/modules/Lead",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"modules",
"Lead"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:07:15 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": "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-05T12:33:08+05:30"
},
{
"key": "clientVersion",
"value": "4002155"
},
{
"key": "clientsubVersion",
"value": "bfb2326744b42e5c869a705645ac0006"
},
{
"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 \"resource_path_index\": 2\n },\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.1/settings/modulesLeads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"modulesLeads"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:07:28 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-05T12:33:08+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/modules/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"modules",
"Leads"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:07:47 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": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "POST",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/modules/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"modules",
"Leads"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:08:06 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": "OAUTH_SCOPE_MISMATCH",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/modules/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"modules",
"Leads"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 07:30:26 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}"
}
]
}
