REST Resource: courses.aliases

Ressource: CourseAlias

Alternative Kennung für einen Kurs.

Mit einem Alias wird ein Kurs eindeutig identifiziert. Sie muss innerhalb eines der folgenden Bereiche eindeutig sein:

  • domain: Ein Alias auf Domainebene ist für alle Nutzer in der Domain des Aliaserstellers sichtbar und kann nur von einem Domainadministrator erstellt werden. Ein Alias auf Domainebene wird häufig verwendet, wenn ein Kurs eine Kennung außerhalb von Classroom hat.

  • Projekt: Ein projektbezogener Alias ist für jede Anfrage von einer Anwendung sichtbar, die die Developer Console-Projekt-ID verwendet, mit der der Alias erstellt wurde. Er kann von jedem Projekt erstellt werden. Ein projektbezogener Alias wird häufig verwendet, wenn eine Anwendung über alternative Kennungen verfügt. Ein Zufallswert kann auch verwendet werden, um doppelte Kurse bei Übertragungsfehlern zu vermeiden, da bei einer erneuten 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 projektbezogenen Alias 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 der Aliasse für einen Kurs zurück.