Method: userProfiles.guardianInvitations.list

Zwraca listę zaproszeń do grupy opiekunów, które użytkownik może wyświetlić, posortowane według podanych parametrów.

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

  • PERMISSION_DENIED, jeśli podano studentId, a użytkownik nie ma uprawnień do wyświetlania zaproszeń dla opiekunów danego ucznia, jeśli "-" jest podany 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 podano wartość studentId, ale jej format nie może zostać rozpoznany (nie jest to adres e-mail, ani studentId z interfejsu API, ani ciąg znaków me). Może być zwracany również w przypadku podania nieprawidłowej wartości pageToken lub state.
  • NOT_FOUND jeśli podano studentId i można 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 zaproszenia do opiekuna mają zostać zwrócone. Identyfikator może być jednym z tych elementów:

  • identyfikator liczbowy użytkownika;
  • adres e-mail użytkownika.
  • ciąg znaków "me" wskazujący użytkownika, który wysłał żądanie;
  • litera ciąg znaków "-", która wskazuje, że wyniki powinny być zwracane dla wszystkich uczniów, których użytkownik może wyświetlać zaproszenia od opiekuna.

Parametry zapytania

Parametry
invitedEmailAddress

string

Jeśli jest określony, zwracane są tylko wyniki z określonym 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 state PENDING.
pageToken

string

Wartość nextPageToken zwrócona z poprzedniego wywołania list, wskazująca, że należy zwrócić kolejną stronę wyników.

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

integer

Maksymalna liczba elementów do zwrócenia. Wartość 0 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ź podczas wyświetlania listy zaproszeń dla opiekuna

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

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

object (GuardianInvitation)

zaproszenia opiekuna, które pasują do żądania listy;
nextPageToken

string

Token identyfikujący następną stronę wyników do zwrócenia. Jeśli jest puste, nie ma dostępnych dalszych wyników.

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 dotyczącym autoryzacji.