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

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