НазначениеЗапрос получения списка сотрудников
Тип запросаасинхронный, синхронный
Поддерживаемая версия агентаv2
PluggetSystemTypeRKRef

Формат запроса

{
  "taskType": "GetEmployees",
  "params": {

    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    }

  }
}
JSON

Параметр

Тип

Обязательный

Описание

taskType

Тип задачи
-async

Асинхронный вызов метода: либо синхронный, либо асинхронный
-sync

Синхронный вызов метода: либо синхронный, либо асинхронный
--timeoutintнетВремя ожидания ответа от агента в секундах, по умолчанию — 120 секунд
--objectIdintдаКод ресторана в системе лицензирования

Формат ответа

{
 "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
}
  ]

}
JSON

Параметр

Тип

Обязательный
-taskGuidguid
Уникальный код этой задачи. Используется при получении задачи через очередь
-taskTypestring enum
Тип задачи
-objectIdint
Код ресторана в системе лицензирования
taskResponseobject

--idintдаИдентификатор записи о сотруднике
--namestringдаФИО сотрудника
--altNamestringнетФИО сотрудника на альтернативном языке
--visualTypeImagestringнетКартинка, назначенная элементу
--visualTypeBColorstringнетЦвет фона кнопки элемента
--visualTypeTextColorstringнетЦвет текста на кнопке элемента
--visualTypeImagestringнетКартинка, назначенная элементу
--cardCodestringнетКод карты сотрудника, которой работник авторизуется на кассе
--largeImagePathstringнетИмя файла с большой картинкой
--eMailstringнетE-mail пользователя
--pagerCodestringнетУникальный номер пейджера
--pagerTypestringнетТип пейджера
--brigadestringнетБригада, к которой относится работник
--defServPositionstringнетПозиция обслуживания работника по умолчанию
--defaultRestaurantIdintнетИдентификатор текущего ресторана
--groups

int[]

даМассив идентификаторов групп, в которые включен сотрудник
--restaurantRolesarrayдаМассив ролей сотрудника
---restaurantIdintдаИдентификатор ресторана, для которого отведена роль
---roleIdintдаИдентификатор роли 

Пример запроса

{
  "taskType": "GetEmployees",
  "params": {
    "sync": {
      "objectId": 199990106,
      "timeout": 60
    }
  }
}
JSON