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

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

المعلّمات
guardianInvitation.studentId

string

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

نص الطلب

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

نص الاستجابة

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

نطاقات الأذونات

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

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

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