REST Resource: courses.aliases

Ressource: CourseAlias

Alternative Kennung für einen Kurs.

Mit einem Alias wird ein Kurs eindeutig identifiziert. Er darf in einem der folgenden Bereiche nur einmal vorkommen:

  • domain: Domain-übergreifende Alias sind für alle Nutzer in der Domain des Alias-Erstellers sichtbar und kann nur von einem Domainadministrator erstellt werden. Domain-übergreifende Alias werden häufig verwendet, wenn ein Kurs eine Kennung außerhalb von Classroom hat.

  • Projekt: Ein projektbezogenes Alias ist für jede Anfrage von einer Anwendung sichtbar, bei der die Projekt-ID der Developer Console verwendet wird, mit der der Alias erstellt wurde. Er kann von jedem Projekt erstellt werden. Ein projektbezogenes Alias wird häufig verwendet, wenn eine Anwendung alternative Kennzeichnungen hat. Ein Zufallswert kann auch verwendet werden, um doppelte Kurse bei Übertragungsfehlern zu vermeiden, da beim Wiederholen einer Anfrage ALREADY_EXISTS zurückgegeben wird, wenn eine vorherige erfolgreich war.

JSON-Darstellung 
{
  "alias": string
}
Felder
alias

string

Alias-String. Das Format des Strings gibt den gewünschten Alias-Bereich an.

  • d:<name> gibt einen Alias auf Domainebene an. Beispiel: d:math_101
  • p:<name> gibt einen Alias auf Projektebene an. Beispiel: p:abc123

Dieses Feld hat eine maximale Länge von 256 Zeichen.

Methoden

create

 Erstellt einen Alias für einen Kurs.

delete

 Löscht einen Alias eines Kurses.

list

 Gibt eine Liste von Aliassen für einen Kurs zurück.