ServicePushAgentSettings

Последнее изменение статьи: 19.06.2026 09:40

Назначение	Отправить агенту новые настройки. Доступ к методу ограничен
PluggetSystemType	AgentInternal

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

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

{
  "taskType": "ServicePushAgentSettings",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
    "settings":{}
  }
}

JSON

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

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

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

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

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

JSON

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

{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "ServicePushAgentSettings",
    "objectId": number
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}

JSON

Параметр

Тип

Описание

taskResponse

object

Содержимое блока taskResponse можно увидеть в статье

responseCommon

object

Информация по задаче

taskGuid

guid

Уникальный код этой задачи используется при получении задачи через очередь

taskType

string

Тип задачи

objectId

int

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

error

object

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

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

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

Примеры структуры запросов

{
  "taskType": "ServicePushAgentSettings",
  "params": {
    "settings": {
      "RKeeper": {
        "OrderCreationPreferences": {
          "DefaultCashierId": 9012,
          "DefaultTableCode": 5,
          "CurrencyCode": 1,
          "DefaultStationId": 15006,
          "TradeGroupId": 7,
          "OrderTypeCode": 4,
          "OrderCategoryCode": 2,
          "PriceTypeId": 3,
          "VoidingReasonCode": 7,
          "CashierTimeoutSec": 0,
          "ConfirmOrderIfIgnoredOnKass": true,
          "CreateOrdersAsDeffered": false,
          "GuestTypeId": 1,
          "UseGetOrderMenuOnly": true
        }
      },
      "whiteServer": {
        "httpParameters": {
          "alterAddresses": []
        }
      },
      "Metrics": {
        "Delay": 3600
      }
    },
    "licenseInfo": {
      "objectId": 199996011,
      "expirationDate": "2100-01-01T00:00:00+03:00"
    }
  }
}

{
  "taskResponse": {
    "healthState": {
      "workingMemorySetMb": 134,
      "availableFreeDiskSpaceGb": 4.2,
      "dataFolderSizeMb": 1459
    },
    "agentCommon": {
      "agentVersion": "2.12.2.3",
      "agentChangedAt": "2026-01-23T18:08:16+03:00",
      "monitorVersion": "2.12.2.3",
      "monitorChangedAt": "2026-01-23T18:08:14+03:00",
      "workingDirectory": "C:\\Program Files (x86)\\UCS\\WhiteServer Agent\\WsAgent"
    },
    "pluggedSystems": [
      {
        "name": "R-Keeper cash server. Connection: RK Http: Ok; Tcp: Ok",
        "instanceName": "TEST22_MIDSERVER",
        "version": "7.26.1.2001",
        "objectIdList": [
          199996011
        ],
        "isAvailable": true
      },
      {
        "name": "R-Keeper reference server. Connection: RK Http: Ok; Tcp: Ok",
        "instanceName": "TEST22_RK7SRV",
        "version": "7.26.1.2001",
        "objectIdList": [
          199996011
        ],
        "isAvailable": true
      },
      {
        "name": "SQL server. Connection: None",
        "instanceName": "",
        "connectionError": "Свойство ConnectionString не инициализировано.",
        "isAvailable": false
      },
      {
        "name": "Store House 5. Connection: None",
        "instanceName": "http://127.0.0.1:9797/",
        "connectionError": "Ошибка HTTP: Подключение не установлено, т.к. конечный компьютер отверг запрос на подключение. (127.0.0.1:9797)",
        "isAvailable": false
      }
    ]
  },
  "responseCommon": {
    "taskGuid": "f3352dd5-fafd-40b7-b75d-44f0506b35e7",
    "taskType": "ServicePushAgentSettings",
    "agentGuid": "c415aa96-8952-4689-8fcb-c6c969e25aad"
  }
}

{
  "responseCommon": {
    "taskGuid": "34398dc7-5488-49d1-a499-fef9e8826f40",
    "taskType": "ServicePushAgentSettings",
    "objectId": 199995826
  },
  "error": {
    "wsError": {
      "code": "AuthFailed"
    }
  }
}