REST Resource: invitations

• المورد: دعوة
  • تمثيل JSON
• دور الدورة التدريبية
• الطُرق

المورد: دعوة

دعوة للانضمام إلى دورة تدريبية

تمثيل JSON
{ "id": string, "userId": string, "courseId": string, "role": enum (CourseRole) }

الحقول
id	string المعرّف الذي تم تعيينه بواسطة Classroom. للقراءة فقط.
userId	string معرّف المستخدم المدعو. عند تحديده كمَعلمة في طلب، يمكن ضبط هذا المعرّف على أي مما يلي: المعرّف الرقمي للمستخدم عنوان البريد الإلكتروني للمستخدم السلسلة الحرفية "me"، للإشارة إلى المستخدم صاحب الطلب
courseId	string معرّف الدورة التدريبية لدعوة المستخدم إليها.
role	enum (CourseRole) دور لدعوة المستخدم. يجب ألا تكون القيمة COURSE_ROLE_UNSPECIFIED.

دور الدورة التدريبية

الأدوار المحتملة التي قد يدعوها المستخدم.

عمليات التعداد
COURSE_ROLE_UNSPECIFIED	ليس هناك دور في الدورة التدريبية.
STUDENT	طالب في الدورة التدريبية.
TEACHER	معلّم الدورة التدريبية.
OWNER	مالك الدورة التدريبية.

الطُرق
accept	يقبل الدعوة ويزيلها ويضيف المستخدم الذي تمت دعوته إلى المعلمين أو الطلاب (حسب الاقتضاء) في الدورة التدريبية المحددة.
create	لإنشاء دعوة.
delete	لحذف دعوة.
get	لعرض دعوة.
list	لعرض قائمة بالدعوات التي يُسمح للمستخدم صاحب الطلب بعرضها، مقصورة على الدعوات التي تتطابق مع طلب القائمة.