מחזירה רשימה של הזמנות שהמשתמש ששלח את הבקשה רשאי להציג, מוגבל להזמנות שתואמות לבקשת הרשימה.
הערה: יש לספק לפחות אחד מהערכים userId
או courseId
. אפשר לספק את שני השדות.
השיטה הזו מחזירה את קודי השגיאה הבאים:
PERMISSION_DENIED
עבור שגיאות גישה.
בקשת HTTP
GET https://classroom.googleapis.com/v1/invitations
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
userId |
הגבלת הזמנות מוחזרות לאלה של משתמש מסוים. המזהה יכול להיות אחד מהבאים:
|
courseId |
הגבלת הזמנות מוחזרות לקורס עם המזהה שצוין. |
pageSize |
מספר הפריטים המרבי להחזרה. אם לא צוין השרת עשוי להחזיר פחות ממספר התוצאות שצוין. |
pageToken |
הערך בכל מקרה אחר, הבקשה של |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
תגובה במהלך הצגת ההזמנות.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{
"invitations": [
{
object ( |
שדות | |
---|---|
invitations[] |
הזמנות שתואמות לבקשת הרשימה. |
nextPageToken |
אסימון שמזהה את הדף הבא של התוצאות שיוחזרו. אם השדה ריק, אין תוצאות נוספות זמינות. |
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:
https://www.googleapis.com/auth/classroom.rosters
https://www.googleapis.com/auth/classroom.rosters.readonly
למידע נוסף, ניתן לעיין במדריך ההרשאות.