Возвращает список курсов, которые разрешено просматривать запрашивающему пользователю, ограниченный теми, которые соответствуют запросу. Возвращенные курсы упорядочены по времени создания, причем первыми идут самые последние созданные.
Этот метод возвращает следующие коды ошибок:
-
PERMISSION_DENIED
для ошибок доступа . -
INVALID_ARGUMENT
если аргумент запроса имеет неверный формат. -
NOT_FOUND
если какие-либо пользователи, указанные в аргументах запроса, не существуют.
HTTP-запрос
GET https://classroom.googleapis.com/v1/courses
URL-адрес использует синтаксис транскодирования gRPC .
Параметры запроса
Параметры | |
---|---|
studentId | Ограничивает возвращаемые курсы теми, у кого есть студент с указанным идентификатором. Идентификатор может быть одним из следующих:
|
teacherId | Ограничивает возвращаемые курсы теми, у кого есть преподаватель с указанным идентификатором. Идентификатор может быть одним из следующих:
|
courseStates[] | Ограничивает возвращаемые курсы курсами, находящимися в одном из указанных состояний. Значение по умолчанию: АКТИВНО, АРХИВИРОВАНО, ПРЕДОСТАВЛЕНО, ОТКЛОНЕНО. |
pageSize | Максимальное количество товаров для возврата. Ноль или не указано означает, что сервер может назначить максимум. Сервер может вернуть меньшее количество результатов, чем указано. |
pageToken | Значение В остальном запрос |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
Ответ при перечислении курсов.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"courses": [
{
object ( |
Поля | |
---|---|
courses[] | Курсы, соответствующие запросу списка. |
nextPageToken | Токен, идентифицирующий следующую страницу результатов, которую нужно вернуть. Если пусто, дальнейшие результаты недоступны. |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/classroom.courses
-
https://www.googleapis.com/auth/classroom.courses.readonly
Дополнительную информацию см. в руководстве по авторизации .