AstraRegul
Релиз 2025.08.15.00
×

3.12.5.3.1. Общий формат запросов и ответов

Общий вид JSON-строки, содержащей запрос:
{
// Объект, которому адресован запрос
"object": "TARGET_OBJECT",
 
// Команда, которая направляется объекту
"command": "OBJECT_COMMAND",
 
// Опциональный блок специфичных для объекта/команды параметров
"params": {
...
}
}
 
Общий вид JSON-строки, содержащей ответ:
{
     // Опциональное поле, содержащее описание ошибки, если выполнение запроса было неуспешным
     "error": "ERROR_DESCRIPTION",
    
     // Опциональное поле, содержащее предупредительное сообщение
     "warning": "WARN_MESSAGE",
    
     // Опциональное поле, содержащее подсказку
     "hint": "HINT_MESSAGE",
    
     // Опциональный блок синхронного результата. Содержимое специфично для объекта/команды, указанных в запросе
     "result":
     {
     ...
     }
}
Если командой не предусмотрен возврат результата (ни синхронного, ни множественного), и команда успешно выполнена, то ответ может содержать пустую строку или пустой JSON-объект.