get_menu
1 Описание
Назначение | Данный запрос возвращает ранее сохраненное на сервере меню по объекту. Агент периодически уведомляет сервер об изменениях в меню. Сервер несколько раз в сутки (в 23:30 и в 7:00 по мск) забирает и сохраняет у себя обновленное меню. Версия и дата меню содержатся в ответе. |
Тип запроса | Синхронный |
2 Формат запросов
2.1 Формат запроса
<?xml version="1.0" encoding="utf-8"?> <RQ cmd="get_menu"> <PARAM name="object_id" val="000000000"/> </RQ>
Описание параметров
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
---|---|---|---|---|
object_id | int | + | Код ресторана в системе лицензирования |
2.2 Формат ответа
<RP taskguid="guid" code="int" version="int"> <MENU DataVersion="int" DateTime="DateTime"> <MITEM guid="guid" id="int" name="string" modscheme="guid" largeimage="BASE64"> <PRICES> <PRICE id="currency_id.1" val="money"/> </PRICES> </MITEM> <MITEM guid="guid" id="int" name="string"> <PRICES> <PRICE id="currency_id.1" val="money"/> </PRICES> </MITEM> </Menu> </RP>
Описание параметров
Параметр | Тип | Описание |
---|---|---|
taskguid | guid | Идентификатор запроса |
MENU DataVersion | int | Версия данных в Rk справочнике «Меню» |
MENU DateTime | XmlDateTime | Текущее время на агенте |
MITEM guid | guid | Идентификатор блюда |
MITEM id | int | Идентификатор блюда |
MITEM name | string | Название блюда |
MITEM modscheme | guid | Идентификатор схемы модификаторов |
MITEM largeimage | string | Картинка в base64 |
PRICE id | int | Идентификатор типа цены |
PRICE val | money | Цена модификатора |
3 Таблица ошибок метода
В случае, если меню не было загружено с агента на сервер:
<?xml version="1.0" encoding="utf-8"?> <RP taskguid="d9d4ee7f-a088-40d8-8e10-53cfd6ee0395" code="0" version="1.9.0"> <ERROR code="15" Text="No Data" /> </RP>
4 Примеры вызовов
4.1 Пример
4.1.1 Запрос
<RQ cmd="get_menu"> <PARAM name="object_id" val="199995826"/> </RQ>
4.1.2 Ответ
<?xml version="1.0" encoding="utf-8"?> <RP taskguid="083e3b13-2148-4ecc-a39c-e50dc7692590" code="0" version="1.9.0"> <MENU DataVersion="85" DateTime="2018-08-07T17:24:24"> <MITEM guid="34012e77-9e4d-4825-9623-37c4239573c9" id="1000020" name="Пельмени"> <PRICES> <PRICE id="3" val="75.00" /> </PRICES> </MITEM> <MITEM guid="ef893577-0c20-4301-b320-aa59469160db" id="1000021" name="Паста"> <PRICES> <PRICE id="3" val="38.00" /> </PRICES> </MITEM> </Menu> </RP>