Zwraca listę zaproszeń, które może wyświetlić użytkownik wysyłający prośbę, z ograniczeniem do tych pasujących do żądania listy.
Uwaga: należy podać co najmniej jedną wartość userId
lub courseId
. Możesz wypełnić oba pola.
Ta metoda zwraca następujące kody błędów:
PERMISSION_DENIED
w przypadku błędów dostępu.
Żądanie HTTP
GET https://classroom.googleapis.com/v1/invitations
Adres URL używa składni transkodowania gRPC.
Parametry zapytania
Parametry | |
---|---|
userId |
Ogranicza zwrócone zaproszenia do użytkowników określonego użytkownika. Może on mieć jeden z tych identyfikatorów:
|
courseId |
Ogranicza zwrócone zaproszenia do zajęć o określonym identyfikatorze. |
pageSize |
Maksymalna liczba produktów do zwrócenia. Jeśli wartość nie została podana, domyślna wartość to 500 lub Serwer może zwrócić mniej wyników niż określono. |
pageToken |
Wartość Żądanie |
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
Odpowiedź na listę zaproszeń.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
Zapis JSON |
---|
{
"invitations": [
{
object ( |
Pola | |
---|---|
invitations[] |
Zaproszenia pasujące do żądania listy. |
nextPageToken |
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.rosters
https://www.googleapis.com/auth/classroom.rosters.readonly
Więcej informacji znajdziesz w przewodniku po autoryzacji.