sh_get_goods_ctg
1 Описание
| Назначение | Получить категории товаров |
| Тип запроса | Асинхронный |
| Версия SH | SH4, SH5 |
2 Формат запросов
2.1 Формат запроса
<?xml version="1.0" encoding="utf-8"?> <RQ cmd="sh_get_goods_ctg" tasktype = "any_call" callback="http://ya.ru"> <PARAM name="object_id" val="000000000"/> <PARAM name="goodscategorytype" val="gctMain"/> </RQ>
Запрос на получение группы блюд:
Описание параметров
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
|---|---|---|---|---|
| object_id | int | + | Код ресторана в системе лицензирования | |
| groupguid | guid | - | Необязательный guid для группировки запросов в рамках одного пользовательского сценария. Если создаётся серия запросов (создан заказ, сохранён, оплачен), то лучше группировать их в один сценарий для упрощения диагностики проблем. | |
| callback | string | + | HTTP адрес, по которому WhiteServer отправит запрос после выполнения команды | |
| goodscategorytype | string | + | Отвечает за тип категорий, которые возвращаются. Допустимые значения: gctMain - основные категории, gctBookkeeping - бухгалтерские категории |
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 (асинхронного ответа)
<RP cmdguid="6774b0bc-dd5e-4eca-a1f9-d982607feb2e" posid="4D7B18F2-58CE-4F0F-A2B6-2D90A6BFCF67"> <CATEGORY rid="4" name="Важный"/> <CATEGORY rid="3" name="Пробный товар"/> <CATEGORY rid="1" name="Товар (по умолчанию)"/> </RP>
Описание параметров
Параметр | Тип | Описание | |
|---|---|---|---|
| cmdguid | guid | Совпадает с taskguid в ответе | |
| posid | guid | POS id кассового сервера (можно игнорировать) | |
| CATEGORY rid | int | Rid категории | |
| CATEGORY name | string | Название категории |
3 Примеры вызовов
3.1 Пример GetSystemInfo
3.1.1 Запрос
<?xml version="1.0" encoding="utf-8"?> <RQ cmd="sh_get_goods_ctg" tasktype = "any_call" callback="http://ya.ru"> <PARAM name="object_id" val="199990106"/> <PARAM name="goodscategorytype" val="gctMain"/> </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"> <CATEGORY rid="4" name="Важный"/> <CATEGORY rid="3" name="Пробный товар"/> <CATEGORY rid="1" name="Товар (по умолчанию)"/> </RP>
Обратите внимание, что в 3.1.2 taskguid и 3.1.3 cmdguid совпадают.