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

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