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 Zugriffsfehler aufgetreten sind.
  • 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 Artikel, die zurückgegeben werden sollen. Null oder nicht angegeben bedeutet, dass der Server ein Maximum zuweisen kann.

Der Server gibt möglicherweise weniger Ergebnisse als die angegebene Anzahl 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 Kursaliassen.

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

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

object (CourseAlias)

Die Aliasnamen des Kurses.

nextPageToken

string

Token, das die nächste Ergebnisseite identifiziert, 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.