Method: userProfiles.guardians.delete

یک قیم را حذف می کند.

سرپرست دیگر اعلان‌های قیم را دریافت نخواهد کرد و نگهبان دیگر از طریق API قابل دسترسی نخواهد بود.

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

  • PERMISSION_DENIED اگر هیچ کاربری مطابق با studentId ارائه‌شده برای کاربر درخواست‌کننده قابل مشاهده نباشد، اگر کاربر درخواست‌کننده اجازه مدیریت سرپرستان دانش‌آموز شناسایی‌شده توسط studentId را نداشته باشد، اگر سرپرستان برای دامنه مورد نظر فعال نشده باشند، یا برای سایر خطاهای دسترسی ، PERMISSION_DENIED.
  • اگر studentId مشخص شده باشد، INVALID_ARGUMENT ، اما قالب آن قابل شناسایی نیست (آدرس ایمیل نیست، و studentId از API نیست).
  • NOT_FOUND اگر کاربر درخواست کننده مجاز باشد سرپرستان studentId درخواستی را تغییر دهد، اما هیچ سابقه Guardian برای آن دانش آموز با guardianId ارائه شده وجود ندارد.

درخواست HTTP

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

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

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

پارامترها
studentId

string

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

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

string

فیلد id از یک Guardian .

درخواست بدن

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

بدن پاسخگو

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

محدوده مجوز

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

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

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