ipr.event.section.list

Scope: ipr

Кто может вызывать: Любой авторизованный пользователь. Подробнее: Модель доступа

Возвращает категории каталога мероприятий вместе с календарём, в котором создаются даты проведения категории.

HTTP: GET

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

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

Параметров нет.

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

Массив result и total. Элемент:

Поле Тип Описание
id int ID категории (sectionId в остальных методах)
name string Название
active bool Активность
sort int Сортировка
calendar object|null Календарь категории: type (тип календаря, например company_calendar или group), sectionId (раздел календаря), ownerId (владелец; для group — ID группы). null — категория не привязана к календарю, даты проведения в ней создать нельзя

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

Справочник кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Каталог не настроен (details.reason = events_not_configured) или внутренняя ошибка сервера

Пример запроса (GET)

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/ipr.event.section.list.json"
          -H "Accept: application/json"

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

{
          "result": {
            "result": [
              {
                "id": 12,
                "name": "Тренинги",
                "active": true,
                "sort": 100,
                "calendar": {
                  "type": "company_calendar",
                  "sectionId": 5,
                  "ownerId": null
                }
              }
            ],
            "total": 1,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
Обзор раздела
Следующая
ipr.event.list