GetAgentInfo

Описание

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

ФОРМАТ ЗАПРОСА

ФОРМАТ ЗАПРОСА

Запрос

{
  "taskType": "GetAgentInfo",
  "params": {
    "sync": {
      "objectId": number,
      "timeout": number
    },
  }
}

CODE

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
taskType	string	+	Тип задачи
sync			Синхронный вызов метода (либо синхронный, либо асинхронный. Для этого изменить на "async")	120 секунд
timeout	int	-	Время ожидания ответа от агента в секундах, по умолчанию 120 секунд
objectId	int	-	Код ресторана в системе лицензирования, если указан, запрос идет на агент с ролью rkMid

ФОРМАТ ОТВЕТА

ФОРМАТ ОТВЕТА

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

{
    "taskResponse":{
     // Содержимое блока taskResponse можно посмотреть здесь: https://docs.rkeeper.ru/ws/model-getagentinfo-83198011.html     },
   "responseCommon":{
      "taskGuid":"string",
      "taskType":"GetAgentInfo",
      "objectId":0
   }
}

CODE

Ответ с ошибкой. Ошибка агента или сервера

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

CODE

Параметр

Тип

Описание

taskResponse

object

Содержимое блока taskResponse можно посмотреть здесь: GetAgentInfo - модель

taskType

string enum

Тип задачи

objectId

int

Код ресторана в системе лицензирования

error

object

Контейнер ошибок, см Описание ошибок

wsError		Ошибка от сервера
agentError		Ошибка от агента

ПРИМЕРЫ СТРУКТУРЫ ЗАПРОСОВ

ПРИМЕРЫ СТРУКТУРЫ ЗАПРОСОВ

{
  "taskType": "GetAgentInfo",
  "params": {
    "sync": {
      "objectId": 199990232,
      "timeout": 120
    }
  }
}

{
  "taskResponse": {
    "healthState": {
      "workingMemorySetMb": 553,
      "availableFreeDiskSpaceGb": 2.5,
      "dataFolderSizeMb": 0
    },
    "agentCommon": {
      "agentVersion": "2.12.6.1",
      "agentChangedAt": "2026-04-30T09:59:08+03:00",
      "monitorVersion": "2.12.6.1",
      "monitorChangedAt": "2026-04-30T09:59:06+03:00",
      "workingDirectory": "C:\\Program Files (x86)\\UCS\\Агент WhiteServer\\WsAgent"
    },
    "pluggedSystems": [
      {
        "name": "R-Keeper cash server. Connection: RK Http: Ok; Tcp: Ok",
        "instanceName": "SKAUTOSERV123",
        "version": "7.26.04.27",
        "objectIdList": [
          199990232
        ],
        "isAvailable": true
      },
      {
        "name": "R-Keeper reference server. Connection: RK Http: Ok; Tcp: Ok",
        "instanceName": "CHEETOS2020",
        "version": "7.26.04.27",
        "objectIdList": [
          199990232
        ],
        "isAvailable": true
      },
      {
        "name": "SQL server. Connection: SQL",
        "instanceName": "199990232: 192.168.0.1\\INT&RK7",
        "version": "Microsoft SQL Server 2014 - 12.0.2000.8 (Intel X86)  \tFeb 20 2014 19:20:46  \tCopyright (c) Microsoft Corporation \tExpress Edition on Windows NT 6.3 <X64> (Build 19045: ) (WOW64) (Hypervisor) ",
        "objectIdList": [
          199990232
        ],
        "isAvailable": true
      },
      {
        "name": "Store House 5. Connection: SH",
        "instanceName": "http://192.168.0.1:9797/",
        "version": "3.0",
        "objectIdList": [
          199990377,
          199990232,
          199990236
        ],
        "isAvailable": true
      }
    ]
  },
  "responseCommon": {
    "taskGuid": "b93591db-9b4f-4f6d-8231-a7b67f3bb1bc",
    "taskType": "GetAgentInfo",
    "objectId": 199990232,
    "agentGuid": "62225260-c097-4c75-abef-106c7207f9ff"
  }
}

{
    "responseCommon": {
        "taskGuid": "f7bc9a23-9bbb-4c13-9c1f-43610d6b8bc9",
        "taskType": "GetAgentInfo",
        "objectId": 199996354
    },
    "error": {
        "wsError": {
            "code": "License",
            "desc": "Task GetAgentInfo unavailable from 392110001 to 199996354:\nWsProduct license not found"
        }
    }
}