Method: userProfiles.guardianInvitations.patch

Modyfikuje zaproszenie do opiekuna.

Obecnie jedyną możliwą modyfikacją jest zmiana wartości parametru state z PENDING na COMPLETE. W efekcie spowoduje to wycofanie zaproszenia.

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 opiekunowie nie są włączeni w danej domenie lub z powodu innych błędów dostępu.
  • FAILED_PRECONDITION, jeśli link opiekuna nie jest w stanie PENDING.
  • INVALID_ARGUMENT, jeśli nie można rozpoznać formatu podanego identyfikatora ucznia (nie jest to adres e-mail ani identyfikator userId z tego interfejsu API), jeśli przekazany identyfikator GuardianInvitation ma wartość state inną niż COMPLETE lub jeśli modyfikuje pola inne niż state.
  • NOT_FOUND jeśli podany identyfikator ucznia jest prawidłowy, ale Classroom nie ma informacji o tym uczniu, 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 do opiekuna ma zostać zmienione.
invitationId

string

Pole id obiektu GuardianInvitation, które ma zostać zmodyfikowane.

Parametry zapytania

Parametry
updateMask

string (FieldMask format)

Maska, która określa, które pola kursu należy zaktualizować. To pole jest wymagane do przeprowadzenia aktualizacji. Jeśli podasz nieprawidłowe pola, aktualizacja się nie powiedzie. Te pola są prawidłowe:

  • state

Gdy to pole jest ustawione w parametrze zapytania, powinno być określone jako

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

Jest to lista pełnych nazw pól rozdzielona przecinkami. 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 dotyczącym autoryzacji.