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

Примечания:

  • У агрегатора должна быть лицензия WSServer, иначе вернется соответствующая ошибка
    Токен требуется для авторизации агрегатора:
    • В API v1 токен передается агрегатору. Агрегатор использует его при формировании запроса к WS

    • В API v2 нет необходимости передавать токен. В течение часа новая лицензия появится на сервере WS автоматически.
      Если лицензии нет или она истекла, то возвращается ошибка:

      {
        "error": {
          "wsError": {
            "code": "AuthFailed"
          }
        }
      }
      JSON
  • Список агентов формируется из агентов 1 и 2 версии. Если агент не был подключен к серверу, то он не появится в списке
  • В списке агентов отображаются только агенты доступные агрегатору, то есть с активной лицензией WsProduct и не просроченной датой
  • В списке агентов отображаются в том числе и объекты с просроченными лицензиями WsClient. Дата licenseExpirationDate для них будет просрочена
  • В списке агентов отображаются только агенты v2, для которых выбрана роль Выполняет команды от агрегаторов.

Если агент v2 ранее был подключен к серверу, данные будут выданы по нему независимо от того, работает старый агент v1 или нет.

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

{
  "taskType": "GetAgentList"
}
JSON

Параметр

Тип

Обязательный

Описание

taskTypestringдаТип задачи, для данного метода значение ExecuteRk7Query

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

Успешный ответ

{
    "taskResponse":{
        "agents":[
          {
            "objectId":0,
            "version":"string",
            "isOnline": "true",
            "licenseExpirationDate": "2019-28-T15:00:00+03:00",
            "rkVersion": "7.6.225"
          }
        ],
   "responseCommon":{
      "taskGuid":"string",
      "taskType":"GetAgentList"
   }
}
JSON

Параметр

Тип параметра

Обязательный

Описание

-agentsarray
Массив агентов
--objectIdintдаКод ресторана в системе лицензирования
--versionstring

Версия агента

--isOnlineboolean
Активность агента
--licenseExpirationDatestring

Дата окончания лицензии агента — WsClient в системе лицензирования

--rkVersionstring
Версия r_keeper mid. Только для агента v2

Ответ с ошибкой

{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "GetAgentList"
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    }
  }
}
JSON

Параметр

Тип параметра

Обязательный

Описание

errorstring enum
Контейнер ошибок, подробнее читайте в статье Описание ошибок