ipr.action.type.list

Scope: ipr

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

Возвращает справочник типов ресурса мероприятия (значения свойства TYPE инфоблока мероприятий в ИПР).

HTTP: GET

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

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

Параметр Тип Обяз. Описание
— — — Нет параметров

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

Массив объектов { id, title, xmlId }. Известные XML_ID (могут отличаться по факту настройки портала):

XML_ID Смысл
course Курс
test Тест
library Материал библиотеки
events Мероприятие/событие
task Задача
project Проект
rmactions RM-действие
others Прочее

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
INTERNAL_ERROR Внутренняя ошибка сервера

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

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

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

{
          "result": {
            "result": [
              { "id": "course", "title": "Курс", "xmlId": "course" },
              { "id": "test", "title": "Тест", "xmlId": "test" },
              { "id": "library", "title": "Библиотека", "xmlId": "library" },
              { "id": "events", "title": "Мероприятие", "xmlId": "events" },
              { "id": "task", "title": "Задача", "xmlId": "task" },
              { "id": "project", "title": "Проект", "xmlId": "project" },
              { "id": "rmactions", "title": "RM-действие", "xmlId": "rmactions" },
              { "id": "others", "title": "Прочее", "xmlId": "others" }
            ],
            "total": null,
            "next": null,
            "error": null
          }
        }

См. также

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