Описание

НазначениеПолучить информацию по агенту, установленному в ресторане
Тип запросаАсинхронный/синхронный
Поддерживаемая версия агентаv1, v2
PluggetSystemTypeAgentInternal

Формат запроса

{
  "taskType": "GetAgentInfo",
  "params": {
    "async": {
      "objectId": 0,
      "timeout": 0
},
"sync": {
"objectId": number,
"agentGuid": guid,
     "timeout": number
}, } }

Описание параметров

ПараметрТипОбязательныйОписание
taskType
+Тип задачи
async

Асинхронный вызов метода (либо синхронный, либо асинхронный)
sync

Синхронный вызов метода (либо синхронный, либо асинхронный)
timeoutint-Время ожидания ответа от агента в секундах, по умолчанию 120 секунд
objectIdint-Код ресторана в системе лицензирования. Если указан, запрос идет на агент с ролью rkMid
agentGuidguid-Guid агента. Если указан, запрос идет к конкретному агенту


Формат ответа

{  
   "responseCommon":{  
      "taskGuid":"guid",
      "taskType":"GetAgentInfo",
      "objectId": 0
   },
   "error":{  
      "wsError":{  
         "code":"string",
         "desc":"string"
      }
   }
}


ПараметрТипОписание
taskGuidguidУникальный код этой задачи используется при получении задачи через очередь
taskTypestring enumТип задачи
objectIdintКод ресторана в системе лицензирования
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
ПараметрТипОписание
errorstring enumКонтейнер ошибок, см Описание ошибок
taskResponseobjectСодержимое блока taskResponse можно посмотреть в статье Модель GetAgentInfo