REST Resource: courses.aliases

Ресурс: CourseAlias

Альтернативный идентификатор курса.

Псевдоним однозначно идентифицирует курс. Он должен быть уникальным в пределах одной из следующих областей:

  • домен: псевдоним на уровне домена виден всем пользователям в домене создателя псевдонима и может быть создан только администратором домена. Псевдоним на уровне домена часто используется, когда курс имеет идентификатор, внешний по отношению к Классу.

  • проект: псевдоним в области проекта виден для любого запроса приложения, использующего идентификатор проекта консоли разработчика, который создал псевдоним, и может быть создан любым проектом. Псевдоним на уровне проекта часто используется, когда приложение имеет альтернативные идентификаторы. Случайное значение также можно использовать, чтобы избежать дублирования курсов в случае сбоя передачи, поскольку повторный запрос вернет ALREADY_EXISTS , если предыдущий был успешным.

JSON-представление 
{
  "alias": string
}
Поля
alias

string

Строка псевдонима. Формат строки указывает желаемую область действия псевдонима.

  • d:<name> указывает псевдоним на уровне домена. Пример: d:math_101
  • p:<name> указывает псевдоним на уровне проекта. Пример: p:abc123

Максимальная длина этого поля — 256 символов.

Методы

create

 Создает псевдоним для курса.

delete

 Удаляет псевдоним курса.

list

 Возвращает список псевдонимов курса.