REST Resource: invitations

資源:邀請

加入課程的邀請。

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

string

Classroom 指派的 ID。

唯讀。

userId

string

受邀使用者的 ID。

將 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

傳回提出要求的使用者能看到的邀請清單,僅限符合清單要求的參與者。