REST Resource: invitations

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

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

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

string

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

Chỉ đọ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 yêu cầu, bạn có thể đặt giá trị nhận dạng này 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
  • giá trị cố định kiểu chuỗi "me", cho biết người dùng đưa ra yêu cầu
courseId

string

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

enum (CourseRole)

Vai trò cần mời người dùng có. Không được là COURSE_ROLE_UNSPECIFIED.

CourseRole

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

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 chính 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 phù hợp) của khoá học đã chỉ định.

create

 Tạo lời mời.

delete

 Xoá lời mời.

get

 Trả về 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, được giới hạn ở những lời mời phù hợp với yêu cầu danh sách.