Метод позволяет получить информацию о вебинарах одного из сотрудников Команды.
Подробнее про Команду.
МЕТОД HTTP
GET
URL
https://userapi.webinar.ru/v3/users/{userID}/events/schedule
ОБЯЗАТЕЛЬНЫЕ ПАРАМЕТРЫ
- from — дата начала периода выборки.
Формат: yyy-mm-dd+hh:mm:ss.
Без этого параметра запрос отработает от текущей даты и времени.
ДОПОЛНИТЕЛЬНЫЕ ПАРАМЕТРЫ
- name — названия вебинара;
- status[ ] — статус вебинаров. Передается в виде массива статусов. Значения:
- ACTIVE — запланированные мероприятия;
- STOP — завершенные мероприятия;
- START — мероприятия, которые идут в данный момент.
По умолчанию: ACTIVE; - to — дата окончания периода выборки.
Формат: yyy-mm-dd+hh:mm:ss.
По умолчанию: from +1 год; - access — уровень доступа к мероприятиям. Значения:
- 1 — свободный доступ;
- 3 — свободный доступ с паролем;
- 4 — регистрация;
- 6 — регистрация с паролем;
- 8 — регистрация с последующей ручной модерацией участников;
- 10 — регистрация с последующей ручной модерацией участников и с паролем; - page — номер страницы выборки.
По умолчанию: 1; - perPage — количество элементов на одной странице выборки. Значения:
- 10;
- 50;
- 100;
- 250;
По умолчанию: 10.
ПОЛЯ ОТВЕТА
- id — идентификатор (EventID);
- name — название;
- description — описание;
- status — текущее состояние вебинара;
- access — уровень доступа мероприятия;
- rule — правило повторения серии мероприятий.
У несерийного события правило будет равно FREQ=DAILY;COUNT=1; - lang — язык интерфейса мероприятия;
- startsAt — дата начала мероприятия;
- utcStartsAt — дата начала в формате timestamp;
- createUserId — идентификатор владельца мероприятия (userID);
- timezoneId — тайм-зона. Параметр в пользовательских сценариях не используется;
- endsAt — дата завершения мероприятия;
- organizationId — идентификатор организации, которой принадлежит мероприятие;
- type — тип мероприятия. Может быть вебинар, а может быть встреча. Разница о мероприятиях;
- createUser — подробные данные о владельце мероприятия;
- lectors — информация о лекторах, добавленных к мероприятию;
- tags — набор используемых тегов;
- announceFiles — информация о файлах, добавленных к анонсу мероприятия;
- files — информация о файлах, добавленных к мероприятию;
- eventSessions — информация о мероприятиях, входящих в этот Event.
ПРИМЕР ЗАПРОСА
url: https://userapi.webinar.ru/v3/users/{userID}/events/schedule?from=2018-01-01&to=2018-12-31&perPage=10&page=1&status[0]=STOP&access=1,
method: GET,
headers:
{
"x-auth-token": "{{Token}}",
"Content-Type": "application/x-www-form-urlencoded"
};
ПРИМЕР ОТВЕТА
200 - OK
[
{
"id": "2381593",
"status": "ACTIVE",
"access": "1",
"rule": "FREQ=DAILY;COUNT=1",
"name": "Обучающий вебинар",
"description": "Обучающий вебинар",
"startsAt": "2019-05-27T16:58:05+0300",
"isArchive": "0",
"createUserId": "14850535",
"type": "webinar",
"estimatedAt": "2019-05-27T16:58:05+0300",
"timezoneName": "Europe/Moscow",
"image": "https://events.webinar.ru/images/event-default.png",
"eventSessions": [
{
"id": "2425315",
"status": "ACTIVE",
"access": "1",
"name": "Обучающий вебинар",
"description": "Обучающий вебинар",
"startsAt": "2019-05-27T16:58:05+0300",
"isArchive": "0",
"eventId": "2381593",
"createUserId": "14850535",
"type": "webinar",
"estimatedAt": "2019-05-27T16:58:05+0300",
"timezoneName": "Europe/Moscow",
"participationsCount": "0",
"image": "https://events.webinar.ru/images/event-default.png",
"tags": [],
"files": [],
"lectors": []
}
],
"tags": [],
"files": [],
"lectors": []
}
]