(Quick Reference)

7 User permissions - Reference Documentation

Version: 2.1

Table of Contents

7 User permissions

7.1 List

Service: List of user permissions

Description: This web service returns the list of user permissions in JSON format

URL:

https://BASE_URL/api/VERSION/permissions

Method: GET

Parameters:

Pagination parameters:

NameDescriptionTypeRequiredPossible values
maxLimits the number of resources requested to return.Integerno 
offsetTells where to start returning records from the entire set of results.Integerno 
orderOrders ascending or descending.Integernoasc,desc
sortOrders the results by the specified field.Stringno 

The max parameter is set to 100 by default.

Filters parameters:

NameDescriptionTypeRequiredExample values
employeeReferenceWildcard search by the employee's referenceStringnoreference=ref-6* , reference=*ef-6 , reference=*ef-6*

Success Output

Success case: response.status=200

{
	"paging": {
		"total": 1,
		"max": 100,
		"offset": 0,
		"previous": null,
		"next": null
	},
	"data": [{
		"user": {
			"id": 170,
			"reference": "salesP-007",
			"href": "/api/v2.1/users/170"
		},
		"mobile_permissions": [{
			"module": "MOD_OBJECTIVE-APPOINTMENT_MOB",
			"actions": ["READ"]
		}, {
			"module": "MOD_OBJECTIVE-TURNOVER_MOB",
			"actions": ["READ"]
		}, {
			"module": "MOD_CUSTOMER_MOB",
			"actions": ["READ", "EDIT"]
		}, {
			"module": "MOD_ORDER-HISTORY_MOB",
			"actions": ["READ"]
		}, {
			"module": "MOD_VISIT_MOB",
			"actions": ["DELETE", "EDIT", "CREATE", "READ"]
		}, {
			"module": "MOD_OBJECTIVE-QUANTITY_MOB",
			"actions": ["READ"]
		}, {
			"module": "MOD_DASHBOARD_MOB",
			"actions": ["READ"]
		}, {
			"module": "MOD_REPORT_MOB",
			"actions": ["READ", "CREATE"]
		}, {
			"module": "MOD_GEO-LOCATION_MOB",
			"actions": ["READ"]
		}, {
			"module": "MOD_SHARED-FILE_MOB",
			"actions": ["READ"]
		}, {
			"module": "MOD_CATALOG_MOB",
			"actions": ["READ"]
		}, {
			"module": "MOD_REAL-TIME-STOCK_MOB",
			"actions": ["READ"]
		}, {
			"module": "MOD_CONTACT_MOB",
			"actions": ["EDIT", "CREATE", "READ"]
		}, {
			"module": "MOD_SURVEY_MOB",
			"actions": ["READ"]
		}, {
			"module": "MOD_ORDER_MOB",
			"actions": ["DELETE", "EDIT", "CREATE", "READ"]
		}],
		"bo_permissions": [{
			"module": "ITEM_UNITS",
			"actions": ["READ"]
		}, {
			"module": "ITEM_ITEMS-UNITS",
			"actions": ["READ"]
		}, {
			"module": "ITEM_TAX-TYPES",
			"actions": ["READ"]
		}, {
			"module": "ITEM_PROMOTION-LISTS",
			"actions": ["READ"]
		}, {
			"module": "ITEM_ITEMS",
			"actions": ["READ"]
		}, {
			"module": "MOD_ITEM",
			"actions": ["READ"]
		}, {
			"module": "CUSTOMER_CATEGORIES",
			"actions": ["READ"]
		}, {
			"module": "ITEM_CATEGORIES",
			"actions": ["READ"]
		}, {
			"module": "CUSTOMER_CUSTOMERS",
			"actions": ["CREATE", "READ"]
		}, {
			"module": "ITEM_PRICE-ASSIGN",
			"actions": ["READ"]
		}, {
			"module": "CUSTOMER_EMPLOYEE-ASSIGN",
			"actions": ["READ"]
		}, {
			"module": "ITEM_TAX-LISTS",
			"actions": ["READ"]
		}, {
			"module": "CUSTOMER_GROUPS",
			"actions": ["READ"]
		}, {
			"module": "MOD_CUSTOMER",
			"actions": ["READ"]
		}, {
			"module": "ITEM_TAX",
			"actions": ["READ"]
		}, {
			"module": "ITEM_TAX-ASSIGN",
			"actions": ["READ"]
		}, {
			"module": "ITEM_PRICE-UNIT",
			"actions": ["READ"]
		}, {
			"module": "MOD_OPERATION",
			"actions": ["READ"]
		}, {
			"module": "ITEM_PRICE-LISTS",
			"actions": ["READ"]
		}, {
			"module": "OPERATION_ORDER",
			"actions": ["READ", "CREATE"]
		}]
	}]
}