API Leader-ID позволяет создавать мероприятия от имени пользователя

Процесс создания делится на несколько этапов:

1. Создание черновика мероприятия POST методом "Создание мероприятия от имени пользователя"

/users/{userId}/events

2. Бронирование временного слота. Если проведение создаваемого мероприятия предполагается на территории одной из Точек кипения, то необходимо бронирование временного слота POST методом "Бронирование Точки кипения"

/users/{userId}/events/{id}/space-reservation

Для онлайн-мероприятий, не предполагающего очного участия или проведения на сторонней площадке этот необходимо пропустить.

3. Отправление запроса на модерацию мероприятия POST методом "Публикация мероприятия (запрос на модерацию если проводится в Точке кипения)"

/users/{userId}/events/{id}/publicate

1. Создание черновика мероприятия

Пример запроса на создания черновика очного мероприятия в тестовой Точке кипения с индивидуальном участием:

POST

https://apps.leader-id.ru/api/v1/users/{id}/events

Headers

Authorization: Bearer eyJ0eXAiO...

Body

{
     "name": "Тестовое название",
     "info": null,
     "fullInfo": "Тестовое описание",
     "photoId": "beb48b03-a956-4caf-bee7-95b56369b053",
     "dateStart": "2024-07-30 10:00:00",
     "dateEnd": "2024-07-30 12:00:00",
     "registrationDateStart": "2024-07-25 14:00:00",
     "registrationDateEnd": "2024-07-30 12:00:00",
     "timezone": null,
     "format": "space",
     "spaceId": 7016,
     "placeId": null,
     "typeId": 39,
     "access": "open",
     "inCalendar": true,
     "organizerIds": [
         10715
     ],
     "participationFormat": "person",
     "teamSizeMax": null,
     "teamSizeMin": null,
     "teamType": null,
     "live": [
         "https://telemost.yandex.ru/j/69724493500739" 
     ],
     "livePublic": true,
     "documentsIds": [
         "46a22071-8544-4a09-ace2-dda21a3dc337"
     ],
     "quizId": "86a7fcdf-4590-4594-b649-158947601d02"
}

Разберем запрос:

1. В url запроса на месте {id} указывается ID номер профиля, с которого создается мероприятие.
2. В Headers запроса указывается access_token пользователя.
3. В Body запроса:

• "name": "Тестовое название" — текст названия

• "info": null — устаревший параметр для описания мероприятия, поэтому передаем null

• "fullInfo": "Тестовое описание" — текст описания

• "photoId": "beb48b03-a956-4caf-bee7-95b56369b053" — идентификатор для логотипа мероприятия

Загрузить файл и получить идентификатор можно используя POST методы "Запрос на загрузку файла" и "Завершение загрузки файла"

• "dateStart": "2024-04-10 10:00:00" — дата и время начала

• "dateEnd": "2024-04-10 12:00:00" — дата и время окончания

• "registrationDateStart": "2024-04-09 14:00:00" — дата и время начала регистрации

• "registrationDateEnd": "2024-04-10 12:00:00" — дата время окончания регистрации

• "timezone": null — временная зона места проведения

В данном примере местом проведения мы указали тестовую Точку кипения. Временная зона устанавливается автоматически по месторасположению Точки кипения. Изменить её нельзя, по этой причине мы передали null

• "format": "space" — формат проведения мероприятия

Существующие форматы: в Точке кипения — "space" , не в Точке кипения (на своей площадке) — "place" , онлайн — "online"

• "spaceId": 7016 — идентификатор тестовой Точки кипения

Полный список идентификаторов существующих Точек кипения доступен при вызове метода "Получение Точек кипения".

• "placeId": null — параметр для указания идентификатора места проведения не в Точке кипения

Так как мы планируем провести мероприятия в тестовой Точке кипения , то мы передали null. Если необходимо создать мероприятие не в Точке кипения, то в параметре "format" необходимо указать значение "place" , а в "placeId" указать идентификатор заранее созданной площадки. Создать в системе место проведения и получить её идентификатор необходимо методом "Создание адреса".

• "typeId": 39 — идентификатор формата (темы) мероприятия — "Встреча"

Полный список идентификаторов форматов доступен при вызове метода "Список типов мероприятий"

• "access": "open" — тип доступности мероприятия для участников

Существующие типы: открытое — "open" , рассмотрение заявок — "close" , приватное — "private"

• "inCalendar": true — мероприятие будет отображаться в календаре мероприятий

• "organizerIds": [00000] — идентификатор информации по организатору мероприятия, которая будет отображаться пользователям на странице мероприятия

Создать организатора и получить его идентификатор необходимо необходимо POST методом "Создание организатора"

• "participationFormat": "person" — предполагаемый формат участия

Мероприятие может предполагать индивидуальное участие пользователя или в составе команды (индивидуальное — "person", командное — "team")

• "teamSizeMax": null — минимальное число участников в команде

• "teamSizeMin": null — максимальное число участников в команде

Так как мы создаём мероприятие для индивидуально участие, мы передали "participationFormat": "person" , то в "teamSizeMax" и "teamSizeMin" установили значение null

• "live": "https://telemost.yandex.ru/j/69724493500739" — ссылка на трансляцию мероприятия

В данной примере мы указали ссылку на Яндекс.Телемост. Если предполагается создание онлайн мероприятия "format": "online" , то указание ссылки на трансляцию является обязательным условием

• "livePublic": false — отображение кнопки для подключения к трансляции (при её наличии в параметре "live") неавторизованным в Leader-ID пользователям

• "documentsIds": ["46a22071-8544-4a09-ace2-dda21a3dc337"] — идентификатор прикреплённого файла к мероприятию

Загрузить файл и получить идентификатор можно используя POST методы "Запрос на загрузку файла" и "Завершение загрузки файла"

• "quizId": "86a7fcdf-4590-4594-b649-158947601d02" — идентификатор опроса, на вопросы которого пользователю необходимо ответить при подачи заявки

Создать опрос можно при помощью POST метода "Создание опроса"

В случае успеха возвращаются код "200" и данные созданного черновика мероприятия с присвоенным ему идентификатором, который будет использоваться на следующих шагах:

{
    "id": 501836,
    ...
}

2. Бронирование временного слота

Бронировать временной слот для мероприятия необходимо только при проведении мероприятия в Точках кипения.

При запросе системой производится проверка, свободен ли слот в зале на дату и время, которое указано в черновике мероприятия.

Пример запроса:

POST

https://apps.leader-id.ru/api/v1/{userId}/events/{id}/space-reservation

Headers

Authorization: Bearer eyJ0eXAiO...

Body

{
  "spaceId": 7016,
  "hallIds": [  
       1586
  ]
}

Разберем запрос:

1. В url запроса на месте {userId} указывается ID номер профиля, с которого был ранее создан черновик мероприятия, а на месте {id} указывается ID черновика.
2. В Headers запроса указывается access_token пользователя.
3. В Body запроса:

• "spaceId": 7016 — идентификатор тестовой Точки кипения

• "hallIds": 1586 — идентификатор зала

В случае успеха возвращается код "200" и идентификатор присвоенного бронирования:

{
    "id": 179142
}

Если временной слот уже занят проведением мероприятия будет получен код "422" с пояснением:

{
    "message": "Validation error",
    "code": 1050,
    "errors": {
        "hallIds": [
            "Один из залов не может быть забронирован в выбранное время"
        ]
    }
}

3. Отправка запроса на модерацию

Последним шагов создания мероприятия является отправка запроса на его модерацию. После успешного прохождения модерации мероприятия администраторами системы оно будет одобрено и опубликовано в календаре мероприятий, если такая настройка была установлена.

Пример запроса:

POST

https://apps.leader-id.ru/api/v1/users/{userId}/events/{id}/publicate

Headers

Authorization: Bearer eyJ0eXAiO...

Разберем запрос:

1. В url запроса на месте {userId} указывается ID номер профиля, с которого был ранее создан черновик мероприятия, а на месте {id} указывается ID черновика.
2. В Headers запроса указывается access_token пользователя.

В случае успеха возвращается код "200".

Пример отображения одобренного и опубликованного мероприятия из примера:

В начало

Powered by Froala Editor