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

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

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

גוף הבקשה

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

גוף התגובה

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

היקפי הרשאות

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

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

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