Method: userProfiles.guardianInvitations.create

يتم إنشاء دعوة للوصي وإرسال رسالة إلكترونية إليه يُطلب منه فيها تأكيد أنّه الوصي على الطالب.

بعد قبول الوصي الدعوة، ستتغيّر حالته إلى 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

string

رقم تعريف الطالب (بالتنسيق العادي)

نص الطلب

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

نص الاستجابة

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

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

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

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

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