homepage.content.list

Scope: homepage

Кто может вызывать: Авторизованный пользователь

Список элементов выбранного инфоблока типа ithive_content_homepage.

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

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

Параметр Тип Обяз. Описание
iblockId int да Идентификатор инфоблока типа ithive_content_homepage.
filter object нет Mongo-фильтр по полям элемента.
limit int нет Размер страницы (по умолчанию 50).
offset int нет Смещение (по умолчанию 0).

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

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
ACCESS_DENIED Нет прав на чтение инфоблока
INVALID_IBLOCK_TYPE Передан инфоблок другого типа
INVALID_LIMIT / LIMIT_EXCEEDED Некорректный limit
INVALID_OFFSET offset меньше 0
INVALID_FILTER / INVALID_FILTER_OPERATOR Некорректный filter
INTERNAL_ERROR Внутренняя ошибка сервиса

Примеры кода

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

curl -G "https://{portal}/rest/{user_id}/{webhook_code}/homepage.content.list.json" \
          --data-urlencode "iblockId=51" \
          --data-urlencode "limit=10" \
          --data-urlencode "offset=0" \
          -H "Accept: application/json"

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

{
          "result": {
            "result": [
              {
                "id": 12345,
                "iblockId": 51,
                "iblockSectionId": 301,
                "name": "Блок контента",
                "active": true,
                "sort": 500,
                "previewText": "Описание"
              }
            ],
            "next": null,
            "error": null
          },
          "total": 1
        }

См. также

Предыдущая
homepage.content.iblock.list
Следующая
homepage.content.get