Method: courses.students.delete

دانشجوی یک درس را حذف می کند.

این روش کدهای خطای زیر را برمی گرداند:

  • PERMISSION_DENIED اگر کاربر درخواست کننده مجاز به حذف دانشجویان این دوره یا خطاهای دسترسی نباشد.
  • NOT_FOUND اگر هیچ دانشجوی این دوره شناسه درخواستی را نداشته باشد یا دوره وجود نداشته باشد.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
courseId

string

شناسه دوره این شناسه می تواند شناسه اختصاص داده شده توسط Classroom یا alias باشد.

userId

string

شناسه دانش آموز برای حذف. شناسه می تواند یکی از موارد زیر باشد:

  • شناسه عددی برای کاربر
  • آدرس ایمیل کاربر
  • رشته تحت اللفظی "me" که کاربر درخواست کننده را نشان می دهد

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ خالی است.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.