מחזירה רשימה של הזמנות לאפוטרופוסים שהמשתמש המבקש רשאי להציג, לאחר סינון לפי הפרמטרים שצוינו.
השיטה הזו מחזירה את קודי השגיאה הבאים:
PERMISSION_DENIED
אם צויןstudentId
, והמשתמש ששלח את הבקשה לא מורשה להציג הזמנות של אפוטרופוסים של התלמיד/ה, אם"-"
צוין בתורstudentId
והמשתמש הוא לא מנהל הדומיין, אם אפוטרופוסים לא מופעלים בדומיין הרלוונטי או אם יש שגיאות גישה אחרות.INVALID_ARGUMENT
אם צויןstudentId
, אבל לא ניתן לזהות את הפורמט שלו (זו אינה כתובת אימייל, וגם לאstudentId
מה-API, או המחרוזת המילוליתme
). ייתכן שיוחזר גם הערך אם סופקוpageToken
אוstate
לא חוקיים.NOT_FOUND
אם צויןstudentId
וניתן לזהות את הפורמט שלו, אבל ב-Classroom אין תיעוד של התלמיד/ה.
בקשת HTTP
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
studentId |
התעודה המזהה של התלמיד שיש להחזיר את הזמנות האפוטרופוס שלו. המזהה יכול להיות אחד מהבאים:
|
פרמטרים של שאילתה
פרמטרים | |
---|---|
invitedEmailAddress |
אם צוין, יוחזרו רק תוצאות עם הערך |
states[] |
אם צוין, יוחזרו רק תוצאות עם ערכי |
pageToken |
הערך בכל מקרה אחר, הבקשה של |
pageSize |
מספר הפריטים המרבי להחזרה. הערך 'אפס' או 'לא צוין' מציין שהשרת עשוי להקצות ערך מקסימלי. השרת עשוי להחזיר פחות ממספר התוצאות שצוין. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
תגובה שכוללת הזמנות לאפוטרופוסים.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{
"guardianInvitations": [
{
object ( |
שדות | |
---|---|
guardianInvitations[] |
הזמנות לאפוטרופוסים שתאמו לבקשת הרשימה. |
nextPageToken |
אסימון שמזהה את הדף הבא של התוצאות שיוחזרו. אם השדה ריק, אין תוצאות נוספות זמינות. |
היקפי הרשאות
כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
למידע נוסף, ניתן לעיין במדריך ההרשאות.