REST Resource: courses.aliases

Zasób: CourseAlias

Alternatywny identyfikator zajęć.

Alias jednoznacznie identyfikuje kurs. Musi być niepowtarzalna w jednym z tych zakresów:

  • domena: alias ograniczony do domeny jest widoczny dla wszystkich użytkowników w domenie twórcy aliasu i może go utworzyć tylko administrator domeny. Alias ograniczony do domeny jest często używany, gdy zajęcia mają identyfikator spoza Classroom.

  • projekt: alias ograniczony do projektu jest widoczny dla każdego żądania wysyłanego z aplikacji korzystającej z identyfikatora projektu z Konsoli programisty, który utworzył alias i może zostać utworzony przez dowolny projekt. Alias ograniczony do projektu jest często używany, gdy aplikacja ma alternatywne identyfikatory. Wartość losowa pozwala też uniknąć powielania kursów w przypadku błędów transmisji, ponieważ ponowna próba żądania spowoduje zwrócenie 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 znaków wskazuje odpowiednie określenie zakresu aliasu.

  • d:<name> oznacza alias ograniczony do 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 zajęć.