polls.vote.getRequired

Scope: polls

Кто может вызывать: Список обязательных открытых опросов для текущего пользователя. Подробнее: Права доступа

Обязательные открытые опросы текущего пользователя только из группы «Пульс-опросы» (канал impulse_channel_name в настройках модуля) — аналог UI-виджета «Пульс опросы».

HTTP: GET

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

Для list-методов Bitrix REST выносит total и next на верхний уровень ответа (рядом с result). Внутри конверта модуля — только result и error.

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

Параметр Тип Обяз. Описание
limit int нет Размер страницы, по умолчанию 50, максимум 500
offset int нет Смещение, по умолчанию 0
fetchAll bool нет Вернуть все записи одним ответом (лимит rest_fetch_all_max, по умолчанию 5000)

Пагинация

limit (по умолчанию 50, максимум 500), offset (по умолчанию 0), fetchAll (защитный лимит записей из настройки модуля, по умолчанию 5000; при превышении — FETCH_ALL_LIMIT_EXCEEDED).

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

Ответ в конверте модуля: result.result — массив обязательных открытых опросов для текущего пользователя (поля как в polls.vote.list); result.error; result.next — смещение следующей страницы или null; верхнеуровневый Bitrix total — общее число записей.

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

Справочник кодов: Коды ошибок.

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка сервера
ACCESS_DENIED Нет прав на операцию
INVALID_LIMIT limit вне диапазона 1..500
INVALID_OFFSET offset < 0
FETCH_ALL_LIMIT_EXCEEDED При fetchAll=true записей больше защитного лимита

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

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/polls.vote.getRequired.json" \
          -H "Accept: application/json" \
          --data-urlencode "limit=50"

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

{
          "result": {
            "result": [
              {
                "id": 12,
                "title": "Удовлетворенность работой",
                "description": "",
                "dateStart": "2026-08-21 15:00:00",
                "dateEnd": "2026-09-21 18:00:00",
                "active": "Y",
                "channel": 7,
                "counter": 0,
                "author": 1,
                "state": "CURRENT"
              },
              {
                "id": 13,
                "title": "Обратная связь от руководства",
                "description": "",
                "dateStart": "2026-08-21 15:00:00",
                "dateEnd": "2026-09-21 18:00:00",
                "active": "Y",
                "channel": 7,
                "counter": 0,
                "author": 1,
                "state": "CURRENT"
              },
              {
                "_truncated": "... ещё 2 элементов"
              }
            ],
            "error": null
          },
          "total": 4,
          "time": {
            "start": 1787319171,
            "finish": 1787319171.735945,
            "duration": 0.7359449863433838,
            "processing": 0,
            "date_start": "2026-08-21T16:32:51+03:00",
            "date_finish": "2026-08-21T16:32:51+03:00"
          }
        }
Предыдущая
vote.get
Следующая
vote.list