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. Mã này phải là duy nhất trong một trong các phạm vi sau:

  • miền: Tất cả người dùng trong miền của người tạo bí danh đều có thể xem bí danh ở phạm vi miền và 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.

  • project: Bất kỳ yêu cầu nào từ một ứng dụng sử dụng mã dự án trong Developer Console đã tạo bí danh và bất kỳ dự án nào cũng có thể tạo bí danh trong phạm vi dự án đều có thể thấy bí danh đó. 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 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 bí danh. Đị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 bí danh trong 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 bí danh cho một khoá học.

delete

Xoá biệt hiệu của một khoá học.

list

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