homepage.widgets.list

Scope: homepage

Кто может вызывать: Авторизованный пользователь
Описание метода см. в разделе соответствующей подсистемы.
HTTP: GET
Побочные эффекты: нет

Локальные блоки (source = local), скрытые от текущего пользователя правилами rights, в списке не возвращаются; встроенные блоки и HTML-виджеты возвращаются без изменений.

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

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

• result - массив элементов текущей страницы. Поля элемента: id, name, block, zone, source, title, active, sort, siteId, для HTML-виджетов также isCustom.
  • block и zone - зона виджета (center или right), значения совпадают.
  • source - источник: builtin (встроенный блок), local (локальный блок из файла /local/ithive.homepage/blocks/center_block/<code>.php или right_block/<code>.php), settings (HTML-виджет или запись без блока в реестре, например блок, файл которого удалён).
• total - общее количество записей по фильтру.
• next - смещение следующей страницы или null.
• error - null при успехе.

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

Примеры кодаПримеры кода

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

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

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

{
          "result": {
            "result": [
              {
                "id": 10,
                "name": "leader_sales",
                "block": "center",
                "zone": "center",
                "source": "builtin",
                "title": "Лидеры продаж",
                "active": true,
                "sort": 100,
                "siteId": "s1"
              }
            ],
            "next": null,
            "error": null
          },
          "total": 1
        }
        

См. такжеСм. также

• Обзор раздела
• Коды ошибок API