Method: userProfiles.guardianInvitations.list

Zwraca listę zaproszeń opiekuna, które użytkownik wysyłający prośbę może wyświetlić, przefiltrowaną według podanych parametrów.

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

  • PERMISSION_DENIED, jeśli określono element studentId, a użytkownik wysyłający prośbę nie może wyświetlać zaproszeń do opiekuna danego ucznia, jeśli "-" jest określony jako studentId, a użytkownik nie jest administratorem domeny, jeśli opiekunowie nie są włączeni w danej domenie, lub w przypadku innych błędów dostępu.
  • INVALID_ARGUMENT, jeśli określono studentId, ale nie można rozpoznać formatu (to nie jest adres e-mail, studentId z interfejsu API ani literał me). Może również zostać zwrócony, jeśli podano nieprawidłową wartość pageToken lub state.
  • NOT_FOUND, jeśli podano studentId i jego format zostanie rozpoznany, ale w Classroom nie ma danych o uczniu.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
studentId

string

Identyfikator ucznia, którego zaproszenia opiekuna mają zostać zwrócone. Może to być jeden z tych identyfikatorów:

  • identyfikator numeryczny użytkownika
  • adres e-mail użytkownika,
  • literał ciągu "me", który wskazuje użytkownika wysyłającego żądanie
  • literał ciągu "-", który wskazuje, że wyniki powinny być zwracane wszystkim uczniom, jeśli użytkownik wysyłający prośbę może zobaczyć zaproszenia opiekuna.

Parametry zapytania

Parametry
invitedEmailAddress

string

Jeśli określisz parametr invitedEmailAddress, zwracane będą tylko wyniki z tą wartością.
states[]

enum (GuardianInvitationState)

Jeśli określisz parametr, zwracane będą tylko wyniki z określonymi wartościami state. W przeciwnym razie zwracane są wyniki z wartością state o wartości PENDING.
pageToken

string

Wartość nextPageToken zwrócona z poprzedniego wywołania list, co oznacza, że powinna zostać zwrócona kolejna strona wyników.

Żądanie list musi być identyczne z żądaniem, które spowodowało wygenerowanie tego tokena.
pageSize

integer

Maksymalna liczba produktów do zwrotu. Wartość 0 lub nieokreślona oznacza, że serwer może przypisać wartość maksymalną.

Serwer może zwrócić mniej wyników niż określona liczba.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź podczas wyświetlania listy zaproszeń dla opiekunów.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "guardianInvitations": [
    {
      object (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
Pola
guardianInvitations[]

object (GuardianInvitation)

Zaproszenia dla opiekunów pasujące do prośby o utworzenie listy.
nextPageToken

string

Token określający następną stronę wyników do zwrócenia. Jeśli pole jest puste, nie są dostępne żadne dalsze wyniki.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.