- HTTP-запрос
- Параметры пути
- Параметры запроса
- Тело запроса
- Тело ответа
- Области авторизации
- Попробуйте!
Возвращает список приглашений опекунов, которые запрашивающему пользователю разрешено просматривать, отфильтрованный по предоставленным параметрам.
Этот метод возвращает следующие коды ошибок:
-
PERMISSION_DENIED
, если указанstudentId
и запрашивающему пользователю не разрешено просматривать приглашения опекуна для этого учащегося, если в качествеstudentId
указано"-"
, а пользователь не является администратором домена, если опекуны не включены для рассматриваемого домена или других ошибок доступа . -
INVALID_ARGUMENT
если указанstudentId
, но его формат не может быть распознан (это не адрес электронной почты, неstudentId
из API и не литеральная строкаme
). Также может быть возвращено, если указан недопустимыйpageToken
илиstate
. -
NOT_FOUND
, если указанstudentId
и его формат можно распознать, но в Классе нет записей об этом студенте.
HTTP-запрос
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
studentId | Удостоверение личности студента, приглашения опекуна которого необходимо вернуть. Идентификатор может быть одним из следующих:
|
Параметры запроса
Параметры | |
---|---|
invitedEmailAddress | Если этот параметр указан, возвращаются только результаты с указанным |
states[] | Если указано, возвращаются только результаты с указанными значениями |
pageToken | Значение В остальном запрос |
pageSize | Максимальное количество товаров для возврата. Ноль или не указано означает, что сервер может назначить максимум. Сервер может вернуть меньшее количество результатов, чем указано. |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
Ответ при перечислении приглашений опекуна.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"guardianInvitations": [
{
object ( |
Поля | |
---|---|
guardianInvitations[] | Приглашения Guardian, соответствующие запросу списка. |
nextPageToken | Токен, идентифицирующий следующую страницу результатов, которую нужно вернуть. Если пусто, дальнейшие результаты недоступны. |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
-
https://www.googleapis.com/auth/classroom.guardianlinks.students
Дополнительную информацию см. в руководстве по авторизации .