Method: courses.students.delete

מחיקה של תלמיד או תלמידה מקורס.

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

  • PERMISSION_DENIED אם למשתמש המבקש אין הרשאה למחוק תלמידים מהקורס הזה, או בגלל שגיאות גישה.
  • NOT_FOUND אם לאף תלמיד בקורס הזה אין את התעודה המזהה המבוקשת או אם הקורס לא קיים.

בקשת HTTP

DELETE https://classroom.googleapis.com/v1/courses/{courseId}/students/{userId}

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

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

פרמטרים
courseId

string

המזהה של הקורס. המזהה הזה יכול להיות המזהה שהוקצה ב-Classroom או alias.
userId

string

המזהה של התלמיד/ה שרוצים למחוק. המזהה יכול להיות אחד מהערכים הבאים:

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאה

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

  • https://www.googleapis.com/auth/classroom.rosters

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