homepage.menu.refresh

Scope: homepage

Кто может вызывать: Авторизованный пользователь
Описание метода см. в разделе соответствующей подсистемы. Метод пересобирает список пунктов левого меню портала и приводит в соответствие с настройками блоков пункты блоков центра из /local (активный блок с menu, left_menu = true и без rights: пункт добавляется, иначе убирается, в том числе пункт блока с удалённым файлом); пункты встроенных блоков и пункты, добавленные вручную, не меняются. См. руководство по кастомным блокам, раздел 5.2.
HTTP: POST
Побочные эффекты: изменяет данные

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

Параметр Тип Обяз. Описание
siteId string нет Код сайта.

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

  • result - результат операции (object или true).
  • total, next - null.
  • error - null при успехе.

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
ACCESS_DENIED Недостаточно прав для вызова метода
VALIDATION_ERROR Некорректные или отсутствующие параметры запроса
INTERNAL_ERROR Внутренняя ошибка сервиса

Примеры кода

Пример запроса

curl -G "https://{portal}/rest/{user_id}/{webhook_code}/homepage.menu.refresh.json" \
          -H "Accept: application/json"
        

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

{
          "result": {
            "result": true,
            "next": null,
            "error": null
          },
          "total": null
        }
        

См. также

Предыдущая
Следующая