sh_get_munits
1 Описание
Назначение | Получить список единиц измерения с группами |
Тип запроса | Асинхронный |
Версия SH | SH4, SH5 |
В sh5 нет данных о штрихкоде - еще не реализовано в самом sh5.
2 Формат запросов
2.1 Формат запроса
<?xml version="1.0" encoding="utf-8"?> <RQ tasktype="any_call" cmd="sh_get_munits" callback="http://ya.ru" > <PARAM name="object_id" val="000000000"/> </RQ>
Описание параметров
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
---|---|---|---|---|
object_id | int | + | Код ресторана в системе лицензирования | |
groupguid | guid | - | Необязательный guid для группировки запросов в рамках одного пользовательского сценария. Если создаётся серия запросов (создан заказ, сохранён, оплачен), то лучше группировать их в один сценарий для упрощения диагностики проблем. | |
callback | string | + | HTTP адрес, по которому WhiteServer отправит запрос после выполнения команды |
2.2 Формат ответа
<?xml version="1.0" encoding="utf-8"?> <RP taskguid="6774b0bc-dd5e-4eca-a1f9-d982607feb2e" code="0" version="1.5.0.7155" />
Описание параметров
Параметр | Тип | Описание |
---|---|---|
taskguid | guid | Уникальный код этой задачи. При отправке callback будет использован этот код, чтобы вызывающий сервис мог сопоставить запрос и ответ |
2.3 Формат callback (асинхронного ответа)
<RQ cmdguid="e1761d18-6325-43d0-85a3-2610ad637f3d" posid="90EF4C1B-358E-4408-8B4D-E2BC799A0688"> <ITEM rid="4" name="Порционные"> <MUNITS_LIST> <ITEM rid="7" name="полпорции" ratio="0.500"/> <ITEM rid="6" name="порция" ratio="1.000"/> </MUNITS_LIST> </ITEM> <ITEM rid="3" name="Штучные"> <MUNITS_LIST> <ITEM rid="5" name="шт" ratio="1.000"/> </MUNITS_LIST> </ITEM> <ITEM rid="2" name="Объемные"> <MUNITS_LIST> <ITEM rid="3" name="литр" ratio="1.000"/> </MUNITS_LIST> </ITEM> <ITEM rid="1" name="Весовые"> <MUNITS_LIST> <ITEM rid="2" name="гр" ratio="0.001"/> <ITEM rid="1" name="кг" ratio="1.000"/> </MUNITS_LIST> </ITEM> </RQ>
Описание параметров
Параметр | Тип | Описание | |
---|---|---|---|
cmdguid | guid | Совпадает с taskguid в ответе | |
posid | guid | POS id кассового сервера (можно игнорировать) | |
ITEM rid | int | Rid группы | |
ITEM name | string | Название группы | |
MUNITS_LIST ITEM rid | int | Rid единицы измерения | |
MUNITS_LIST ITEM name | string | Название единицы измерения | |
MUNITS_LIST ITEM ratio | double | Значение единицы измерения |
3 Примеры вызовов
3.1 Пример
3.1.1 Запрос
<?xml version="1.0" encoding="utf-8"?> <RQ tasktype="any_call" cmd="sh_get_munits" callback="http://ya.ru" guid="guid"> <PARAM name="object_id" val="199990106"/> </RQ>
3.1.2 Ответ
<?xml version="1.0" encoding="utf-8"?> <RP taskguid="0a85447e-f4da-4424-8c36-d20c63fe6b89" code="0" version="1.7.0.8215" />
3.1.3 Callback (асинхронный ответ)
<RP cmdguid="0a85447e-f4da-4424-8c36-d20c63fe6b89" posid="797C3E3B-3C33-4D97-87F8-25578FE48BE6"> <ITEM rid="4" name="Порционные"> <MUNITS_LIST> <ITEM rid="7" name="полпорции" ratio="0.500"/> <ITEM rid="6" name="порция" ratio="1.000"/> </MUNITS_LIST> </ITEM> <ITEM rid="3" name="Штучные"> <MUNITS_LIST> <ITEM rid="5" name="шт" ratio="1.000"/> </MUNITS_LIST> </ITEM> <ITEM rid="2" name="Объемные"> <MUNITS_LIST> <ITEM rid="3" name="литр" ratio="1.000"/> </MUNITS_LIST> </ITEM> <ITEM rid="1" name="Весовые"> <MUNITS_LIST> <ITEM rid="2" name="гр" ratio="0.001"/> <ITEM rid="1" name="кг" ratio="1.000"/> </MUNITS_LIST> </ITEM> </RQ>
Обратите внимание, что в 3.1.2 taskguid и 3.1.3 cmdguid совпадают.