Method: userProfiles.guardianInvitations.get

הפונקציה מחזירה הזמנה ספציפית להורה או לאפוטרופוס.

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

  • PERMISSION_DENIED אם למשתמש המבקש אין הרשאה להציג הזמנות לאפוטרופוסים של התלמיד או התלמידה שזוהו לפי studentId, אם לאפוטרופוסים אין הרשאה לדומיין הרלוונטי או בגלל שגיאות גישה אחרות.
  • INVALID_ARGUMENT אם צוין studentId, אבל לא ניתן לזהות את הפורמט שלו (הוא לא כתובת אימייל, לא studentId מה-API ולא המחרוזת המילולית me).
  • NOT_FOUND אם מערכת Classroom לא מצליחה למצוא תיעוד של התלמיד או התלמידה הנתונים, או invitationId. יכול להיות שהקוד הזה יופיע גם אם התלמיד או התלמידה קיימים, אבל למשתמש המבקש אין גישה לראות אותם.

בקשת HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
studentId

string

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

string

השדה id של ה-GuardianInvitation המבוקש.

גוף הבקשה

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

גוף התשובה

אם הפעולה מצליחה, גוף התגובה מכיל מופע של GuardianInvitation.

היקפי הרשאה

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

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

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