Method: userProfiles.guardianInvitations.list

מחזירה רשימה של הזמנות לאפוטרופוסים שהמשתמש המבקש רשאי להציג, לאחר סינון לפי הפרמטרים שצוינו.

השיטה הזו מחזירה את קודי השגיאה הבאים:

  • 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

string

התעודה המזהה של התלמיד שיש להחזיר את הזמנות האפוטרופוס שלו. המזהה יכול להיות אחד מהבאים:

  • המזהה המספרי של המשתמש
  • כתובת האימייל של המשתמש
  • ליטרל המחרוזת "me", שמציין את המשתמש ששלח את הבקשה
  • ליטרל המחרוזת "-", כדי לציין שיש להחזיר תוצאות לכל התלמידים שהמשתמש ששלח את הבקשה מורשה להציג הזמנות של אפוטרופוסים.

פרמטרים של שאילתה

פרמטרים
invitedEmailAddress

string

אם צוין, יוחזרו רק תוצאות עם הערך invitedEmailAddress שצוין.
states[]

enum (GuardianInvitationState)

אם צוין, יוחזרו רק תוצאות עם ערכי state שצוינו. אחרת, יוחזרו תוצאות עם state של PENDING.
pageToken

string

הערך nextPageToken הוחזר מקריאה קודמת של list. הערך מציין שצריך להחזיר את דף התוצאות הבא.

בכל מקרה אחר, הבקשה של list צריכה להיות זהה לבקשה שהובילה לאסימון הזה.
pageSize

integer

מספר הפריטים המרבי להחזרה. הערך 'אפס' או 'לא צוין' מציין שהשרת עשוי להקצות ערך מקסימלי.

השרת עשוי להחזיר פחות ממספר התוצאות שצוין.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התגובה

תגובה שכוללת הזמנות לאפוטרופוסים.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג JSON 
{
  "guardianInvitations": [
    {
      object (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
שדות
guardianInvitations[]

object (GuardianInvitation)

הזמנות לאפוטרופוסים שתאמו לבקשת הרשימה.
nextPageToken

string

אסימון שמזהה את הדף הבא של התוצאות שיוחזרו. אם השדה ריק, אין תוצאות נוספות זמינות.

היקפי הרשאות

כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

למידע נוסף, ניתן לעיין במדריך ההרשאות.