REST Resource: invitations

資源：Invitation

邀請加入課程。

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

 傳回要求使用者可查看的邀請清單，僅限於符合清單要求的邀請。