REST Resource: invitations

المورد: دعوة

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

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

string

المعرّف الذي تم تعيينه من خلال Classroom.

للقراءة فقط.
userId

string

معرِّف المستخدم الذي تمت دعوته.

عند تحديد هذا المعرّف كمَعلمة للطلب، يمكن ضبطه على إحدى القيم التالية:

  • المعرّف الرقمي للمستخدم
  • عنوان البريد الإلكتروني للمستخدم
  • السلسلة الحرفية "me"، للإشارة إلى المستخدم صاحب الطلب
courseId

string

تشير هذه السمة إلى معرّف الدورة التدريبية المطلوب دعوة المستخدم إليها.
role

enum (CourseRole)

دور لدعوة المستخدم للحصول عليه. يجب ألا يكون COURSE_ROLE_UNSPECIFIED.

CourseRole

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

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

الطُرق

accept

 قبول الدعوة وإزالتها وإضافة المستخدم الذي تمت دعوته إلى المعلّمين أو الطلاب (حسب الاقتضاء) في الدورة التدريبية المحدّدة.

create

 ينشئ دعوة.

delete

 حذف دعوة

get

 تعرض دعوة.

list

 عرض قائمة بالدعوات التي يُسمح للمستخدم صاحب الطلب بالاطّلاع عليها، وتقتصر على الدعوات التي تطابق طلب القائمة.