REST Resource: courses.aliases

Zasób: CourseAlias

Alternatywny identyfikator zajęć.

Alias jednoznacznie identyfikuje zajęcia. 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 kurs ma identyfikator spoza Classroom.

  • projekt: alias ograniczony do projektu jest widoczny w przypadku każdego żądania wysyłanego przez aplikację przy użyciu identyfikatora projektu w Konsoli programisty, za pomocą którego ten alias został utworzony. Można go utworzyć w dowolnym projekcie. Alias ograniczony do projektu jest często używany, gdy aplikacja ma alternatywne identyfikatory. Wartość losowa może też służyć do uniknięcia powielania kursów w przypadku niepowodzenia transmisji, ponieważ ponowienie próby połączenia spowoduje zwrócenie ALREADY_EXISTS, jeśli poprzednia próba się powiedzie.

Zapis JSON
{
  "alias": string
}
Pola
alias

string

Ciąg tekstowy aliasu. Format ciągu znaków wskazuje odpowiedni zakres aliasów.

  • 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 kursu.