Method: userProfiles.guardianInvitations.create

Tworzy zaproszenie opiekuna i wysyła do opiekuna e-maila z prośbą o potwierdzenie, że jest opiekunem ucznia.

Gdy opiekun zaakceptuje zaproszenie, state zmieni się na COMPLETED i zacznie otrzymywać powiadomienia dla opiekuna. Zostanie też utworzony zasób Guardian reprezentujący aktywnego opiekuna.

Obiekt żądania musi mieć ustawione pola studentId i invitedEmailAddress. Jeśli nie wypełnisz tych pól lub nie ustawisz innych pól w żądaniu, wystąpi błąd.

Zwraca ona następujące kody błędów:

  • PERMISSION_DENIED, jeśli bieżący użytkownik nie ma uprawnień do zarządzania opiekunami, jeśli opiekun odrzucił już zbyt wiele próśb tego ucznia, a opiekunowie nie mają włączonej domeny lub z innego błędu dostępu.
  • RESOURCE_EXHAUSTED, jeśli uczeń lub opiekun przekroczył limit linku dla opiekuna.
  • INVALID_ARGUMENT, jeśli adres e-mail opiekuna jest nieprawidłowy (na przykład jeśli jest zbyt długi) lub jeśli format legitymacji studenckiej nie jest rozpoznawany (nie jest to adres e-mail ani userId w tym interfejsie API). Ten błąd będzie też zwracany, jeśli pola tylko do odczytu albo gdy pole state ma wartość inną niż PENDING.
  • NOT_FOUND, jeśli podany identyfikator ucznia jest prawidłowym legitymacją studencką, ale Classroom nie rejestruje tego ucznia.
  • ALREADY_EXISTS, jeśli zostało już wysłane zaproszenie dla opiekuna ucznia i przesłane invitedEmailAddress lub jeśli podany invitedEmailAddress pasuje do konta Google istniejącego użytkownika Guardian dla 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
guardianInvitation.studentId

string

legitymacja studencka (w formacie standardowym)

Treść żądania

Treść żądania zawiera wystąpienie elementu GuardianInvitation.

Treść odpowiedzi

Jeśli operacja się uda, 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 po autoryzacji.