Method: userProfiles.guardians.delete

מחיקה של אפוטרופוס.

האפוטרופוס לא יקבל יותר התראות לגבי הילד או הילדה, ולא תהיה יותר גישה אליו דרך ה-API.

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

  • PERMISSION_DENIED אם לא מופיע משתמש שמתאים ל-studentId שצוין למשתמש המבקש, אם למשתמש המבקש אין הרשאה לנהל את האפוטרופוסים של התלמיד שצוין ב-studentId, אם האפוטרופוסים לא מופעלים בדומיין הרלוונטי או בגלל שגיאות גישה אחרות.
  • INVALID_ARGUMENT אם צוין studentId, אבל לא ניתן לזהות את הפורמט שלו (הוא לא כתובת אימייל ולא studentId מה-API).
  • NOT_FOUND אם למשתמש המבקש יש הרשאה לשנות את האפוטרופוסים של studentId המבוקש, אבל לא קיים רשומת Guardian של התלמיד/ה עם guardianId שצוין.

בקשת HTTP

DELETE https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}

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

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

פרמטרים
studentId

string

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

  • המזהה המספרי של המשתמש
  • כתובת האימייל של המשתמש
  • מחרוזת הליבה "me", שמציינת את המשתמש המבקש
guardianId

string

השדה id מ-Guardian.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה הוא אובייקט JSON ריק.

היקפי הרשאה

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

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

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