sh_get_staff
1 Описание
Назначение | Получить список сотрудников |
Тип запроса | Асинхронный |
Версия SH | SH4 |
Запрос работает только для sh4.
2 Формат запросов
2.1 Формат запроса
<?xml version="1.0" encoding="utf-8"?> <RQ cmd="sh_get_staff" 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"> <ITEM rid="int" name="name of person" pin="code" role="guid"/> <ITEM rid="102" name="Маша" pin="45678" role="a43a6ac3-429c-4d8a-b1a7-ba2d50760456"/> <ITEM rid="103" name="Вася" pin="1234" role="a2967661-aa63-487d-9f45-0e3d6517f9a2"/> </RP>
Описание параметров
Параметр | Тип | Описание | |
---|---|---|---|
cmdguid | guid | Совпадает с taskguid в ответе | |
posid | guid | POS id кассового сервера (можно игнорировать) | |
ITEM rid | int | Rid сотрудника | |
ITEM name | string | Имя сотрудника | |
ITEM pin | int | Pin сотрудника | |
ITEM role | guid | Guid роли сотрудника |
3 Примеры вызовов
3.1 Пример GetSystemInfo
3.1.1 Запрос
<?xml version="1.0" encoding="utf-8"?> <RQ cmd="sh_get_staff" tasktype="any_call" callback="ya.ru" timeout="120"> <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"> <ITEM rid="102" name="Маша" pin="45678" role="a43a6ac3-429c-4d8a-b1a7-ba2d50760456"/> <ITEM rid="103" name="Вася" pin="1234" role="a2967661-aa63-487d-9f45-0e3d6517f9a2"/> </RP>
Обратите внимание, что в 3.1.2 taskguid и 3.1.3 cmdguid совпадают.