Method: userProfiles.guardianInvitations.patch

שינוי ההזמנה של האפוטרופוס.

השינוי החוקי היחיד הוא לשנות את state מ-PENDING ל-COMPLETE. פעולה זו מובילה לביטול ההזמנה.

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

  • PERMISSION_DENIED אם למשתמש הנוכחי אין הרשאה לנהל אפוטרופוסים, אם האפוטרופוסים לא מופעלים בדומיין הרלוונטי או אם לא הופעלו שגיאות גישה אחרות.
  • FAILED_PRECONDITION אם הקישור לאפוטרופוס לא נמצא במצב PENDING.
  • INVALID_ARGUMENT אם לא ניתן לזהות את הפורמט של מזהה הסטודנט שצוין (זו לא כתובת אימייל ולא userId מה-API הזה), או אם השדה GuardianInvitation שהועבר מכיל state שאינו COMPLETE, או אם השדה משנה שדות שאינם state.
  • NOT_FOUND אם מזהה התלמיד שסופק הוא מזהה תלמיד תקין, אבל אין ב-Classroom תיעוד של אותו תלמיד/ה, או אם השדה id לא מתייחס להזמנת אפוטרופוס שידועה ל-Classroom.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

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

פרמטרים
studentId

string

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

string

השדה id של GuardianInvitation שצריך לשנות.

פרמטרים של שאילתה

פרמטרים
updateMask

string (FieldMask format)

הוספת מסכה שמזהה אילו שדות בקורס יש לעדכן. השדה הזה נדרש לצורך ביצוע עדכון. העדכון ייכשל אם יצוינו שדות לא חוקיים. השדות הבאים חוקיים:

  • state

כששדה זה מוגדר בפרמטר של שאילתה, יש לציין אותו כך:

updateMask=<field1>,<field2>,...

זוהי רשימה של שמות שדות מלאים, שמופרדים בפסיקים. דוגמה: "user.displayName,photo"

גוף הבקשה

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

גוף התגובה

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

היקפי הרשאות

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

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

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