Method: userProfiles.guardians.delete

لحذف وصي

لن يتلقّى الوصي بعد ذلك إشعارات الوصي ولن يعود بالإمكان الوصول إليه من خلال واجهة برمجة التطبيقات.

تُرجع هذه الطريقة رموز الأخطاء التالية:

  • PERMISSION_DENIED إذا لم يكن هناك مستخدم يتطابق مع studentId المقدَّم مرئيًا للمستخدم المُقدّم للطلب، أو إذا لم يكن المستخدم المُقدّم للطلب مسموحًا له بإدارة الأوصياء للطالب المحدَّد من خلال studentId، أو إذا لم يتم تفعيل الأوصياء للنطاق المعنيّ، أو أخطاء وصول أخرى.
  • INVALID_ARGUMENT إذا تم تحديد studentId، ولكن لا يمكن التعرّف على تنسيقه (ليس عنوان بريد إلكتروني، ولا studentId من واجهة برمجة التطبيقات).
  • 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

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يكون نص الاستجابة هو عنصر JSON فارغ.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.