Документация InstantCMS

для администраторов и разработчиков

Инструменты пользователя

Инструменты сайта


manual:components:api:methods:content-get_categories

content.get_categories.CTYPE

Возвращает категории для заданного типа контента.

Параметры

Название Описание
is_tree 1 — возвращать категории, сформированные деревом. Флаг, может принимать значения 1 или 0. Параметр необязательный.
cat_level Ограничивает максимальный уровень вложенности возвращаемых категорий. По умолчанию — 0, не ограничивать. Применяется совместно с параметром is_tree. Положительное число. Параметр необязательный.
parent_id ID родительской категории, от которой нужно получить вложенные. По умолчанию — 1, это корневая категория. Положительное число. Параметр необязательный.
cat_ids Идентификаторы категорий (их id), информацию о которых необходимо вернуть. Если этот параметр задан, параметры, описанные выше не учитываются. Список положительных чисел, разделенных запятыми. Параметр необязательный.

CTYPE в названии метода - это имя типа контента, например news, board и т.п.

Пример

instantcms_site.ru/api/method/content.get_categories.articles?api_key=API_KEY&cat_ids=5,9

Результат

После успешного выполнения возвращает объект, содержащий общее число категорий типа контента в поле count и массив объектов категорий в поле items.

Коды ошибок

В ходе выполнения могут произойти общие ошибки.


Назад к описанию методов API

manual/components/api/methods/content-get_categories.txt · Последнее изменение: 06.09.2016 15:59 — fuze