GetEmployees
| Назначение | Запрос получения списка сотрудников |
|---|---|
| Тип запроса | асинхронный, синхронный |
| Поддерживаемая версия агента | v2 |
| PluggetSystemType | RKRef |
Формат запроса
{
"taskType": "GetEmployees",
"params": {
"async": {
"objectId": number,
"timeout": number
},
"sync": {
"objectId": number,
"timeout": number
}
}
}
JSON
Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| taskType | Тип задачи | ||
| -async | Асинхронный вызов метода: либо синхронный, либо асинхронный | ||
| -sync | Синхронный вызов метода: либо синхронный, либо асинхронный | ||
| --timeout | int | нет | Время ожидания ответа от агента в секундах, по умолчанию — 120 секунд |
| --objectId | int | да | Код ресторана в системе лицензирования |
Формат ответа
{
"responseCommon": {
"taskGuid": "string",
"taskType": "GetEmployees",
"objectId": 0
},
"taskResponse": {
"Employees": [
{
"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": "Администраторы"
}
],
"brigade": "string",
"defServPosition": "string",
"defaultRestaurantId": 0
"phoneNumber": "string",
"qrSberTips": "string"
}
]
}
JSON
Параметр | Тип | Обязательный | |
|---|---|---|---|
| -taskGuid | guid | Уникальный код этой задачи. Используется при получении задачи через очередь | |
| -taskType | string enum | Тип задачи | |
| -objectId | int | Код ресторана в системе лицензирования | |
| taskResponse | object | ||
| --id | int | да | Идентификатор записи о сотруднике |
| --name | string | да | ФИО сотрудника |
| --altName | string | нет | ФИО сотрудника на альтернативном языке |
| --visualTypeImage | string | нет | Картинка, назначенная элементу |
| --visualTypeBColor | string | нет | Цвет фона кнопки элемента |
| --visualTypeTextColor | string | нет | Цвет текста на кнопке элемента |
| --visualTypeImage | string | нет | Картинка, назначенная элементу |
| --cardCode | string | нет | Код карты сотрудника, которой работник авторизуется на кассе |
| --largeImagePath | string | нет | Имя файла с большой картинкой |
| string | нет | E-mail пользователя | |
| --pagerCode | string | нет | Уникальный номер пейджера |
| --pagerType | string | нет | Тип пейджера |
| --brigade | string | нет | Бригада, к которой относится работник |
| --defServPosition | string | нет | Позиция обслуживания работника по умолчанию |
| --defaultRestaurantId | int | да | Идентификатор текущего ресторана |
| --groups | int[] | да | Массив идентификаторов групп, в которые включен сотрудник |
| --restaurantRoles | array | да | Массив ролей сотрудника |
| ---restaurantId | int | да | Идентификатор ресторана, для которого отведена роль |
| ---roleId | int | да | Идентификатор роли |
| --phoneNumber | string | нет | Номер телефона |
| --qrSberTips | string | нет | QRСберчаевые |
Пример запроса
{
"taskType": "GetEmployees",
"params": {
"sync": {
"objectId": 199990106,
"timeout": 60
}
}
}
JSON