sh_get_classifiervals
1 Описание
Назначение | Получить список значений классификаторов объектов |
Тип запроса | Асинхронный |
Версия SH | SH4 |
2 Формат запросов
2.1 Формат запроса
<RQ cmd="sh_get_classifiervals" tasktype = "any_call" callback="http://ya.ru"> <PARAM name="object_id" val="00000000"/> <PARAM name="classifier_rid" val="2"/> </RQ>
Описание параметров
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
---|---|---|---|---|
object_id | int | + | Код ресторана в системе лицензирования | |
groupguid | guid | - | Необязательный guid для группировки запросов в рамках одного пользовательского сценария. Если создаётся серия запросов (создан заказ, сохранён, оплачен), то лучше группировать их в один сценарий для упрощения диагностики проблем. | |
callback | string | + | HTTP адрес, по которому WhiteServer отправит запрос после выполнения команды | |
classifier_rid | string | + | Rid одного из объектов, полученных из запроса sh_get_classifiers |
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="e1761d18-6325-43d0-85a3-2610ad637f3d" posid="90EF4C1B-358E-4408-8B4D-E2BC799A0688"> <CLASSIFIERVAL rid="3" name="Мебель 1"/> <CLASSIFIERVAL rid="4" name="Мебель 2"/> </RP>
Описание параметров
Параметр | Тип | Описание |
---|---|---|
cmdguid | guid | Совпадает с taskguid в ответе |
posid | guid | POS id кассового сервера (можно игнорировать) |
rid | int | Rid значения классификатора |
name | int | Название значения классификатора |
3 Таблица ошибок метода
<RQ cmdguid="e1761d18-6325-43d0-85a3-2610ad637f3d"> <ERROR code="int" text="Ошибка связи со складом"/> </RQ>
4 Примеры вызовов
4.1 Пример GetSystemInfo
4.1.1 Запрос
<?xml version="1.0" encoding="utf-8"?> <RQ cmd="sh_get_classifiervals" tasktype = "any_call" callback="http://ya.ru"> <PARAM name="object_id" val="199990106"/> <PARAM name="classifier_rid" val="2"/> </RQ>
4.1.2 Ответ
<?xml version="1.0" encoding="utf-8"?> <RP taskguid="0a85447e-f4da-4424-8c36-d20c63fe6b89" code="0" version="1.7.0.8215" />
4.1.3 Callback (асинхронный ответ)
<RP cmdguid="0a85447e-f4da-4424-8c36-d20c63fe6b89" posid="90EF4C1B-358E-4408-8B4D-E2BC799A0688"> <CLASSIFIERVAL rid="3" name="Мебель 1"/> <CLASSIFIERVAL rid="4" name="Мебель 2"/> </RP>
Обратите внимание, что в 4.1.2 taskguid и 4.1.3 cmdguid совпадают.