Method: userProfiles.guardianInvitations.create

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

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

אחרי שהאפוטרופוס יאשר את ההזמנה, הערך של state ישתנה ל-COMPLETED והוא יתחיל לקבל התראות לאפוטרופוסים. ייווצר גם משאב Guardian שמייצג את האפוטרופוס הפעיל.

צריך להגדיר את השדות studentId ו-invitedEmailAddress באובייקט הבקשה. אי הגדרה של השדות האלה או הגדרה של שדות אחרים בבקשה תוביל לשגיאה.

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

• PERMISSION_DENIED אם למשתמש הנוכחי אין הרשאה לנהל הורים או אפוטרופוסים, אם האפוטרופוס הרלוונטי כבר דחה יותר מדי בקשות עבור התלמיד או התלמידה האלה, אם הורים או אפוטרופוסים לא מופעלים בדומיין הרלוונטי או בגלל שגיאות גישה אחרות.
• RESOURCE_EXHAUSTED אם התלמיד או האפוטרופוס חרג מהמגבלה של קישורים לאפוטרופוסים.
• INVALID_ARGUMENT אם כתובת האימייל של האפוטרופוס לא תקינה (למשל, אם היא ארוכה מדי), או אם לא ניתן לזהות את הפורמט של תעודת הסטודנט שסופקה (היא לא כתובת אימייל ולא userId מ-API הזה). השגיאה הזו תוחזר גם אם מגדירים שדות לקריאה בלבד, או אם השדה state מוגדר לערך שאינו PENDING.
• NOT_FOUND אם מזהה התלמיד שסופק הוא מזהה תלמיד תקין, אבל אין ב-Classroom תיעוד של התלמיד הזה.
• ALREADY_EXISTS אם כבר יש הזמנה בהמתנה לאפוטרופוס של התלמיד או התלמידה עם invitedEmailAddress שצוין, או אם invitedEmailAddress שצוין תואם לחשבון Google של Guardian קיים של המשתמש הזה.

בקשת HTTP

POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations

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

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

פרמטרים
guardianInvitation.studentId	string מזהה התלמיד/ה (בפורמט רגיל)

גוף הבקשה

גוף הבקשה מכיל מופע של GuardianInvitation.

גוף התשובה

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

היקפי הרשאה

נדרש היקף הרשאות OAuth הבא:

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

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