homepage.blocks.get

Scope: homepage

Кто может вызывать: Авторизованный пользователь, которому блок доступен по rights

Возвращает один блок главной по коду и зоне. Формат ответа совпадает с элементом homepage.blocks.list. Права проверяются по эффективным rights из настроек сайта. Новый локальный блок из /local возвращается с active = false, пока его не включили (update с {"active": true} или галочка в «Настроить Главную»).

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

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

Параметр Тип Обяз. Описание
code string да Код блока.
zone string да Зона: center или right.
siteId string нет Код сайта; по умолчанию текущий.

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
ACCESS_DENIED Блок недоступен пользователю по rights (в том числе администратору, который не проходит правила rights блока)
NOT_FOUND Блок с таким code не найден в зоне zone (для локального блока - файл не выгружен в /local)
VALIDATION_ERROR Не передан code/zone или zone не center/right
INTERNAL_ERROR Внутренняя ошибка сервиса

Примеры кода

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

curl -G "https://{portal}/rest/{user_id}/{webhook_code}/homepage.blocks.get.json" \
          --data-urlencode "code=acme_links" \
          --data-urlencode "zone=right" \
          -H "Accept: application/json"

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

{
          "result": {
            "result": {
              "code": "acme_links",
              "zone": "right",
              "source": "local",
              "title": "Полезные ссылки",
              "sort": 300,
              "defaultSort": 500,
              "active": true,
              "siteId": "s1",
              "rights": {"admin": false, "groups": []},
              "mobile": {"type": "none", "url": "", "dataMethod": ""},
              "menu": null,
              "left_menu": false
            },
            "next": null,
            "error": null
          },
          "total": null
        }

См. также

Предыдущая
homepage.blocks.list
Следующая
homepage.blocks.update