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 باشد.

نقش دوره

نقش‌های احتمالی که ممکن است از یک کاربر دعوت شود.

Enums
COURSE_ROLE_UNSPECIFIED بدون نقش دوره
STUDENT دانشجو در دوره
TEACHER مدرس دوره.
OWNER صاحب دوره.

روش ها

accept

 دعوت نامه را می پذیرد، آن را حذف می کند و کاربر دعوت شده را به معلمان یا دانش آموزان (در صورت لزوم) دوره مشخص شده اضافه می کند.

create

 دعوتنامه ایجاد می کند.

delete

 یک دعوت نامه را حذف می کند.

get

 یک دعوت نامه را برمی گرداند.

list

 فهرستی از دعوت‌نامه‌هایی را برمی‌گرداند که کاربر درخواست‌کننده مجاز به مشاهده آن‌ها است، محدود به دعوت‌هایی که با درخواست فهرست مطابقت دارند.