polls.vote.channel.delete

Scope: polls

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

Удаление группы опросов (канала). Опросы группы не удаляются — как в интерфейсе, они переносятся в системную группу «Без группы».

HTTP: POST

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

  • переносит опросы группы в системную группу «Без группы» (символьный код POLLS_UNGROUPED); если её нет — создаёт её и делает видимой на сайтах удаляемой группы. Если системную группу создать не удалось, опросы отвязываются от группы, но не удаляются;
  • удаляет канал опросов;
  • удаляет символьный код из настройки «Отображаемые группы опросов» (visible_channels) сайтов группы; если код группы был в списке групп «Пульс» (impulse_channel_name) этих сайтов — он удаляется из списка, остальные группы «Пульс» остаются;
  • сбрасывает кеш списка каналов.

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

Параметр Тип Обяз. Описание
id int да ID группы

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

Ответ в конверте модуля: result.result — { id, movedPolls, targetChannelId }; result.error.

Поле Тип Описание
id int ID удалённой группы
movedPolls int Сколько опросов перенесено
targetChannelId int ID группы «Без группы», куда перенесены опросы (0 — опросы отвязаны от группы)

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка сервера
ACCESS_DENIED Пользователь не администратор модуля; группа привязана к нескольким сайтам или не к текущему сайту, а пользователь не полный администратор (details.reason=LOCKED); системная группа «Без группы» (details.reason=SYSTEM_CHANNEL)
NOT_FOUND Группа не найдена
VALIDATION_ERROR Не передан id; ядро не смогло удалить канал (details.reason=DELETE_FAILED)

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

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/polls.vote.channel.delete.json" \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
          "id": 12
        }'

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

{
          "result": {
            "result": {
              "id": 12,
              "movedPolls": 3,
              "targetChannelId": 7
            },
            "error": null
          }
        }

См. также

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