students/list

Список студентов данного курса. Если студент не из руководства курса, то возвращается только статистика данного студента.

Параметры

Название Описание Тип Обязательный
token Токен пользователя Строка Да
id ID курса Строка Да
individual Чтобы руководству курса получить свою статистику по курсу, нужно отправить этот параметр со значением 1 Строка Нет
admin Роль в курсе
1 - Администрация курса
2 - Ученики
3 - Заявки
Число Нет
paid Отправлять этот параметр со значением 1, чтобы получить только студентов, оплативших курс
Отправлять этот параметр со значением -1, чтобы получить только студентов, не оплативших курс
Число Нет
limit Количество возвращаемых студентов. Строка Нет
offset Сдвиг от начала Строка Нет
search Поиск по имени, телефону и почте Строка Нет
plan Поиск по тарифу. По умолчанию выдаются все студенты (0 - без тарифа) Строка Нет
color Поиск по цвету в формате #aa00cc. По умолчанию выдаются все студенты. Строка Нет

Результат

В случае успеха возвращает объект students с массивом объектов студент
Также возвращает еще 4 параметра:
all - Количество студентов (роль 4 и 5)
paid - Количество оплативших курс
not_paid - Количество не оплативших курс
users - Количество студентов (роль 4)
applications - количество заявок (роль 5)

Коды ошибок

TOKEN_NOT_FOUND Передан неверный токен.
ID_NOT_FOUND Передан неверный ID курса.

Тест запроса

token:
id:
individual:
admin:
paid:
limit:
offset:
search:
plan:
color:
Введите данные и нажмите выполнить