homepage.widgets.list

Scope: homepage

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

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

Параметр Тип Обяз. Описание
siteId string нет Код сайта.
filter object нет Mongo-фильтр.
limit int нет Размер страницы.
offset int нет Смещение.
fetchAll bool нет Вернуть все страницы.

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

  • result - массив элементов текущей страницы.
  • total - общее количество записей по фильтру.
  • next - смещение следующей страницы или null.
  • error - null при успехе.

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

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

Примеры кода

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

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",
                "title": "Лидеры продаж",
                "active": true,
                "sort": 100,
                "siteId": "s1"
              }
            ],
            "next": null,
            "error": null
          },
          "total": 1
        }

См. также

Предыдущая
Обзор раздела
Следующая
homepage.widgets.get