Коды ошибок REST API модуля ithive.assessment360
Методы assessment360.* возвращают ошибки в конверте модуля внутри стандартной обёртки Bitrix REST.
Полный перечень кодов совпадает с ITHive\Assessment360\Rest\Constants. На страницах методов указаны только актуальные для конкретного endpoint коды — этот справочник содержит все коды модуля.
Формат ответа при ошибке
{
"result": {
"result": null,
"error": {
"code": "VALIDATION_ERROR",
"message": "Параметр id обязателен",
"details": {
"field": "id"
}
}
},
"time": {}
}
details опционален (часто field, id, status, allowed).
Общие коды
| Код | HTTP (ориентир) | Когда возникает |
|---|---|---|
UNAUTHORIZED |
401 | Пользователь не авторизован |
ACCESS_DENIED |
403 | Нет прав на операцию (общий запрет доступа) |
PERMISSION_DENIED |
403 | Нет прав на конкретную сущность/действие (карточка оценки, теги оценки и т.п.) |
VALIDATION_ERROR |
400 | Некорректные или неполные параметры |
NOT_FOUND |
404 | Сущность не найдена (общий код; для оценки/тега см. ниже) |
INVALID_LIMIT |
400 | limit вне диапазона 1..500 |
INVALID_OFFSET |
400 | offset < 0 |
INVALID_FILTER |
400 | Некорректный filter |
INVALID_FILTER_OPERATOR |
400 | Неизвестный оператор фильтра |
FETCH_ALL_LIMIT_EXCEEDED |
400 | При fetchAll=true подходящих записей больше 5000 |
INTERNAL_ERROR |
500 | Внутренняя ошибка сервера |
Разница ACCESS_DENIED и PERMISSION_DENIED: оба означают запрет; в модуле для операций с карточкой оценки и тегами оценки чаще используется PERMISSION_DENIED, для экспорта/удаления респондента и части справочников — ACCESS_DENIED.
Коды сущностей оценки
| Код | HTTP (ориентир) | Когда возникает |
|---|---|---|
ASSESSMENT_NOT_FOUND |
404 | Карточка оценки не найдена |
ASSESSMENT_WRONG_STATUS |
400 | Операция недопустима для текущего статуса оценки |
NO_COMPETENCIES |
400 | Нет компетенций для операции (зарезервирован в API) |
NO_RESPONDERS |
400 | Нет респондентов для операции (зарезервирован в API) |
TAG_NOT_FOUND |
404 | Тег не найден (или недоступен текущему пользователю) |
TAG_ALREADY_EXISTS |
400 | Тег с таким именем уже есть у текущего пользователя для данного assessmentId |
Типичные методы:
assessment.get/assessment.start/approve/finish/completeCollection/updateDateEnd/tags.*→ASSESSMENT_NOT_FOUND,PERMISSION_DENIED, при смене статуса →ASSESSMENT_WRONG_STATUStag.get/tag.update/tag.delete→TAG_NOT_FOUNDtag.add/tag.update(сassessmentId) →PERMISSION_DENIEDtag.add/tag.update(дубликат имени) →TAG_ALREADY_EXISTS
Batch-коды
| Код | HTTP (ориентир) | Когда возникает |
|---|---|---|
BATCH_LIMIT_EXCEEDED |
400 | В calls больше 50 вызовов |
BATCH_INVALID_CALL |
400 | Элемент calls[] имеет неверный формат |
BATCH_RECURSIVE_NOT_ALLOWED |
400 | Вложенный assessment360.batch запрещён |
METHOD_NOT_FOUND |
404 | Метод не зарегистрирован |
Экспорт
| Код | Когда возникает |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
ACCESS_DENIED |
Нет прав на экспорт результатов |
VALIDATION_ERROR |
Некорректные format / dataset / columns, экспорт ещё не завершён и т.п. |
INTERNAL_ERROR |
Внутренняя ошибка сервера |
См. также
Предыдущая
Следующая