sh_get_currencies
1 Описание
| Назначение | Получение списка всех валют |
| Тип запроса | Асинхронный |
| Версия SH | SH4, SH5 |
В sh5 не возвращается наименование целой и дробной частей валюты.
2 Формат запросов
2.1 Формат запроса
<RQ cmd="sh_get_currencies" tasktype="any_call" 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 (асинхронного ответа)
<RP cmdguid="6774b0bc-dd5e-4eca-a1f9-d982607feb2e" posid="7E04197A-8885-46BF-BB07-78274C0C5F38"> <CURRENCY rid="1" name="Евро" code="EUR" bank_code="003" wholepart="euro" fractionpart="eurocent"/> <CURRENCY rid="0" name="Рубль" code="RUB" bank_code="002" wholepart="руб" fractionpart="коп"/> </RP>
Описание параметров
Параметр | Тип | Описание |
|---|---|---|
| cmdguid | guid | Совпадает с taskguid в ответе |
| posid | guid | POS id кассового сервера (можно игнорировать) |
Описание структуры валюта (CURRENCY)
Параметр | Тип | Описание |
|---|---|---|
| rid | int | Ключ валюты |
| name | string | Наименование валюты |
| bank_code | string | Банковский код валюты |
| wholepart | string | Наименование целой части валюты |
| fractionpart | string | Наименование дробной части валюты |
3 Примеры вызовов
3.1 Пример
3.1.1 Запрос
<RQ cmd="sh_get_currencies" tasktype="any_call" callback="http://ya.ru"> <PARAM name="object_id" val="199990053"/> </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="90EF4C1B-358E-4408-8B4D-E2BC799A0688"> <CURRENCY rid="1" name="Евро" code="EUR" bank_code="003" wholepart="euro" fractionpart="eurocent"/> <CURRENCY rid="0" name="Рубль" code="RUB" bank_code="002" wholepart="руб" fractionpart="коп"/> </RP>