Method: userProfiles.guardianInvitations.get

Zwraca zaproszenie do konkretnego opiekuna.

Ta metoda zwraca te kody błędów:

  • PERMISSION_DENIED jeśli użytkownik nie ma uprawnień do wyświetlania zaproszeń dla opiekuna ucznia z identyfikatorem studentId, jeśli opiekunowie nie są włączeni w przypadku danej domeny lub z innych błędów dostępu.
  • INVALID_ARGUMENT, jeśli podano wartość studentId, ale nie można rozpoznać jej formatu (nie jest to adres e-mail, studentId z interfejsu API ani ciąg znaków me).
  • NOT_FOUND, jeśli Classroom nie może znaleźć żadnych informacji o danym uczniu, lub invitationId. Może też zostać zwrócony, jeśli uczeń istnieje, ale użytkownik przesyłający prośbę nie ma dostępu do tego ucznia.

Żądanie HTTP

GET 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 opiekuna ma dotyczyć zaproszenie.

invitationId

string

Pole id żądanego zasobu GuardianInvitation.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu GuardianInvitation.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.