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 משתמשת בתחביר של Transcoding של 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

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