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

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

Полный перечень кодов совпадает с Ithive\Helpdesk\Rest\Constants. На страницах методов указаны только актуальные для конкретного endpoint коды — этот справочник содержит все коды модуля.

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

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

details опционален (часто field, allowed, id, ticketId).

Общие коды

Код HTTP (ориентир) Когда возникает
UNAUTHORIZED 401 Пользователь не авторизован
FORBIDDEN 403 Операция запрещена (например, наблюдатель пытается изменить обращение)
ACCESS_DENIED 403 Нет доступа к обращению или сообщению
PERMISSION_DENIED 403 Нет прав на конкретное действие (удаление, смена статуса, назначение)
VALIDATION_ERROR 400 Некорректные или неполные параметры, ошибка сохранения
INVALID_ID 400 Обязательный числовой id отсутствует или ≤ 0
NOT_FOUND 404 Сущность не найдена (общий код)
INVALID_LIMIT 400 limit < 1
LIMIT_TOO_LARGE 400 limit > 500
INVALID_OFFSET 400 offset < 0
INVALID_FILTER 400 Некорректный filter или неизвестное поле
INVALID_FILTER_OPERATOR 400 Неизвестный оператор фильтра
FETCHALL_LIMIT_EXCEEDED 400 При fetchAll=true подходящих записей больше 5000
SEARCH_TOO_SHORT 400 Поисковый запрос короче 3 символов
INTERNAL 500 Внутренняя ошибка сервера
METHOD_NOT_FOUND 404 Метод не найден

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

Код HTTP (ориентир) Когда возникает
TICKET_NOT_FOUND 404 Обращение не найдено
MESSAGE_NOT_FOUND 404 Сообщение не найдено
CATEGORY_NOT_FOUND 404 Категория не найдена
OBSERVER_NOT_FOUND 404 Наблюдатель не привязан к обращению

См. также

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