Запрос позволяет получить подробную информацию о группе обучения и сводную статистику по статусам обучения участников.
{courseID} и {groupID} можно получить запросом GET /organization/courses/groups.
МЕТОД HTTP
GET
URL
ОБЯЗАТЕЛЬНЫЕ ПАРАМЕТРЫ
Отсутствуют.
ДОПОЛНИТЕЛЬНЫЕ ПАРАМЕТРЫ
Отсутствуют.
ПОЛЯ ОТВЕТА
status — статус группы;
isEndless — определяет бесконечность/конечность курса. Значения:
- true — курс бесконечный;
- false — курс по группам;startsAt — информация о начале группы с указанием часового пояса;
endsAt — дата окончания группы. У бесконечных курсов равно null;
cost — стоимость курса;
studentsCount — информация о студентах группы. Параметры:
- active — количество активных студентов;- no_active - количество студентов, которые неделю не заходили на курс;
- successed — количество успешно завершив курс и набрал минимальный проходной балл;
- invited — количество приглашенных, но не зарегистрированных;
- registered — количество зарегистрировавшихся, но не начавших проходить курс;
- paid — количество оплативших, но не приступивших к обучению;
- on_moderation — количество участников, ожидающих модерацию администратором;
- failed — количество проваливших (завершил курс, но не набрал минимальный проходной балл);-certified - количество участников , получивших сертификат;
locale — язык;
userid — фильтр по ID сотрудника Организации;
ПРИМЕР ЗАПРОСА
url: https://userapi.webinar.ru/v3/organization/courses/groups
method: GET,
headers:
{
x-auth-token: {Token},
Content-Type: application/x-www-form-urlencoded
}
ПРИМЕР ОТВЕТА
200 OK
{
"id": 9937,
"course": {
"id": 6925
},
"status": "ACTIVE",
"isEndless": true,
"startsAt": {
"date": "2018-12-14 10:24:07.000000",
"timezone_type": 3,
"timezone": "Europe/Moscow"
},
"endsAt": null,
"cost": 0,
"userId: {USERID}"
"studentsCount": {
"invited": "1"
}
}