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 משתמשת בתחביר של Transcoding של 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

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