Описание
Назначение | Получить информацию по агенту, установленному в ресторане |
Тип запроса | Асинхронный/синхронный |
Поддерживаемая версия агента | v1, v2 |
PluggetSystemType | AgentInternal |
Формат запроса
{
"taskType": "GetAgentInfo",
"params": {
"async": {
"objectId": 0,
"timeout": 0
},
"sync": {
"objectId": number,
"agentGuid": guid,
"timeout": number
},
}
}
Описание параметров
Параметр | Тип | Обязательный | Описание |
---|
taskType |
| + | Тип задачи |
async |
|
| Асинхронный вызов метода (либо синхронный, либо асинхронный) |
sync |
|
| Синхронный вызов метода (либо синхронный, либо асинхронный) |
timeout | int | - | Время ожидания ответа от агента в секундах, по умолчанию 120 секунд |
objectId | int | - | Код ресторана в системе лицензирования. Если указан, запрос идет на агент с ролью rkMid |
agentGuid | guid | - | Guid агента. Если указан, запрос идет к конкретному агенту |
Формат ответа
{
"responseCommon":{
"taskGuid":"guid",
"taskType":"GetAgentInfo",
"objectId": 0
},
"error":{
"wsError":{
"code":"string",
"desc":"string"
}
}
}
Параметр | Тип | Описание |
---|
taskGuid | guid | Уникальный код этой задачи используется при получении задачи через очередь |
taskType | string enum | Тип задачи |
objectId | int | Код ресторана в системе лицензирования |
error |
| Контейнер ошибок, см Описание ошибок |
Формат асинхронного ответа
// Успешный ответ
{
"responseCommon":{
"taskGuid":"string",
"taskType":"GetAgentInfo",
"objectId":0
}
}
// Ответ с ошибкой
{
"responseCommon": {
"taskGuid": "string",
"taskType": "GetAgentInfo",
"objectId": 0
},
"error": {
"wsError": {
"code": "string",
"extCode": "string",
"desc": "string"
},
"agentError": {
"code": "string",
"desc": "string"
}
}
}
CODE