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

لمزيد من المعلومات، راجِع دليل التفويض.