REST Resource: courses.aliases

Zasób: CourseAlias

Identyfikator alternatywny zajęć.

Alias jednoznacznie identyfikuje zajęcia. Musi być niepowtarzalny w ramach jednego z tych zakresów:

  • domena: alias ograniczony do domeny jest widoczny dla wszystkich użytkowników w domenie twórcy aliasu i może być tworzony tylko przez administratora domeny. Alias ograniczony do domeny jest często używany, gdy kurs ma identyfikator zewnętrzny w stosunku do Classroom.

  • projekt: alias w zakresie projektu jest widoczny dla każdego żądania z aplikacji korzystającej z identyfikatora projektu w Konsoli programisty, który utworzył alias. Może być tworzony przez dowolny projekt. Alias ograniczony do projektu jest często używany, gdy aplikacja ma alternatywne identyfikatory. Wartość losowa może być też używana do unikania duplikatów kursów w przypadku niepowodzenia transmisji, ponieważ ponowne wysłanie żądania spowoduje zwrócenie wartości ALREADY_EXISTS, jeśli poprzednie żądanie zakończyło się powodzeniem.

Zapis JSON
{
  "alias": string
}
Pola
alias

string

Ciąg znaków aliasu. Format ciągu wskazuje żądany zakres aliasu.

  • d:<name> oznacza alias w zakresie domeny. Przykład: d:math_101
  • p:<name> oznacza alias ograniczony do projektu. Przykład: p:abc123

Maksymalna długość tego pola to 256 znaków.

Metody

create

Tworzy alias zajęć.

delete

Usuwa alias zajęć.

list

Zwraca listę aliasów kursu.