REST Resource: courses.aliases

Tài nguyên: CourseAlias

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

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

  • miền: Một bí danh trong phạm vi miền hiển thị với tất cả người dùng trong miền của người tạo bí danh và chỉ quản trị viên miền mới có thể tạo được bí danh. Bí danh trong 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ừ ứng dụng sử dụng mã dự án Developer Console đã tạo bí danh và bất kỳ dự án nào cũng có thể tạo 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 truyền không thành công, vì việc thử lại 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
}
Các 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 trong 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á bí danh của một khoá học.

list

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