Employee is a model for employee data.

Format


JSON

{
  "id": 0,
  "name": "string",
  "altName": "string",
  "visualTypeImage": "string",
  "visualTypeBColor": "string",
  "visualTypeTextColor": "string",
  "visualTypeFlags": "string",
  "cardCode": "string",
  "largeImagePath": "string",
  "eMail": "string",
  "pagerCode": "string",
  "pagerType": "string",
  "groups": [0,1],
  "restaurantRoles": [
    {
      "restaurantId": 1,
      "roleId": 1000050,
      "name": "Administrators"
    }
  ],
  "brigade": "string",
  "defServPosition": "string",
  "defaultRestaurantId": 0
}

Parameter

Type

Mandatory

Description

idintyesEmployee record ID
namestringyesFull name of the employee
altNamestringnoEmployee's full name in an alternative language
visualTypeBColorstringnoElement button background color
visualTypeImagestringnoThe image assigned to the element
visualTypeTextColorstringnoColor of text on element button
cardCodestringnoEmployee card code, which the employee uses to log in at the cash register
largeImagePathstringnoName of the file with the large image
eMailstringnoUser's email
pagerCodestringnoUnique pager number
pagerTypestringnoPager type
groups

int[]

yesArray of group IDs to which the employee is included
restaurantRolesarrayyesAn array of employee roles. It is assumed that there is only one role assigned to an employee in a restaurant.
-restaurantIdintyesThe ID of the restaurant to which the role is assigned
-roleIdintyesRole ID
-name

Role Name
brigadestringnoThe team to which the worker belongs
defaultRestaurantIdintnoCurrent restaurant ID
defServPositionstringnoDefault worker service position