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

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

פרמטרים
studentId

string

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

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

string

השדה id מתוך Guardian.

גוף הבקשה

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

גוף התגובה

אם הביצוע יהיה תקין, גוף התגובה יהיה ריק.

היקפי הרשאות

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

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

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