assessment360.responder.status.list

Scope: assessment360

Кто может вызывать: Авторизованный пользователь REST. Подробнее: Права доступа

Справочник статусов карточки респондента (enum свойства STATUS инфоблока респондентов).
Используется для фильтра filter.status / filter.respondersStatus и для properties.STATUS.xmlId в responder.* / task.*.

HTTP: GET

Побочные эффекты: none

Параметры метода

Параметр Тип Обяз. Описание
limit int нет Размер страницы, по умолчанию 50, максимум 500
offset int нет Смещение
fetchAll bool нет Вернуть все записи одним ответом (максимум 5000; при превышении — FETCH_ALL_LIMIT_EXCEEDED)
filter object нет Фильтр в mongo-style формате

Поля filter (Mongo)

Поддерживаемые поля элемента справочника: id, xmlId, value.

Форма ответа отличается от assessment360.assessment.status.list: там code/name, здесь xmlId/value.

Возвращаемые данные

Массив элементов справочника:

Поле Тип Описание
id int ID значения enum в инфоблоке
xmlId string xmlId статуса (то, что передаётся в filter.status)
value string Локализованное название

Типичные значения xmlId: waiting, filled, ignored, draft, failure (набор зависит от установки модуля).

Ответ в конверте модуля: result.result (массив), result.next, result.error, total.

Обработка ошибок

Справочник кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка сервера
INVALID_LIMIT Некорректное значение limit
INVALID_OFFSET Некорректное значение offset
INVALID_FILTER Некорректный фильтр
INVALID_FILTER_OPERATOR Неизвестный оператор фильтра

Пример запроса (GET)

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/assessment360.responder.status.list.json"
          -H "Accept: application/json"
          --data-urlencode "fetchAll=true"

Пример ответа

{
          "result": {
            "result": [
              { "id": 201, "xmlId": "waiting", "value": "Ожидает" },
              { "id": 202, "xmlId": "filled", "value": "Заполнена" },
              { "id": 203, "xmlId": "ignored", "value": "Пропущена" },
              { "id": 204, "xmlId": "draft", "value": "Черновик" },
              { "id": 205, "xmlId": "failure", "value": "Отказ" }
            ],
            "next": null,
            "error": null
          },
          "total": 5
        }

См. также

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