Method: userProfiles.guardianInvitations.list

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

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

  • PERMISSION_DENIED, jeśli określono studentId, a użytkownik wysyłający prośbę nie może wyświetlić zaproszeń dla opiekunów, jeśli "-" jest określony jako studentId, a użytkownik nie jest administratorem domeny, jeśli w danej domenie opiekun nie jest włączony, 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, nie jest to adres e-mail ani studentId z interfejsu API ani ciąg literału me). Ten parametr może też być zwracany, jeśli podana jest nieprawidłowa wartość pageToken lub state.
  • NOT_FOUND, jeśli określono studentId i można rozpoznać jego format, ale Classroom nie zawiera informacji o tym 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 mają zostać zwrócone. Może on mieć jeden z tych identyfikatorów:

  • identyfikator numeryczny użytkownika
  • adres e-mail użytkownika.
  • literał ciągu znaków "me" wskazujący użytkownika wysyłającego żądanie
  • literał ciągu "-", który wskazuje, że powinny zostać zwrócone wyniki dla wszystkich uczniów, którzy mogą wyświetlać zaproszenia dla opiekunów.

Parametry zapytania

Parametry
invitedEmailAddress

string

Jeśli jest określony, zwracane są tylko wyniki z podanym elementem invitedEmailAddress.
states[]

enum (GuardianInvitationState)

Jeśli jest określony, zwracane są 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, która wskazuje, że powinna zostać zwrócona kolejna strona z wynikami.

Żądanie list musi być w inny sposób identyczne z żądaniem, które spowodowało ten token.
pageSize

integer

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

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

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na listę 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 opiekunów, które pasują do żądania listy.
nextPageToken

string

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

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.