polls.vote.channel.get

Scope: polls

Кто может вызывать: Авторизованный пользователь. Администратор модуля видит любую группу; остальные — только группы, которые возвращает polls.vote.channel.list: код группы есть в «Отображаемых группах опросов» или в группах «Пульс» текущего сайта и группа привязана к этому сайту; для прочих — NOT_FOUND. Подробнее: Права доступа

Группа опросов (канал) по ID или символьному коду.

HTTP: GET

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

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

Параметр Тип Обяз. Описание
id int нет* ID группы (alias channelId)
symbolicName string нет* Символьный код группы; используется, если id не передан

* Нужен id или symbolicName.

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

Ответ в конверте модуля: result.result — объект группы; result.error.

Поле Тип Описание
id int ID группы
title string Название
active string Y/N
sites string Коды сайтов через запятую (как в polls.vote.channel.list)
siteIds array Коды сайтов списком
symbolicName string Символьный код (верхний регистр)
sort int Сортировка
voteSingle bool В группе может быть только один текущий опрос
visible bool Группа в настройке «Отображаемые группы опросов» текущего сайта
pulse bool Код группы входит в список групп «Пульс» текущего сайта (настройка impulse_channel_name, множественный выбор; если она пуста — используется группа с кодом VOTE_VOTE)
pollCount int Число опросов в группе

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка сервера
NOT_FOUND Группа не найдена или недоступна пользователю
VALIDATION_ERROR Не передан ни id, ни symbolicName

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

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

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

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

См. также

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