Все коллекции
API и Webhooks
Мероприятия
Получить информацию о мероприятиях
Получить информацию о мероприятиях

GET /organization/events/schedule

Обновлено больше недели назад

С помощью запроса можно получать список вебинаров.
Внимание! Если параметр from не указан, выборка будет осуществляться от текущей даты и времени.

МЕТОД HTTP

GET

URL

ОБЯЗАТЕЛЬНЫЕ ПАРАМЕТРЫ

  • from — дата начала периода выборки.
    Формат: yyy-mm-dd+hh:mm:ss.
    Без этого параметра запрос отработает от текущей даты и времени.

ДОПОЛНИТЕЛЬНЫЕ ПАРАМЕТРЫ

  • name — названия вебинара;

  • status[ ] — статус вебинаров. Передается в виде массива статусов. Значения:
    - ACTIVE — запланированные мероприятия;
    - STOP — завершенные мероприятия;
    - START — мероприятия, которые идут в данный момент.
    По умолчанию: ACTIVE;

  • to — дата окончания периода выборки.
    По умолчанию: from +1 год.

  • accessSettings — доступ к мероприятиям. Включает в себя 3 параметра, каждый из них принимает одно значение: 0 - выключено, 1 - включено.

    - isPasswordRequired — доступ с паролем

    - isRegistrationRequired — доступ с регистрацией

    - isModerationRequired — доступ с залом ожидания

  • (Архивный способ передачи данных) access уровень доступа к мероприятиям. Значения:
    - 1 — свободный доступ;
    - 3 — свободный доступ с паролем;
    - 4 — регистрация;
    - 6 — регистрация с паролем;
    - 8 — регистрация с последующей ручной модерацией участников;
    - 10 — регистрация с последующей ручной модерацией участников и с паролем;

  • page — номер страницы выборки.
    По умолчанию: 1;

  • perPage — количество элементов на одной странице выборки. Значения:
    - 10;
    - 50;
    - 100;
    - 250;
    По умолчанию: 10.

  • Если указывать значения perPage отличное от тех, что указаны, данный параметр будет игнорироваться и будет приниматься в расчет значение по умолчанию: 10.

ПОЛЯ ОТВЕТА

  • id — идентификатор (EventID) в числовом формате;

  • status — текущее состояние вебинара;

  • accessSettings

    - isPasswordRequired — доступ с паролем, или без него

    - isRegistrationRequired — доступ с регистрацией, или без неё

    - isModerationRequired — доступ с залом ожидания, или без него

  • (Архивный способ передачи данных) access — уровень доступа мероприятия;

  • rule — правило повторения серии мероприятий.
    У несерийного события правило будет равно FREQ=DAILY;COUNT=1;

  • name — название;

  • lang — язык мероприятия;

  • startsAt — дата начала мероприятия;

  • endsAt — дата завершения мероприятия;

  • estimatedAt — примерная продолжительность мероприятия;

  • createUserId — идентификатор владельца мероприятия (userID);

  • isArchive

  • timezoneName — тайм-зона;

  • type — тип мероприятия. Может быть вебинар, а может быть встречи. Разница о мероприятиях;

  • isAuto — автозапуск;

  • image — ссылка на фоновое изображение;

  • createUser — информация о владельце вебинара (id, имя/фамилия, email);

  • lectors — информация о лекторах, добавленных к мероприятию;

  • tags — набор используемых тегов;

  • files — информация о файлах, добавленных к мероприятию;

  • eventSessions — информация о мероприятиях, входящих в этот Event. eventSessionsID выдается в числовом формате.

ПРИМЕР ЗАПРОСА

url: https://userapi.mts-link.ru/v3/organization/events/schedule?from=2018-01-01&to=2018-12-31&perPage=10&page=1&status[0]=STOP&name=новый&accessSettings[0][isModerationRequired]=1&accessSettings[0][isPasswordRequired]=1&accessSettings[0][isRegistrationRequired]=1,
method: GET,
headers:
{
x-auth-token: {Token},
Content-Type: application/x-www-form-urlencoded
};

ПРИМЕР ОТВЕТА

200 - OK            
[
{
"id": "1550307",
"status": "STOP",
"accessSettings": {
"isPasswordRequired": false,
"isRegistrationRequired": false,
"isModerationRequired": false
},
"access": "0",
"name": "Новый вебинар",
"lang": "RU",
"startsAt": "2018-09-27T19:54:41+0300",
"endsAt": "2018-09-27T19:56:23+0300",
"isArchive": "0",
"createUserId": "1029",
"type": "webinar",
"estimatedAt": "2018-09-27T19:54:00+0300",
"timezoneName": "Europe/Moscow",
"image": "https://events.webinar.ru/images/event-default.png",
"createUser": {
"id": 1029,
"name": "Специалист",
"secondName": "тех.поддержки",
"email": "support@webinar.ru"
},
"eventSessions": [
{
"id": "1581297",
"status": "STOP",
"access": "1",
"name": "Новый вебинар",
"startsAt": "2018-09-27T19:54:41+0300",
"endsAt": "2018-09-27T19:56:23+0300",
"isArchive": "0",
"eventId": "1550307",
"createUserId": "1029",
"type": "webinar",
"estimatedAt": "2018-09-27T19:54:00+0300",
"timezoneName": "Europe/Moscow",
"participationsCount": "2",
"image": "https://events.webinar.ru/images/event-default.png",
"tags": [],
"files": [],
"lectors": [],
"recordUrl": {
"id": "1581297",
"name": "Новый вебинар",
"startsAt": "2018-09-27T19:54:41+0300",
"endsAt": "2018-09-27T19:56:23+0300",
"timezoneName": "Europe/Moscow",
"url": "https://events.webinar.ru/1029/1550307/record-new/1581297"
}
}
],
"tags": [],
"files": [],
"lectors": [],
"rule": "FREQ=DAILY;COUNT=1"
},
{
"id": "1621093",
"status": "STOP",
"access": "1",
"name": "Новый вебинар",
"startsAt": "2018-10-17T17:21:42+0300",
"endsAt": "2018-10-17T17:22:20+0300",
"isArchive": "0",
"createUserId": "1029",
"type": "webinar",
"estimatedAt": "2018-10-17T17:21:00+0300",
"timezoneName": "Europe/Moscow",
"image": "https://events.webinar.ru/images/event-default.png",
"eventSessions": [
{
"id": "1653847",
"status": "STOP",
"access": "1",
"name": "Новый вебинар",
"startsAt": "2018-10-17T17:21:42+0300",
"endsAt": "2018-10-17T17:22:20+0300",
"isArchive": "0",
"eventId": "1621093",
"createUserId": "1029",
"type": "webinar",
"estimatedAt": "2018-10-17T17:21:00+0300",
"timezoneName": "Europe/Moscow",
"participationsCount": "2",
"image": "https://events.webinar.ru/images/event-default.png",
"tags": [],
"files": [],
"lectors": [],
"recordUrl": {
"id": "1653847",
"name": "Новый вебинар",
"startsAt": "2018-10-17T17:21:42+0300",
"endsAt": "2018-10-17T17:22:20+0300",
"timezoneName": "Europe/Moscow",
"url": "https://events.webinar.ru/1029/1621093/record-new/1653847"
}
}
],
"tags": [],
"files": [],
"lectors": [],
"rule": "FREQ=DAILY;COUNT=1"
},
{
"id": "1712687",
"status": "STOP",
"access": "1",
"name": "Новый вебинар",
"startsAt": "2018-11-11T12:15:33+0300",
"endsAt": "2018-11-11T12:22:07+0300",
"isArchive": "0",
"createUserId": "1029",
"type": "webinar",
"estimatedAt": "2018-11-11T12:15:00+0300",
"timezoneName": "Europe/Moscow",
"image": "https://events.webinar.ru/images/event-default.png",
"eventSessions": [
{
"id": "1746505",
"status": "STOP",
"access": "1",
"name": "Новый вебинар",
"startsAt": "2018-11-11T12:15:33+0300",
"endsAt": "2018-11-11T12:22:07+0300",
"isArchive": "0",
"eventId": "1712687",
"createUserId": "1029",
"type": "webinar",
"estimatedAt": "2018-11-11T12:15:00+0300",
"timezoneName": "Europe/Moscow",
"participationsCount": "1",
"image": "https://events.webinar.ru/images/event-default.png",
"tags": [],
"files": [],
"lectors": [],
"recordUrl": {
"id": "1746505",
"name": "Новый вебинар",
"startsAt": "2018-11-11T12:15:33+0300",
"endsAt": "2018-11-11T12:22:07+0300",
"timezoneName": "Europe/Moscow",
"url": "https://events.webinar.ru/1029/1712687/record-new/1746505"
}
}
],
"tags": [],
"files": [],
"lectors": [],
"rule": "FREQ=DAILY;COUNT=1"
},
{
"id": "1713561",
"status": "STOP",
"access": "1",
"name": "Новый вебинар",
"startsAt": "2018-11-11T20:01:20+0300",
"endsAt": "2018-11-11T20:02:25+0300",
"isArchive": "0",
"createUserId": "1029",
"type": "webinar",
"estimatedAt": "2018-11-11T20:01:00+0300",
"timezoneName": "Europe/Moscow",
"image": "https://events.webinar.ru/images/event-default.png",
"eventSessions": [
{
"id": "1747405",
"status": "STOP",
"access": "1",
"name": "Новый вебинар",
"startsAt": "2018-11-11T20:01:20+0300",
"endsAt": "2018-11-11T20:02:25+0300",
"isArchive": "0",
"eventId": "1713561",
"createUserId": "1029",
"type": "webinar",
"estimatedAt": "2018-11-11T20:01:00+0300",
"timezoneName": "Europe/Moscow",
"participationsCount": "1",
"image": "https://events.webinar.ru/images/event-default.png",
"tags": [],
"files": [],
"lectors": [],
"recordUrl": {
"id": "1747405",
"name": "Новый вебинар",
"startsAt": "2018-11-11T20:01:20+0300",
"endsAt": "2018-11-11T20:02:25+0300",
"timezoneName": "Europe/Moscow",
"url": "https://events.webinar.ru/1029/1713561/record-new/1747405"
}
}
],
"tags": [],
"files": [],
"lectors": [],
"rule": "FREQ=DAILY;COUNT=1"
},
{
"id": "1825929",
"status": "STOP",
"access": "1",
"name": "Новый вебинар",
"startsAt": "2018-12-11T10:54:02+0300",
"endsAt": "2018-12-11T10:55:28+0300",
"isArchive": "0",
"createUserId": "1029",
"type": "webinar",
"estimatedAt": "2018-12-11T10:53:00+0300",
"timezoneName": "Europe/Moscow",
"image": "https://events.webinar.ru/images/event-default.png",
"eventSessions": [
{
"id": "1861569",
"status": "STOP",
"access": "1",
"name": "Новый вебинар",
"startsAt": "2018-12-11T10:54:02+0300",
"endsAt": "2018-12-11T10:55:28+0300",
"isArchive": "0",
"eventId": "1825929",
"createUserId": "1029",
"type": "webinar",
"estimatedAt": "2018-12-11T10:53:00+0300",
"timezoneName": "Europe/Moscow",
"participationsCount": "1",
"image": "https://events.webinar.ru/images/event-default.png",
"tags": [],
"files": [],
"lectors": [],
"recordUrl": {
"id": "1861569",
"name": "Новый вебинар",
"startsAt": "2018-12-11T10:54:02+0300",
"endsAt": "2018-12-11T10:55:28+0300",
"timezoneName": "Europe/Moscow",
"url": "https://events.webinar.ru/1029/1825929/record-new/1861569"
}
}
],
"tags": [],
"files": [],
"lectors": [],
"rule": "FREQ=DAILY;COUNT=1"
}
]
Нашли ответ на свой вопрос?