GetRestaurantSystems
Назначение | Получить список подключенных на ресторане систем |
---|---|
Тип запроса | Только синхронный |
Поддерживаемая версия агента | Все |
PluggetSystemType | WhiteServer |
Формат запроса
{
"taskType": "GetRestaurantSystems",
"params": {
"sync": {
"objectId": number,
"timeout": number
}
}
}
JSON
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
taskType | string | да | Тип задачи, для данного метода — значение GetRestaurantSystems |
params | да | Параметры запроса | |
-sync | да | Синхронный метод | |
--objectId | int | да | Код ресторана в системе лицензирования |
--timeout | int | нет | Время ожидания ответа в секундах. По умолчанию — 120, максимум — 180 |
Формат ответа
{
"responseCommon":{
"taskGuid":"guid",
"taskType":"GetRestaurantSystems",
"objectId":0
},
"taskResponse":[
{
"name": "string",
"type": "string"
}
],
"error":{
"wsError":{
"code":"string",
"desc":"string"
}
}
}
JSON
Параметр | Тип | Описание |
---|---|---|
-taskGuid | guid | Уникальный код этой задачи. Используется при получении задачи через очередь |
-taskType | string enum | Тип задачи |
-objectId | int | Код ресторана в системе лицензирования |
taskResponse | массив | Массив подключенных систем |
--name | string | Наименование системы |
--type | string | Тип системы PluggetSystemType. PluggetSystemType — типы поддерживаемых систем, добавляются к agentGuid. Связывают agentGuid, objectId, тип системы. Тип подключенной системы принимает значения:
|
error | Контейнер ошибок, подробнее читайте в статье Описание ошибок |
Если в name указано значение *_wsclient, то это старые роли, которые выдаются по лицензии wsclient. Их можно игнорировать. Эти роли фиксированы в виде [Тип_системы]_wsclient. При тихой установке их нет, но если агент использует лицензию wsclient, то эти роли присваиваются агенту для совместимости.
В расширенной маршрутизации *_wsclient лучше не указывать. Поэтому в systemName лучше оставить null.
Пример запроса
{
"taskType": "GetRestaurantSystems",
"params": {
"sync": {
"objectId": 199990246
}
}
}
JSON
Пример ответа
{
"taskResponse": [
{
"name": "AgentInternal_wsclient",
"type": "AgentInternal"
},
{
"name": "Plugin_wsclient",
"type": "Plugin"
},
{
"name": "EMRDPKASS",
"type": "RKMid"
},
{
"name": "RKMid_wsclient",
"type": "RKMid"
},
{
"name": "EMRDP",
"type": "RKRef"
},
{
"name": "RKRef_wsclient",
"type": "RKRef"
},
{
"name": "199990246: 127.0.0.1&rkAgentTest2",
"type": "Sql"
},
{
"name": "Sql_wsclient",
"type": "Sql"
},
{
"name": "StoreHouse_wsclient",
"type": "StoreHouse"
}
],
"responseCommon": {
"taskGuid": "0c5229fe-86ef-4a1f-8c79-6b6ccdd33d84",
"taskType": "GetRestaurantSystems",
"objectId": 199990246
}
}
JSON