sh_get_stores
1 Описание
Назначение | Получить список складов |
Тип запроса | Асинхронный |
Версия SH | SH4, SH5 |
В sh5 нет групп складов. Вместо складов используются подразделения. Поэтому создается одна статическая группа - «Подразделения». В эту группу добавляются все подразделения, которые есть в sh5.
В sh5 не возвращаются атрибуты склада.
2 Формат запросов
2.1 Формат запроса
<?xml version="1.0" encoding="utf-8"?> <RQ cmd="sh_get_stores" tasktype="any_call" callback="ya.ru" timeout="int"> <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"> <STOREGROUP rid="0" name="Склады" parent=""> <STORE rid="1423" name="Дополнительный склад"> <Attrs> <Attr name="PIN" value="" /> <Attr name="FNameB" value="" /> <Attr name="FNameD" value="" /> <Attr name="Email" value="" /> <Attr name="Region" value="" /> <Attr name="Country" value="" /> <Attr name="AlcDecl" value="" /> <Attr name="LicDep" value="" /> <Attr name="LicStopDate" value="" /> <Attr name="LicNum" value="" /> <Attr name="LicDate" value="" /> <Attr name="$FullName" value="" /> <Attr name="$CAcc" value="" /> <Attr name="$BIK" value="" /> <Attr name="$Bank" value="" /> <Attr name="$PAcc" value="" /> <Attr name="$KPP" value="" /> <Attr name="$INN" value="" /> <Attr name="$Phones" value="" /> <Attr name="$PAddr" value="" /> <Attr name="$RAddr" value="" /> </Attrs> </STORE> <STORE rid="2" name="Склад"/> </STOREGROUP> <STOREGROUP rid="20" name="еще склады" parent="0"> <STORE rid="1421" name="Второй склад"/> </STOREGROUP> <STOREGROUP rid="28" name="Доп.склады" parent="20"> <STORE rid="1422" name="Третий склад"/> </STOREGROUP> <STOREGROUP rid="29" name="Пустые склады" parent="0"/> </RP>
Описание параметров
Параметр | Тип | Описание | |
---|---|---|---|
cmdguid | guid | Совпадает с taskguid в ответе | |
posid | guid | POS id кассового сервера (можно игнорировать) | |
STOREGROUP | Группа складов | ||
STORE | Склад |
3 Примеры вызовов
3.1 Пример
3.1.1 Запрос
<?xml version="1.0" encoding="utf-8"?> <RQ cmd="sh_get_stores" tasktype="any_call" callback="ya.ru" timeout="int"> <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"> <STOREGROUP rid="0" name="Склады" parent=""> <STORE rid="1423" name="Дополнительный склад"> <Attrs> <Attr name="PIN" value="" /> <Attr name="FNameB" value="" /> <Attr name="FNameD" value="" /> <Attr name="Email" value="" /> <Attr name="Region" value="" /> <Attr name="Country" value="" /> <Attr name="AlcDecl" value="" /> <Attr name="LicDep" value="" /> <Attr name="LicStopDate" value="" /> <Attr name="LicNum" value="" /> <Attr name="LicDate" value="" /> <Attr name="$FullName" value="" /> <Attr name="$CAcc" value="" /> <Attr name="$BIK" value="" /> <Attr name="$Bank" value="" /> <Attr name="$PAcc" value="" /> <Attr name="$KPP" value="" /> <Attr name="$INN" value="" /> <Attr name="$Phones" value="" /> <Attr name="$PAddr" value="" /> <Attr name="$RAddr" value="" /> </Attrs> </STORE> <STORE rid="2" name="Склад"/> </STOREGROUP> <STOREGROUP rid="20" name="еще склады" parent="0"> <STORE rid="1421" name="Второй склад"/> </STOREGROUP> <STOREGROUP rid="28" name="Доп.склады" parent="20"> <STORE rid="1422" name="Третий склад"/> </STOREGROUP> <STOREGROUP rid="29" name="Пустые склады" parent="0"/> </RP>
Обратите внимание, что в 3.1.2 taskguid и 3.1.3 cmdguid совпадают.