GetRestaurantAgents
| Назначение | Получить список агентов, имеющих роли на ресторане |
|---|---|
| Тип запроса | Только синхронный |
| Поддерживаемая версия агента | Любая |
| PluggetSystemType | WhiteServer |
Формат запроса
{
"taskType": "GetRestaurantAgents",
"params": {
"sync": {
"objectId": number,
"timeout": number
}
}
}
JSON
Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| taskType | string | да | Тип задачи. Для данного метода — значение GetRestaurantAgents |
| params | да | Параметры запроса | |
| -sync | да | Синхронный метод | |
| --objectId | int | да | Код ресторана в системе лицензирования |
| --timeout | int | нет | Время ожидания ответа в секундах. По умолчанию — 120 секунд, максимум — 180 |
Формат ответа
{
"responseCommon":{
"taskGuid":"guid",
"taskType":"GetRestaurantAgents",
"objectId":0
},
"taskResponse":[
{
"version": string,
"isOnline": boolean,
"agentGuid": guid,
"roles":
[
string
]
}
],
"error":{
"wsError":{
"code":"string",
"desc":"string"
}
}
}
JSON
Параметр | Тип | Описание |
|---|---|---|
| -taskGuid | guid | Уникальный код этой задачи. Используется при получении задачи через очередь |
| -taskType | string enum | Тип задачи |
| -objectId | int | Код ресторана в системе лицензирования |
| taskResponse | массив | Массив зарегистрированных агентов |
| --version | string | Версия агента |
| --isOnline | boolean | Агент активен за последние 10 минут. Принимает значение true или false |
| --agentGuid | guid | Guid агента |
| --roles | массив | Список ролей агента на ресторане |
| error | Контейнер ошибок, подробнее читайте в статье Описание ошибок |
Пример запроса
{
"taskType": "GetRestaurantAgents",
"params": {
"sync": {
"objectId": 19999999
}
}
}
JSON
Пример ответа
{
"taskResponse": [
{
"version": "2.5.0.18",
"isOnline": true,
"agentGuid": "b922d5c8-a3a5-59ab-4cb3-ec51739b27a3",
"roles": [
"Plugin: 'Plugin_wsclient'",
"Sql: 'Sql_wsclient'; '19999999: 127.0.0.1&rkAgentTest2'",
"AgentInternal: 'AgentInternal_wsclient'",
"StoreHouse: 'StoreHouse_wsclient'",
"RKMid: 'RKMid_wsclient'",
"RKRef: 'RKRef_wsclient'"
]
},
{
"version": "2.4.1.1",
"isOnline": false,
"agentGuid": "b77ef27f-1325-4f56-bd86-08c274e12156",
"roles": [
"RKRef: 'EMRDP'; 'RKRef_wsclient'",
"RKMid: 'EMRDPKASS'; 'RKMid_wsclient'",
"Plugin: 'Plugin_wsclient'",
"Sql: 'Sql_wsclient'",
"AgentInternal: 'AgentInternal_wsclient'",
"StoreHouse: 'StoreHouse_wsclient'"
]
},
{
"version": "1.14.0.50",
"isOnline": false,
"agentGuid": "0beb9be6-0000-0000-0000-000000000000",
"roles": [
"RKMid",
"RKRef"
]
}
],
"responseCommon": {
"taskGuid": "fd601123-5c06-420b-b5bc-0cf3806705bd",
"taskType": "GetRestaurantAgents",
"objectId": 199990246
}
}
JSON