GetRestaurantConfig

Назначение	Запрос метаданных для настройки ресторана
Тип запроса	Асинхронный/синхронный
Поддерживаемая версия агента	>= v2.2
PluggetSystemType	RKRef

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

{
  "taskType": "GetRestaurantConfig",
  "params": {
    "sync": {
      "objectId": number,
       "timeout": number
    }
  }
}

JSON

Параметр	Тип	Обязательный	Описание
taskType	string	да	Тип задачи. Для данного метода — значение GetAgentSettings
-sync			Синхронный вызов метода
--timeout	int	нет	Время ожидания ответа от агента в секундах, по умолчанию — 120 секунд
--objectId	int	нет	Код ресторана, для которого сделан запрос

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

{ 
   "responseCommon":{ 
      "taskGuid":"guid",
      "taskType":"GetRestaurantConfig",
      "objectId": 0
   },   

   "taskResponse":{
     "fields": [

       {

          "name": "Стол",
          "path": "OrderCreationPreferences.DefaultTableCode",
          "values": [{"Стол1", 10001}, {"Стол2", 10002} ... {"Стол для доставки", 10099}], 	//если null, то свободный ввод
          "required": true,
          "valueType": "number", 																	//принимает значение number/text/boolean
          "defaultValue": 10099

       }

    ]

   },

   "error":{ 
      "wsError":{ 
         "code":"string",
         "desc":"string"
      }
   }
}

JSON

Параметр	Тип	Описание
-taskGuid	guid	Уникальный код этой задачи. Используется при получении задачи через очередь
-taskType	string enum	Тип задачи
-objectId	int or null	Код ресторана, для которого сделан запрос
error		Контейнер ошибок, подробнее читайте в статье Описание ошибок
taskResponse	object	Данные от агента
-fields	array	Массив полей настроек ресторана, отображаемых на UI административной панели
--name	string	Наименование поля
--path	string	Путь в файле .json — конфигурации агента
--values	array	Массив доступных значений данного параметра: имя + значение. Если null, то свободный ввод указанного типа
--valueType	string	Тип параметра. Принимает значение number, text или boolean
--required	bool	Обязательное или необязательное поле
--defaultValue	any	Значение по умолчанию

Результат выполнения запроса GetRestoranConfig необходимо сохранять в ObjectSettings в поле DataList в виде .json-файла со следующей структурой:

{
    "updated": время последнего обновления,
    "error": "Версия агента не поддерживает загрузку данных", 											//null если все ok
    "fields": [
        {
            "name": "Стол",
            "path": "OrderCreationPreferences.DefaultTableCode",
            "values": [{"Стол1", 10001}, {"Стол2", 10002} ... {"Стол для доставки", 10099}],		//если null, то свободный ввод, иначе выбор из указанного списка
            "required": true,
            "valueType": "number", 																		//может принимать значения  number/text/boolean
            "defaultValue": 10099
        },
        {
            "name": "Касса",
            "path": "OrderCreationPreferences.DefaultStationId",
            "values": [{"Основная", 20001}, ... ],														//если null, то свободный ввод, иначе выбор из указанного списка
            "required": true,
            "valueType": "number", 																		//может принимать значения  number/text/boolean
            "defaultValue": null
        },
          ...
        {
            "name": "Кассир",
            "path": "OrderCreationPreferences.DefaultCashierId",
            "values": [{"Администратор", 70001}, {"Пользователь WSA", 70002} ... ],					//если null, то свободный ввод, иначе выбор из указанного списка
            "required": false,
            "valueType": "number", 																		//может принимать значения  number/text/boolean
            "defaultValue": 70002
        }
    ]
}

JSON