REST Resource: courses.aliases

Tài nguyên: CourseAlias

Giá trị nhận dạng thay thế cho một khoá học.

Bí danh giúp xác định duy nhất một khoá học. Giá trị này phải là duy nhất thuộc một trong các phạm vi sau:

  • miền: Bí danh ở phạm vi miền đều hiển thị cho tất cả người dùng trong miền của người tạo bí danh. Chỉ quản trị viên miền mới có thể tạo bí danh đó. Bí danh ở phạm vi miền thường được dùng khi một khoá học có giá trị nhận dạng bên ngoài Lớp học.

  • dự án: Bí danh trong phạm vi dự án hiển thị với mọi yêu cầu từ một ứng dụng sử dụng mã dự án Bảng điều khiển dành cho nhà phát triển đã tạo bí danh và có thể được tạo bằng bất kỳ dự án nào. Bí danh trong phạm vi dự án thường được dùng khi một ứng dụng có giá trị nhận dạng thay thế. Bạn cũng có thể sử dụng một giá trị ngẫu nhiên để tránh các khoá học trùng lặp trong trường hợp không truyền được, vì việc thử lại một yêu cầu sẽ trả về ALREADY_EXISTS nếu yêu cầu trước đó đã thành công.

Biểu diễn dưới dạng JSON 
{
  "alias": string
}
Trường
alias

string

Chuỗi đại diện. Định dạng của chuỗi cho biết phạm vi bí danh mong muốn.

  • d:<name> cho biết bí danh ở phạm vi miền. Ví dụ: d:math_101
  • p:<name> cho biết một email đại diện ở phạm vi dự án. Ví dụ: p:abc123

Trường này có độ dài tối đa là 256 ký tự.

Phương thức

create

 Tạo biệt hiệu cho một khoá học.

delete

 Xoá bí danh của khoá học.

list

 Trả về danh sách bí danh của một khoá học.