Возвращает список приглашений, которые запрашивающему пользователю разрешено просматривать, ограниченный теми, которые соответствуют запросу списка.
Примечание. Необходимо указать хотя бы один идентификатор userId
или courseId
. Оба поля могут быть заполнены.
Этот метод возвращает следующие коды ошибок:
-
PERMISSION_DENIED
для ошибок доступа .
HTTP-запрос
GET https://classroom.googleapis.com/v1/invitations
URL-адрес использует синтаксис транскодирования gRPC .
Параметры запроса
Параметры | |
---|---|
user Id | Ограничивает возвращаемые приглашения приглашениями для конкретного пользователя. Идентификатор может быть одним из следующих:
|
course Id | Ограничивает возвращаемые приглашения только приглашениями на курс с указанным идентификатором. |
page Size | Максимальное количество товаров для возврата. Значение по умолчанию — 500, если не указано, или Сервер может вернуть меньшее количество результатов, чем указано. |
page Token | Значение В остальном запрос |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
Ответ при перечислении приглашений.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"invitations": [
{
object ( |
Поля | |
---|---|
invitations[] | Приглашения, соответствующие запросу списка. |
next Page Token | Токен, идентифицирующий следующую страницу результатов, которую нужно вернуть. Если пусто, дальнейшие результаты недоступны. |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/classroom.rosters
-
https://www.googleapis.com/auth/classroom.rosters.readonly
Дополнительную информацию см. в руководстве по авторизации .