Tworzy zaproszenie dla opiekuna i wysyła do niego e-maila z prośbą o potwierdzenie, że jest on opiekunem ucznia.
Gdy opiekun zaakceptuje zaproszenie, jego state
zmieni się na COMPLETED
, a on sam zacznie otrzymywać powiadomienia. Utworzony zostanie też zasób Guardian
, który będzie reprezentować aktywnego opiekuna.
Obiekt żądania musi zawierać ustawione pola studentId
i invitedEmailAddress
. Nieustawienie tych pól lub ustawienie innych pól w żądaniu spowoduje błąd.
Ta metoda zwraca te kody błędów:
PERMISSION_DENIED
jeśli bieżący użytkownik nie ma uprawnień do zarządzania opiekunami, jeśli dany opiekun odrzucił już zbyt wiele próśb o dostęp dla tego ucznia, jeśli opiekunowie nie są włączeni w przypadku danej domeny lub z innych powodów związanych z błędami dostępu.RESOURCE_EXHAUSTED
jeśli uczeń lub opiekun przekroczył limit połączeń z opiekunem.INVALID_ARGUMENT
jeśli adres e-mail opiekuna jest nieprawidłowy (na przykład zbyt długi) lub jeśli nie można rozpoznać formatu podanego identyfikatora ucznia (nie jest to adres e-mail aniuserId
z tego interfejsu API). Ten błąd będzie też zwracany, jeśli pola tylko do odczytu są ustawione lub jeśli polestate
ma wartość inną niżPENDING
.NOT_FOUND
jeśli podany identyfikator ucznia jest prawidłowy, ale Classroom nie ma informacji o tym uczniu.ALREADY_EXISTS
jeśli dla ucznia i adresuinvitedEmailAddress
istnieje już oczekujące zaproszenie dla opiekuna lub jeśli podany adresinvitedEmailAddress
pasuje do istniejącego konta GoogleGuardian
tego użytkownika.
Żądanie HTTP
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
Parametry | |
---|---|
guardian |
dokument tożsamości ucznia (w standardowym formacie) |
Treść żądania
Treść żądania zawiera wystąpienie elementu GuardianInvitation
.
Treść odpowiedzi
Jeśli operacja się powiedzie, treść odpowiedzi będzie zawierała nowo utworzoną instancję GuardianInvitation
.
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
https://www.googleapis.com/auth/classroom.guardianlinks.students
Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.