REST Resource: invitations

Tài nguyên: Lời mời

Lời mời tham gia một khoá học.

Biểu diễn dưới dạng JSON 
{
  "id": string,
  "userId": string,
  "courseId": string,
  "role": enum (CourseRole)
}
Trường
id

string

Giá trị nhận dạng do Lớp học chỉ định.

Chỉ có thể đọc.
userId

string

Giá trị nhận dạng của người dùng được mời.

Khi được chỉ định làm tham số của một yêu cầu, giá trị nhận dạng này có thể được đặt thành một trong các giá trị sau:

  • giá trị nhận dạng dạng số của người dùng
  • địa chỉ email của người dùng
  • chuỗi cố định "me", cho biết người dùng yêu cầu
courseId

string

Giá trị nhận dạng của khoá học mà bạn muốn mời người dùng tham gia.
role

enum (CourseRole)

Vai trò mà bạn muốn mời người dùng đảm nhận. Không được là COURSE_ROLE_UNSPECIFIED.

CourseRole

Các vai trò mà người dùng có thể được mời đảm nhận.

Enum
COURSE_ROLE_UNSPECIFIED Không có vai trò trong khoá học.
STUDENT Học viên trong khoá học.
TEACHER Giáo viên của khoá học.
OWNER Chủ sở hữu khoá học.

Phương thức

accept

 Chấp nhận lời mời, xoá lời mời đó và thêm người dùng được mời vào danh sách giáo viên hoặc học viên (nếu thích hợp) của khoá học được chỉ định.

create

 Tạo lời mời.

delete

 Xoá một lời mời.

get

 Trả về một lời mời.

list

 Trả về danh sách lời mời mà người dùng yêu cầu được phép xem, chỉ giới hạn ở những lời mời khớp với yêu cầu danh sách.