Все коллекции
API и Webhooks
Мероприятия
Получить данные о вебинаре сотрудника организации
Получить данные о вебинаре сотрудника организации

GET /users/{userID}/events/schedule

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

Метод позволяет получить информацию о вебинарах одного из сотрудников Команды.
Подробнее про Команду.

МЕТОД HTTP

GET

URL

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

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

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

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

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

  • to — дата окончания периода выборки.  
    Формат: yyy-mm-dd+hh:mm:ss.
    По умолчанию: from +1 год;

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

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

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

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

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

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

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

ПОЛЯ ОТВЕТА

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

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

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

  • accessSettings

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

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

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

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

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

  • lang — язык интерфейса мероприятия;

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

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

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

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

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

  • organizationId — идентификатор организации, которой принадлежит мероприятие;

  • isArchive

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

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

  • createUser — подробные данные о владельце мероприятия;

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

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

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

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

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

  • 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&accessSettings[0][isModerationRequired]=0&accessSettings[0][isPasswordRequired]=0&accessSettings[0][isRegistrationRequired]=0&accessSettings[1][isModerationRequired]=0&accessSettings[1][isPasswordRequired]=0&accessSettings[1][isRegistrationRequired]=1,
method: GET,
headers:
{
    "x-auth-token": "{{Token}}",
    "Content-Type": "application/x-www-form-urlencoded"
};

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

200 - OK            
[
  {
    "id": "2381593",
    "status": "ACTIVE",
"accessSettings": {
"isPasswordRequired": false,
"isRegistrationRequired": false,
"isModerationRequired": false
},
"access": "0",
    "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",
"createUser": {
"id": 1029,
"name": "Специалист",
"secondName": "тех.поддержки",
"email": "support@webinar.ru"
},
    "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": []
  }
]            

 

Нашли ответ на свой вопрос?