Method: userProfiles.guardianInvitations.patch

تعديل دعوة وصي

في الوقت الحالي، التعديل الوحيد المسموح به هو تغيير state من PENDING إلى COMPLETE. يؤدي ذلك إلى سحب الدعوة.

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

  • PERMISSION_DENIED إذا لم يكن لدى المستخدم الحالي إذن لإدارة الأوصياء، أو إذا لم يتم تفعيل الأوصياء للنطاق المعنيّ، أو بسبب أخطاء وصول أخرى
  • FAILED_PRECONDITION إذا لم يكن رابط الوصي في الحالة PENDING.
  • INVALID_ARGUMENT إذا تعذّر التعرّف على تنسيق مستند تعريف الطالب المقدَّم (ليس عنوان بريد إلكتروني أو userId من واجهة برمجة التطبيقات هذه)، أو إذا كان GuardianInvitation الذي تم تمريره يحتوي على state غير COMPLETE، أو إذا كان يعدّل حقولًا غير state.
  • NOT_FOUND إذا كان رقم تعريف الطالب المقدَّم صالحًا، ولكن لا يتضمّن Classroom سجلّاً لهذا الطالب، أو إذا كان الحقل id لا يشير إلى دعوة وصي معروفة في Classroom

طلب HTTP

PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
studentId

string

رقم تعريف الطالب المطلوب تعديل دعوة الوصي له.
invitationId

string

حقل id في GuardianInvitation المطلوب تعديله

مَعلمات طلب البحث

المعلمات
updateMask

string (FieldMask format)

قناع يحدّد الحقول التي يجب تعديلها في الدورة التدريبية هذا الحقل مطلوب لإجراء تعديل. يتعذّر إجراء التعديل في حال تحديد حقول غير صالحة. الحقول التالية صالحة:

  • state

عند ضبط هذا الحقل في مَعلمة طلب بحث، يجب تحديده على النحو التالي:

updateMask=<field1>,<field2>,...

هذه قائمة مفصولة بفواصل تتضمّن أسماء حقول مؤهَّلة بالكامل. مثال: "user.displayName,photo"

نص الطلب

يحتوي نص الطلب على مثال GuardianInvitation.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال GuardianInvitation.

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

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

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

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