إنشاء دعوة للأوصياء وإرسال رسالة إلكترونية إليهم لتأكيد أنّهم الأوصياء على الطالب
بعد قبول الوصي الدعوة، ستتغيّر حالته إلى state
ويبدأ تلقّي إشعارات الوصي.COMPLETED
سيتم أيضًا إنشاء مرجع Guardian
لتمثيل الوصي النشط.
يجب ضبط الحقلين studentId
وinvitedEmailAddress
في عنصر الطلب. سيؤدي عدم ضبط هذه الحقول أو ضبط أي حقول أخرى في الطلب إلى حدوث خطأ.
تُرجع هذه الطريقة رموز الأخطاء التالية:
PERMISSION_DENIED
إذا لم يكن لدى المستخدم الحالي إذن لإدارة الأوصياء، أو إذا رفض الوصي المعنيّ عددًا كبيرًا جدًا من الطلبات لهذا الطالب، أو إذا لم يتم تفعيل الأوصياء في النطاق المعنيّ، أو بسبب أخطاء وصول أخرى.RESOURCE_EXHAUSTED
إذا تجاوز الطالب أو ولي الأمر الحد الأقصى لعدد روابط الحسابات التي يمكن لولي الأمر الوصول إليهاINVALID_ARGUMENT
إذا لم يكن عنوان البريد الإلكتروني الخاص بأحد الوصيّين صالحًا (على سبيل المثال، إذا كان طويلاً جدًا)، أو إذا تعذّر التعرّف على تنسيق مستند تعريف الطالب المقدَّم (ليس عنوان بريد إلكتروني، ولاuserId
من واجهة برمجة التطبيقات هذه). سيتم أيضًا عرض هذا الخطأ في حال ضبط حقول للقراءة فقط أو في حال ضبط الحقلstate
على قيمة غيرPENDING
.NOT_FOUND
إذا كان رقم تعريف الطالب الذي تم تقديمه صالحًا، ولكن لا يتضمّن Classroom سجلّاً لهذا الطالبALREADY_EXISTS
إذا كانت هناك دعوة وصي في انتظار المراجعة للطالب وinvitedEmailAddress
المقدَّمة، أو إذا كانinvitedEmailAddress
المقدَّم يتطابق مع حساب Google الخاص بأحدGuardian
الحاليين لهذا المستخدم.
طلب HTTP
POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المعلمات | |
---|---|
guardianInvitation.studentId |
رقم تعريف الطالب (بالتنسيق العادي) |
نص الطلب
يحتوي نص الطلب على مثال GuardianInvitation
.
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثيل تم إنشاؤه حديثًا من GuardianInvitation
.
نطاقات التفويض
يجب توفير نطاق OAuth التالي:
https://www.googleapis.com/auth/classroom.guardianlinks.students
لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.