Method: userProfiles.guardianInvitations.get

Zwraca określone zaproszenie opiekuna.

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

  • PERMISSION_DENIED, jeśli użytkownik wysyłający prośbę nie ma uprawnień do wyświetlenia zaproszeń do opiekunów związanych z uczniem określonym przez studentId, gdy opiekunowie są wyłączony w danej domenie, lub z powodu innych błędów dostępu.
  • INVALID_ARGUMENT, jeśli określono studentId, ale nie można rozpoznać jego formatu (nie jest to adres e-mail, studentId z interfejsu API ani ciąg literału me).
  • NOT_FOUND, jeśli Classroom nie może znaleźć żadnego wpisu dotyczącego danego ucznia lub invitationId. Element może być też zwracany, jeśli uczeń istnieje, ale użytkownik, który wysłał prośbę, nie ma uprawnień do wyświetlania 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 wysłano prośbę o zaproszenie opiekuna.
invitationId

string

Pole id żądanego 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 po autoryzacji.