ipr.event.list
Scope:
iprКто может вызывать: Любой авторизованный пользователь; видимость элементов ограничена правами инфоблока каталога (администратор и HR видят всё). Подробнее: Модель доступа
Возвращает мероприятия каталога с фильтрацией и пагинацией. Для каждого мероприятия приходят ID его дат проведения и ближайшая будущая дата проведения.
HTTP: GET
Побочные эффекты: none
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
filter.sectionId |
int |
нет | Категория |
filter.hostId |
int |
нет | Ведущий |
filter.competenceId |
int |
нет | Мероприятия, где компетенция обязательная или рекомендованная |
filter.xmlId |
string |
нет | Точное совпадение внешнего кода |
filter.active |
bool |
нет | По умолчанию true. false — предложения сотрудников (не одобренные); только с правом canEdit, иначе PERMISSION_DENIED |
limit |
int |
нет | Размер страницы, по умолчанию 50, максимум 500 |
offset |
int |
нет | Смещение |
fetchAll |
bool |
нет | Вернуть все записи одним ответом (максимум 5000) |
По этим ключам фильтра учитывается только равенство (допустимо {"$eq": значение}); другие операторы игнорируются.
Возвращаемые данные
Массив result и total. Элемент — мероприятие (поля ниже, без description) плюс:
| Поле | Тип | Описание |
|---|---|---|
dateIds |
int[] |
ID календарных событий дат проведения |
nextDateFrom |
string|null |
Начало ближайшей будущей даты проведения (по времени UTC), ISO 8601 |
| Поле | Тип | Описание |
|---|---|---|
id |
int |
ID мероприятия каталога |
xmlId |
string |
Внешний код (ключ идемпотентности) |
name |
string |
Название |
description |
string |
Описание (в ipr.event.list не возвращается) |
active |
bool |
false — предложение сотрудника, ещё не одобренное |
sectionId |
int|null |
ID категории |
hostId |
int|null |
ID ведущего |
durationMinutes |
int|null |
Длительность даты проведения по умолчанию, минут |
remindMinutes |
int[] |
Напоминания по умолчанию, минут до начала |
requiredCompetenceIds |
int[] |
Обязательные компетенции каталога |
recommendedCompetenceIds |
int[] |
Рекомендованные компетенции каталога |
place |
object |
{roomId, text} — переговорная календаря либо текст места |
link |
string |
Ссылка (из предложения) |
price |
string |
Стоимость (из предложения) |
createdBy |
int |
Автор записи |
dateCreate / timestampX |
string |
Даты создания и изменения, ISO 8601 |
Обработка ошибок
Справочник кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
PERMISSION_DENIED |
filter.active=false без права canEdit (details.reason = offers) |
INVALID_LIMIT / LIMIT_EXCEEDED / INVALID_OFFSET |
Некорректные параметры пагинации |
INTERNAL_ERROR |
Каталог не настроен (events_not_configured) или внутренняя ошибка |
Пример запроса (GET)
curl -G "https://{портал}/rest/{user_id}/{webhook_code}/ipr.event.list.json"
-H "Accept: application/json"
--data-urlencode "filter[sectionId]=12"
--data-urlencode "limit=20"
Пример ответа
{
"result": {
"result": [
{
"id": 501,
"xmlId": "crm-2026-01",
"name": "Переговоры: продвинутый уровень",
"active": true,
"sectionId": 12,
"hostId": 8,
"durationMinutes": 120,
"remindMinutes": [
15,
60
],
"requiredCompetenceIds": [
301
],
"recommendedCompetenceIds": [
302
],
"place": {
"roomId": null,
"text": "Переговорная 2"
},
"link": "",
"price": "",
"createdBy": 1,
"dateCreate": "2026-10-12T10:00:00+03:00",
"timestampX": "2026-10-12T10:00:00+03:00",
"dateIds": [
9001
],
"nextDateFrom": "2026-11-10T10:00:00+03:00"
}
],
"total": 1,
"next": null,
"error": null
}
}
См. также
Предыдущая
Следующая