get_state
1 Описание
Назначение | Получить статус по заказам |
Тип запроса | Асинхронный |
2 Формат запросов
2.1 Формат запроса
<?xml version="1.0" encoding="utf-8"?> <RQ cmd="get_state" callback="http://ya.ru" guid="guid" timeout="int"> <CHECK qrid="QRid"> </CHECK> </RQ>
Описание параметров
Параметр | Тип | Обязательный | Описание | Значение по умолчанию |
---|
callback | string | + | HTTP адрес, по которому WhiteServer отправит запрос после выполнения команды | |
CHECK qrid | string | + | Qrid заказа, состояние которого нужно получить |
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 taskguid="guid"> <ERROR code="int" text="string"/> <CHECK ext_id="guid" qrid="qrid" order_guid="guid"> <STATE finished="int" paid="int" locked="int" precheck="int"/> </CHECK> </RP>
Описание параметров
Параметр | Тип | Описание | |
---|---|---|---|
taskguid | guid | Совпадает с taskguid в ответе | |
CHECK ext_id | guid | guid заказа, переданного в запросе | |
CHECK qrid | string | Qrid заказа | |
CHECK order_guid | guid | guid заказа, созданного в rKeeper | |
STATE finished | int | Закрыт ли заказ (0 - нет, 1 - да ) | |
STATE paid | int | Оплачен ли заказ (0 - нет, 1 - да ) | |
STATE locked | int | Заблокирован ли заказ (0 - нет, 1 - да ) | |
STATE precheck | int | Сформирован ли precheck по заказу (0 - нет, 1 - да ) | |
ERROR code | int | Код ошибки | |
ERROR text | string | Текстовое описание ошибки |
3 Примеры вызовов
3.1 Пример
3.1.1 Запрос
<?xml version="1.0" encoding="utf-8"?> <RQ cmd="get_state" callback="http://ya.ru" guid="A09E7DD8-8245-4590-BA65-2CBF9E35035E" timeout="120"> <CHECK qrid="7E04197A888546BFBB0778274C0C5F38050FB51ACD4D489B9CB20E008D0C7EA9A4E203F6"> </CHECK> </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 taskguid="0a85447e-f4da-4424-8c36-d20c63fe6b89" posid="797C3E3B-3C33-4D97-87F8-25578FE48BE6"> <CHECK qrid="7E04197A888546BFBB0778274C0C5F38050FB51ACD4D489B9CB20E008D0C7EA9A4E203F6" order_guid="{050FB51A-CD4D-489B-9CB2-0E008D0C7EA9}"> <STATE finished="0" paid="0" locked="0" precheck="0"/> </CHECK> </RP>
4.1.4 Callback (асинхронный ответ) с ошибкой
<RP taskguid="0a85447e-f4da-4424-8c36-d20c63fe6b89"> <ERROR code="101" text="Заказ не найден"/> </RP>