Создает приглашение опекуна и отправляет опекуну электронное письмо с просьбой подтвердить, что он является опекуном учащегося.
Как только опекун примет приглашение, его state
изменится на COMPLETED
, и он начнет получать уведомления опекуна. Ресурс Guardian
также будет создан для представления активного хранителя.
В объекте запроса должны быть установлены поля studentId
и invitedEmailAddress
. Если не задать эти поля или задать какие-либо другие поля в запросе, возникнет ошибка.
Этот метод возвращает следующие коды ошибок:
-
PERMISSION_DENIED
если текущий пользователь не имеет разрешения на управление опекунами, если соответствующий опекун уже отклонил слишком много запросов для этого учащегося, если опекуны не включены для рассматриваемого домена или в случае других ошибок доступа . -
RESOURCE_EXHAUSTED
, если учащийся или опекун превысил лимит ссылок опекуна. -
INVALID_ARGUMENT
если адрес электронной почты опекуна недействителен (например, если он слишком длинный) или если формат предоставленного идентификатора учащегося не может быть распознан (это не адрес электронной почты илиuserId
из этого API). Эта ошибка также будет возвращена, если установлены поля, доступные только для чтения, или если для поляstate
установлено значение, отличное отPENDING
. -
NOT_FOUND
, если предоставленный идентификатор учащегося является действительным, но в Классе нет записей об этом учащемся. -
ALREADY_EXISTS
если уже имеется ожидающее приглашение опекуна для учащегося и предоставленныйinvitedEmailAddress
, или если указанныйinvitedEmailAddress
соответствует учетной записи Google существующегоGuardian
для этого пользователя.
HTTP-запрос
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
guardianInvitation.studentId | ID студента (в стандартном формате) |
Тело запроса
Тело запроса содержит экземпляр GuardianInvitation
.
Тело ответа
В случае успеха тело ответа содержит вновь созданный экземпляр GuardianInvitation
.
Области авторизации
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/classroom.guardianlinks.students
Дополнительную информацию см. в руководстве по авторизации .