После приглашения данные участника попадают в адресную книгу (https://events.webinar.ru/people).
При переходе по ссылке из письма-приглашения данные для регистрации передаются в систему автоматически.
Студенту достаточно нажать кнопку "Записаться" и приступить к прохождению курса.
При этом, если студентом является email, у которого зарегистрирован личный кабинет организатора и вход в личный кабинет не выполнен, то при входе потребуется ввести пароль от личного кабинета.
МЕТОД HTTP
POST
URL
https://userapi.webinar.ru/v3/groups/{groupsID}/invites
Важно! Отправлять запрос нужно в формате application/json.
ОБЯЗАТЕЛЬНЫЕ ПАРАМЕТРЫ
Массив данных о студентах, которых нужно пригласить.
Каждый массив содержит в себе информацию про студента.
email - адрес почты студента
ДОПОЛНИТЕЛЬНЫЕ ПАРАМЕТРЫ
firstName — имя студента.
Передается в теле запроса;lastName — фамилия студента;
sendInvites — отправка письма-приглашения студенту с платформы. Значения:
- true — письмо будет отправлено;
- false — письмо не будет отправлено.
Параметр передается в заголовке запроса. Если параметр не передать, рассылки писем не будет.
ПОЛЯ ОТВЕТА
В ответ передается массив данных обо всех зарегистрированных студентах:
url — ссылка студента;
contact — информация о контакте: идентификатор контакта (id), почта (email), Имя (firstName) и Фамилия (lastName).
ПРИМЕР ЗАПРОСА
url: https://userapi.webinar.ru/v3/groups/1/invites?sendInvites=true,
method: POST,
timeout: 0,
headers:
{
x-auth-token: {Token},
Content-Type: application/json
},
data:
[
{
"email": "test001@mailinator.com"
},
{
"firstName": "Vasiliy",
"lastName": "Pupkin",
"email: test002@mailinator.com"
},
{
"firstName": "Vaasiliy",
"email": "test003@mailinator.com"
}
],
};
ПРИМЕР ОТВЕТА
200 － OK
[
{
"url": "https://events.webinar.ru/courses/invites/2a7e8d16-8004-5d5f-bae1-387787ab1898",
"contact": {
"id": 48,
"email": "test001@mailinator.com",
"firstName": null,
"lastName": null
}
},
{
"url": "http://webinar.local/courses/invites/ee530430-0934-534a-b941-c22dab969855",
"contact": {
"id": 49,
"email": "test002@mailinator.com",
"firstName": "Vasiliy",
"lastName": "Pupkin"
}
},
{
"url": "http://webinar.local/courses/invites/371c25a0-b5f1-52bc-a605-61f4cb642538",
"contact": {
"id": 50,
"email": "test003@mailinator.com",
"firstName": "Vaasiliy",
"lastName": null
}
}
]