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

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