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

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