REST Resource: courses.aliases

Ressource: CourseAlias

Alternative Kennung für einen Kurs.

Ein Alias identifiziert einen Kurs eindeutig. Er muss innerhalb eines der folgenden Bereiche eindeutig sein:

  • domain: Ein Alias auf Domainebene ist für alle Nutzer in der Domain des Erstellers des Alias sichtbar und kann nur von einem Domainadministrator erstellt werden. Ein Alias auf Domainebene wird oft verwendet, wenn ein Kurs eine externe Kennung in Classroom hat.

  • project: Ein Alias auf Projektebene ist für alle Anfragen einer Anwendung sichtbar, die die Projekt-ID der Developers Console verwendet, mit der der Alias erstellt wurde. Er kann von jedem Projekt erstellt werden. Ein Alias auf Projektebene wird häufig verwendet, wenn eine Anwendung alternative Kennungen hat. Ein Zufallswert kann auch verwendet werden, um bei Übertragungsfehlern doppelte Kurse zu vermeiden, da bei einem erneuten Versuch einer Anfrage ALREADY_EXISTS zurückgegeben wird, wenn eine vorherige Anfrage erfolgreich war.

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

string

Alias-String. Das Format des Strings gibt den gewünschten Aliasbereich 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 der Aliasse für einen Kurs zurück.