Коды ошибок REST API модуля ithive.hints

Методы hints.* возвращают ошибки в конверте модуля внутри стандартной обёртки Bitrix REST.

Полный перечень совпадает с Ithive\Hints\Rest\Constants. На страницах методов указаны только релевантные коды.

Формат ответа при ошибке

{
          "result": {
            "result": null,
            "error": {
              "code": "VALIDATION_ERROR",
              "message": "Параметр id обязателен",
              "details": {
                "field": "id"
              }
            }
          },
          "time": {}
        }

details опционален (field, fields, allowed, id сущности и т.д.).

Общие коды

Код HTTP (ориентир) Когда возникает
UNAUTHORIZED 401 Пользователь не авторизован
MODULE_DISABLED 400 Модуль выключен (switchOn != Y); не возвращается для hints.config.update
ACCESS_DENIED 403 Нет права чтения (R/W) при включённом модуле
PERMISSION_DENIED 403 Нет права записи (W) или запрещённое действие (например, skip для чужого userId)
VALIDATION_ERROR 400 Некорректные или неполные параметры (в т.ч. неверный формат URL страницы)
NOT_FOUND 404 Сайт не найден (hints.config.get)
INVALID_LIMIT 400 limit вне диапазона 1..500
INVALID_OFFSET 400 offset < 0
INVALID_FILTER 400 Некорректный filter, неизвестное поле (details.allowed)
INVALID_FILTER_OPERATOR 400 Неизвестный оператор фильтра
FETCH_ALL_LIMIT_EXCEEDED 400 При fetchAll=true записей больше защитного лимита (5000)
INTERNAL_ERROR 500 Внутренняя ошибка сервера

Коды сущностей

Код HTTP (ориентир) Когда возникает
PAGE_NOT_FOUND 404 Страница (секция инфоблока) не найдена
HINT_NOT_FOUND 404 Подсказка (элемент) не найдена
PAGE_DUPLICATE_URL 400 Страница с таким URL уже существует (hints.page.add, hints.page.update)

См. также

Предыдущая
Обзор
Следующая
Обзор раздела