REST Resource: invitations

• 資源：邀請
  • JSON 表示法
• CourseRole
• 方法

資源：邀請

加入課程的邀請。

JSON 表示法
{ "id": string, "userId": string, "courseId": string, "role": enum (CourseRole) }

欄位
id	string Classroom 指派的 ID。 唯讀。
userId	string 受邀使用者的 ID。 如果指定為要求的參數，這個 ID 可設為下列其中一個值： 使用者的數字 ID 使用者的電子郵件地址 字串常值 "me"，表示提出要求的使用者
courseId	string 邀請使用者加入的課程 ID。
role	enum (CourseRole) 邀請使用者取得的角色。不得為 COURSE_ROLE_UNSPECIFIED。

CourseRole

使用者可能具備的邀請角色。

列舉
COURSE_ROLE_UNSPECIFIED	沒有課程角色。
STUDENT	課程中的學生。
TEACHER	課程老師。
OWNER	課程擁有者。

方法
accept	接受邀請、移除邀請，並視情況將受邀的使用者新增至指定課程的老師或學生。
create	建立邀請。
delete	刪除邀請。
get	傳回邀請。
list	傳回允許提出要求的使用者檢視的邀請清單，且只限符合清單要求的使用者。