НазначениеПолучить список корреспондентов
Тип запросаАсинхронный
Версия SHSH4, SH5

В sh5 нет групп корреспондентов, поэтому создается 3 статических группы: «Юридические лица», «Физические лица» и «Спец. корреспонденты». В эти группы помещаются все корреспонденты в соответствии с их типом.

2.1 Формат запросаLink to 2.1 Формат запроса

<?xml version="1.0" encoding="utf-8"?>
<RQ cmd="sh_get_corrs" tasktype="any_call" callback="http://ya.ru">
  <PARAM name="object_id" val="000000000"/>
</RQ>

Описание параметров


Параметр
Тип
Обязательный
Описание
Значение по умолчанию
object_idint+Код ресторана в системе лицензирования
groupguidguid-Необязательный guid для группировки запросов в рамках одного пользовательского сценария. Если создаётся серия запросов (создан заказ, сохранён, оплачен), то лучше группировать их в один сценарий для упрощения диагностики проблем.
callbackstring+HTTP адрес, по которому WhiteServer отправит запрос после выполнения команды


2.2 Формат ответаLink to 2.2 Формат ответа

<?xml version="1.0" encoding="utf-8"?>
<RP taskguid="6774b0bc-dd5e-4eca-a1f9-d982607feb2e" code="0" version="1.5.0.7155" />

Описание параметров

Параметр
Тип
Описание
taskguidguidУникальный код этой задачи. При отправке callback будет использован этот код, чтобы вызывающий сервис мог сопоставить запрос и ответ


2.3 Формат callback (асинхронного ответа)Link to 2.3 Формат callback (асинхронного ответа)

<RP cmdguid="d87eb27c-6220-4ff4-9d1b-0951b50447a7" posid="4D7B18F2-58CE-4F0F-A2B6-2D90A6BFCF67">
<CORRGROUP rid="1" name="Корреспонденты" parent="" />
  <CORRGROUP rid="2" name="Специальные" parent="1">
    <CORR rid="1395" type="2" 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>
    </CORR>
    <CORR rid="20" type="3" 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>
    </CORR>
  </CORRGROUP>
</RP> 

Описание параметров

Параметр
Тип
Описание
cmdguidguidСовпадает с taskguid в ответе
posidguidPOS id кассового сервера (можно игнорировать)
CORR ridintRid корреспондента
CORR typeintТип корреспондента
CORR namestringИмя корреспондента
ATTR namestringИмя атрибута
ATTR valuestringЗначение атрибута

3.1 ПримерLink to 3.1 Пример

3.1.1 ЗапросLink to 3.1.1 Запрос

<?xml version="1.0" encoding="utf-8"?>
<RQ cmd="sh_get_corrs" tasktype="any_call" callback="http://ya.ru">
  <PARAM name="object_id" val="199990106"/>
</RQ>

3.1.2 ОтветLink to 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 (асинхронный ответ)Link to 3.1.3 Callback (асинхронный ответ)

<RP cmdguid="0a85447e-f4da-4424-8c36-d20c63fe6b89" posid="797C3E3B-3C33-4D97-87F8-25578FE48BE6">
<CORRGROUP rid="1" name="Корреспонденты" parent="" />
  <CORRGROUP rid="2" name="Специальные" parent="1">
    <CORR rid="1395" type="2" 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>
    </CORR>
    <CORR rid="1392" type="1" name="ООО &quot;АШАН&quot;">
      <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="Общество с ограниченной ответственностью &quot;АШАН&quot;" />
        <Attr name="$CAcc" value="30101810400000000351" />
        <Attr name="$BIK" value="044525351" />
        <Attr name="$Bank" value="ООО &quot;Эйч-эс-би-си.Банк&quot;" />
        <Attr name="$PAcc" value="40702810000000100268" />
        <Attr name="$KPP" value="509950001" />
        <Attr name="$INN" value="7703270067" />
        <Attr name="$Phones" value="" />
        <Attr name="$PAddr" value="РФ, 125252, г. Москва, Ходынский бульвар, д.4. КПП 771445001" />
        <Attr name="$RAddr" value="141014, Московская область, Мытищинский район, г. Мытищи, Осташковское шоссе, д. 1, КПП 509950001 (502901001)" />
      </Attrs>
    </CORR>
    <CORR rid="20" type="3" 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>
    </CORR>
    <CORR rid="17" type="3" 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>
    </CORR>
  </CORRGROUP>
</RP>

Обратите внимание, что в 3.1.2 taskguid и 3.1.3 cmdguid совпадают.

V2 ShGetCorrsLink to V2 ShGetCorrs