Method: userProfiles.guardianInvitations.get

• בקשת HTTP
• פרמטרים של נתיב
• גוף הבקשה
• גוף התשובה
• היקפי הרשאות
• רוצים לנסות?

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

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

• 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 נעשה שימוש בתחביר המרת 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

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