Method: userProfiles.guardianInvitations.patch

Modyfikuje zaproszenie opiekuna.

Obecnie jedyną poprawną modyfikacją jest zmiana parametru state z PENDING na COMPLETE. Zaproszenie zostanie w ten sposób wycofane.

Ta metoda zwraca następujące kody błędów:

  • PERMISSION_DENIED, jeśli bieżący użytkownik nie ma uprawnień do zarządzania opiekunami, a opiekun nie jest włączony w danej domenie lub występują inne błędy dostępu.
  • FAILED_PRECONDITION, jeśli link opiekuna nie jest w stanie PENDING.
  • INVALID_ARGUMENT, jeśli nie można rozpoznać formatu podanej legitymacji studenckiej (nie jest to adres e-mail ani userId z tego interfejsu API) lub jeśli przekazany GuardianInvitation ma state inny niż COMPLETE lub zmienia pola inne niż state.
  • NOT_FOUND, jeśli podany legitymacja studencka jest prawidłową legitymacją studencką, ale Classroom nie ma informacji o tym, kto jest uczniem, lub jeśli pole id nie odnosi się do zaproszenia opiekuna znanego w Classroom.

Żądanie HTTP

PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
studentId

string

Identyfikator ucznia, którego zaproszenie opiekuna ma zostać zmodyfikowane.
invitationId

string

Pole id elementu GuardianInvitation do zmodyfikowania.

Parametry zapytania

Parametry
updateMask

string (FieldMask format)

Maska identyfikująca pola na kursie, które mają zostać zaktualizowane. To pole jest wymagane do przeprowadzenia aktualizacji. Aktualizacja nie powiedzie się, jeśli podasz nieprawidłowe pola. Te pola są prawidłowe:

  • state

Po ustawieniu parametru zapytania to pole powinno być określone jako

updateMask=<field1>,<field2>,...

Jest to lista rozdzielonych przecinkami pełnych i jednoznacznych nazw pól. Przykład: "user.displayName,photo".

Treść żądania

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

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu 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.