| Назначение | Получить настройки агента (доступ к методу ограничен) |
|---|
| Тип запроса | Синхронный |
|---|
| Поддерживаемая версия агента | v2 |
|---|
| PluggetSystemType | AgentInternal |
|---|
Формат запроса
{
"taskType": "ServiceGetAgentSettings",
"params": {
"sync": {
"objectId": number,
"timeout": number
}
}
}
JSON
| Параметр | Тип | Обязательный | Описание |
|---|
| taskType | string | да | Тип задачи. Для данного метода — значение ServiceGetAgentSettings |
| -sync |
|
| Синхронный вызов метода: либо синхронный, либо асинхронный |
| --timeout | int | нет | Время ожидания ответа от агента в секундах. По умолчанию — 120 секунд |
| --objectId | int | да | Код ресторана в системе лицензирования |
Формат ответа
Успешный ответ
{
"responseCommon":{
"taskGuid":"guid",
"taskType":"ServicePushAgentSettings",
"objectId":0
},
"taskResponse":{
"settings":{
}
},
"error":{
"wsError":{
"code":"string",
"desc":"string"
}
}
}
JSON
Параметр | Тип | Описание |
|---|
| -taskGuid | guid | Уникальный код этой задачи. Используется при получении задачи через очередь |
| -taskType | string enum | Тип задачи |
| -objectId | int | Код ресторана в системе лицензирования |
| -settings | object | Настройки агента в виде json объекта |
| error |
| Контейнер ошибок, подробнее читайте в статье Описание ошибок |
Ответ с ошибкой доступа
{
"responseCommon": {
"taskGuid": "34398dc7-5488-49d1-a499-fef9e8826f40",
"taskType": "ServiceGetAgentSettings",
"objectId": 199995826
},
"error": {
"wsError": {
"code": "AuthFailed"
}
}
}
JSON