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 Transcode.

معلّمات المسار

المعلّمات
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

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