Method: userProfiles.guardians.get

Zwraca konkretnego opiekuna.

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

  • PERMISSION_DENIED, jeśli żaden użytkownik pasujący do podanego adresu studentId nie jest widoczny dla użytkownika wysyłającego prośbę, użytkownik wysyłający prośbę nie może wyświetlić informacji o opiekunie ucznia wskazanego przez studentId, jeśli opiekunowie nie są włą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 użytkownik wysyłający prośbę może wyświetlać listę opiekunów w imieniu wybranego studentId, ale w przypadku tego ucznia nie ma rekordu Guardian, który pasuje do podanej wartości guardianId.

Żądanie HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
studentId

string

Uczeń, którego została wysłana prośba o opiekuna. Jedna z tych wersji:

  • identyfikator numeryczny użytkownika
  • adres e-mail użytkownika.
  • literał ciągu znaków "me" wskazujący użytkownika wysyłającego żądanie
guardianId

string

Pole id z tabeli Guardian.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
  • 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.