User

Simple user object#

Only main fields of user object

Attribute	Type	Description	Nullable
id	Integer	Identifier	false
login	String	User login (used to log in to the system)	false
level	Enum of (COMPANY,DIVISION,REGION,SHOP)	User orgstruct level	false
active	Boolean	user activity field	false
lang	Enum of (ru_RU,en_EN)	User language code	false
businessDirId	Integer	User business direction id	false
ldapLogin	String	User ldap login	true
email	String	User email	true
firstName	String	User first name	true
lastName	String	User last name	true
position	String	User position	true
timeZoneId	String	User time zone id format like (Europe/Moscow)	true
status	String	User status	true
invited	Boolean	User invited field	true

Example:

{
  "id": 2950,
  "active": true,
  "login": "samplemail@example.com",
  "firstName": "Jon",
  "lastName": "Doe",
  "position": "Manager",
  "email": "samplemail@example.com",
  "level": "REGION",
  "businessDirId": 1006,
  "lang": "ru_RU",
  "status": "ACTIVE",
  "invited": false
}

Usages:

Additional user fields#

Additional user object fields

Attribute	Type	Description	Nullable
roles	List of String	Set of user report roles	true
businessDir	Object	User business direction object	true
authType	Enum of (LOCAL,LDAP)	Authorization type (Local - by password, LDAP - via LDAP authorization)	false
authoritiesAll	List objects	All user roles	false
directorOfShops	List of integers	Shop id list where user is director	false
shops	List of integers	List of id shops associated with the user	false
regions	List of integers	List of id regions associated with the user	false
divisions	List of integers	List of id divisions associated with the user	false
voximplantEnabled	Boolean	Сalls are enabled for the user	false

Example:

{
  "roles": [
    "REPORT_TASKS",
    "REPORT_CHARTS",
    "REPORT_BPP",
    "REPORT_CHECKLISTS",
    "REPORT_CHECKLISTS_CATEGORIES_QUESTIONS",
    "ROLE_SUPERVISOR",
    "ROLE_DIRECTOR_CLUSTER",
    "REPORT_DYNAMICS_OF_EXECUTIVE_DISCIPLINE",
    "REPORT_MBI",
    "REPORT_2",
    "REPORT_EMPTY_DM",
    "CALL_ENABLED",
    "REPORT_3"
  ],
  "businessDir": {
    "id": 1006,
    "name": "Contractors",
    "createTask": true,
    "system": false,
    "geoCheckStart": "accept",
    "geoCheckFinish": "accept",
    "observeMyShopTask": false
  },
  "authType": "LOCAL",
  "authoritiesAll": [
    {
      "name": "REPORT_TASKS",
      "description": "Tasks"
    },
    {
      "name": "REPORT_CHECKLISTS",
      "description": "Checklists"
    }
  ],
  "directorOfShops": [],
  "shops": [],
  "regions": [
    85
  ],
  "divisions": [],
  "voximplantEnabled": true
}

Usages:

Get user by id