Формат ответа API Топвизор
Формат ответа (JSON)
Формат
getFormat=json_pager используется по умолчанию.
Тип запроса |
Описание |
Пример результата |
oper=get |
Запрос на получение данных |
[результат_1, ..., результат_N]
Тип результатов зависит от запрашиваемого метода (число, строка, массив или объект)
В случае ошибки ответ будет следующим:
{
message: "", // текст ошибки
error: true // флаг ошибки
}
|
oper=add |
Добавление объекта |
{
result: 1, // число добавленных элементов, в некоторых
методах возвращает id добавленного элемента
message: "", // сообщение для пользователя (обычно пусто),
при ошибке - текст ошибки
error: false // Флаг ошибки [true|false]
}
|
oper=edit |
Редактирование элемента / вызов действия |
{
result: 1, // число измененных элементов
// в некоторых методах возвращает id измененного элемента
// в некоторых методах возвращает массив id измененных элементов
message: "", // сообщение для пользователя (обычно пусто),
при ошибке - текст ошибки
error: false // флаг ошибки [true|false]
}
|