polls.vote.channel.add

Scope: polls

Кто может вызывать: Администратор модуля «Опросы» (администратор портала или право W на модуль vote) — как управление группами в публичной части. Подробнее: Права доступа

Создание группы опросов (канала). Группа создаётся так же, как в слайдере «Группы опросов» публичной части.

HTTP: POST

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

  • создаёт канал опросов (CVoteChannel) с привязкой к сайтам;
  • выдаёт всем авторизованным пользователям (группа 2) право 4 на канал — без него опросы группы не видны;
  • при visible=Y (по умолчанию) добавляет символьный код в настройку «Отображаемые группы опросов» (visible_channels) каждого сайта группы — группа появляется на странице опросов;
  • сбрасывает кеш списка каналов.

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

Параметр Тип Обяз. Описание
title string да Название группы. Допустимы буквы, цифры, пробел и символы - _ . , ( ) № : ; ! ? — как в интерфейсе
symbolicName string нет Символьный код: латинские буквы, цифры, _ (дефисы удаляются, регистр приводится к верхнему). Должен быть уникальным. Если не передан — формируется из названия транслитерацией, как в интерфейсе; при совпадении добавляется суффикс _2, _3…
active string нет Y/N или bool, по умолчанию Y
voteSingle string нет Y/N или bool: в группе может быть только один текущий опрос. По умолчанию N
sort int нет Сортировка (≥ 0). По умолчанию — максимальная сортировка групп текущего сайта + 100
siteIds array нет Коды сайтов (LID), alias sites. Учитывается только для полного администратора портала (группа 1); для остальных и при пустом значении — текущий сайт
visible string нет Y/N или bool: показывать группу на странице опросов (visible_channels). По умолчанию Y
fields object нет Необязательная обёртка с теми же полями

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

Ответ в конверте модуля: result.result — созданная группа в формате polls.vote.channel.get; result.error.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка сервера
ACCESS_DENIED Пользователь не администратор модуля
VALIDATION_ERROR Не передан title; недопустимые символы в title; некорректный symbolicName, флаг, sort или siteIds; неизвестный или неактивный сайт. В details.reason — причина (TITLE_REQUIRED, TITLE_INVALID, SYMBOLIC_NAME_INVALID, SITE_INVALID, SAVE_FAILED), в details.field — поле
ALREADY_EXISTS Группа с таким symbolicName уже существует; details.id — её ID

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/polls.vote.channel.add.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
          "title": "Опросы для новых сотрудников",
          "symbolicName": "ONBOARDING",
          "voteSingle": "N"
        }'

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

{
          "result": {
            "result": {
              "id": 12,
              "title": "Опросы для новых сотрудников",
              "active": "Y",
              "sites": "s1",
              "siteIds": ["s1"],
              "symbolicName": "ONBOARDING",
              "sort": 600,
              "voteSingle": false,
              "visible": true,
              "pulse": false,
              "pollCount": 0
            },
            "error": null
          }
        }

См. также

Предыдущая
vote.add
Следующая
vote.channel.delete