Method: userProfiles.guardianInvitations.list

Zwraca listę zaproszeń opiekunów, które może wyświetlać 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świetlać zaproszeń do opiekunów w przypadku tego ucznia, jeśli "-" jest określony jako studentId, a użytkownik nie jest administratorem domeny, w przypadku braku włączonych opiekunów w danej domenie lub z powodu innych błędów dostępu.
  • INVALID_ARGUMENT, jeśli element studentId został określony, ale nie można rozpoznać jego formatu (nie jest to adres e-mail, studentId z interfejsu API ani ciąg literału me). Może też zostać zwrócona, jeśli podana jest nieprawidłowa wartość pageToken lub state.
  • NOT_FOUND, jeśli określono studentId i udało się rozpoznać jego format, ale Classroom nie ma 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 mają zostać zwrócone zaproszenia opiekuna. Może on być:

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

Parametry zapytania

Parametry
invitedEmailAddress

string

Jeśli jest określony, zwracane są tylko wyniki z określonym parametrem 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 wyników.

Żądanie list musi być pod innymi względami identyczne z żądaniem, które wygenerowało ten token.
pageSize

integer

Maksymalna liczba elementów do zwrócenia. Wartość 0 lub nieokreślona oznacza, że serwer może przypisać maksimum.

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

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 identyfikują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.