Method: courses.aliases.list

Gibt eine Liste der Aliasse für einen Kurs zurück.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn der anfragende Nutzer nicht berechtigt ist, auf den Kurs zuzugreifen, oder aufgrund von Zugriffsfehlern.
  • NOT_FOUND, wenn der Kurs nicht vorhanden ist.

HTTP-Anfrage

GET https://classroom.googleapis.com/v1/courses/{courseId}/aliases

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
courseId

string

Die ID des Kurses. Diese Kennung kann entweder die von Classroom zugewiesene ID oder eine alias sein.

Abfrageparameter

Parameter
pageSize

integer

Maximale Anzahl der Elemente, die zurückgegeben werden sollen. Null oder nicht angegeben bedeutet, dass der Server ein Maximum zuweisen kann.

Der Server gibt möglicherweise weniger als die angegebene Anzahl von Ergebnissen zurück.
pageToken

string

nextPageToken-Wert, der von einem vorherigen list-Aufruf zurückgegeben wurde. Dieser gibt an, dass die nachfolgende Ergebnisseite zurückgegeben werden soll.

Die list-Anfrage muss ansonsten mit der Anfrage übereinstimmen, die zu diesem Token geführt hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort beim Auflisten von Aliassen für Kurse.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "aliases": [
    {
      object (CourseAlias)
    }
  ],
  "nextPageToken": string
}
Felder
aliases[]

object (CourseAlias)

Die Aliasse des Kurses.
nextPageToken

string

Token, das die nächste Ergebnisseite angibt, die zurückgegeben werden soll. Wenn das Feld leer ist, sind keine weiteren Ergebnisse verfügbar.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.