Vorlesungsverzeichnis Technische Universität Dresden

Was ist das hier?

Diese API erlaubt automatisierte Zugriffe auf die öffentlichen Daten des Vorlesungsverzeichnis der Technische Universität Dresden. Über diese Schnittstelle lassen sich einfach automatisierte Zugriffe erstellen, die z. B. für selbstentwickelte Software zur Verfügung stehen.

Wie kann ich es benutzen?

Jeder, der Interesse an einem API-Zugang hat, kann uns über die Kontaktseite erreichen und erhält einen API-Zugangsaccount. Mit diesem Account ist es dann möglich, http://vvz.phil.tu-dresden.de/api mit dem Parameter

?auth_code=$AUTH_CODE

aufzurufen.

Wie sind die Daten aufgebaut, die aus diesem API kommen?

Das normale Vorlesungsverzeichnis

Die Daten sind im JSON-Format. Im ersten Element stehen die jeweligen Überschriften, die sich immer auf einzelne Veranstaltungen beziehen. Durch die Überschriften sind diese Spalten selbsterklärend. Folgende Parameter können weiterhin hinzugefügt werden:

Parameter	Beschreibung
notitle=1	Deaktiviert die Überschriften im ersten Element
type=Seminar	Listet je nur Veranstaltungen dieses Types.
gebaeude=BZW	Listet je nur Veranstaltungen in diesem Gebäude. Als Bezeichnung muss die Abkürzung des Gebäudes gewählt werden. Eine Liste der Gebäude gibt es mit dem Parameter ?auth_code=$AUTH_CODE&gebaeude_liste=1
first_name=Holm und last_name=Bräuer	Listet nur Veranstaltungen dieser Dozenten auf. Beide Parameter müssen immer zusammen vorkommen. Eine Liste der Dozenten gibt es mit dem Parameter ?auth_code=$AUTH_CODE&dozenten_liste=1
datetype=discordian oder datetype=unix	Stellt die Datenausgaben auf den diskordianischen Kalendar bzw. die Unixzeit um.
pruefungen=1 und studiengang=$STUDIENGANG	Listet alle Prüfungsnummern und Prüfungstypen eines Studienganges auf.
semester=1	Listet Veranstaltungen aus dem Semester mit der ID 1 auf (semester=current holt das aktuelle Semester).
institut=1	Listet Veranstaltungen aus dem Institut mit der ID 1 auf.

Die Daten müssen in der UTF8-Kodierung übergeben werden, werden aber im JSON-Format ASCII-kompatibel maskiert.

Liste aller Gebäude

Mit dem Parameter

?auth_code=$AUTH_CODE&gebaeude_liste=1

wird im JSON-Format eine Liste aller Gebäude zurückgegeben. Diese besteht je aus dem Gebäudenamen und der Abkürzung.

Liste der Institute

Mit dem Parameter

?auth_code=$AUTH_CODE&institute_liste=1

wird im JSON-Format eine Liste aller Institute (bestehend aus ID und Name) zurückgegeben.

Liste der Semester

Mit dem Parameter

?auth_code=$AUTH_CODE&semester_liste=1

wird im JSON-Format eine Liste aller Semester (bestehend aus ID, Semesterjahr und Semestertyp) zurückgegeben.

Liste aller Studiengänge

Mit dem Parameter

?auth_code=$AUTH_CODE&studiengang_liste=1

wird im JSON-Format eine Liste aller Studiengänge und deren IDs zurückgegeben.

Liste aller Dozenten

Mit dem Parameter

?auth_code=$AUTH_CODE&dozenten_liste=1

wird im JSON-Format eine Liste aller Dozenten zurückgegeben.

Liste aller Veranstaltungstypen

Mit dem Parameter

?auth_code=$AUTH_CODE&veranstaltungstypen=1

wird im JSON-Format eine Liste aller Veranstaltungstypen zurückgegeben.

Empfehlung

Es wird empfohlen, die Listen auf der Seite des Abrufenden zu cachen. Listen wie die Dozenten- oder Gebäudelisten verändern sich selten. Einmaliges tägliches Abrufen reicht völlig aus, um die Listen aktuell zu halten

Was gibt es für Beschränkungen?

Zwischen zwei Aufrufen der API müssen mindestens 10 Sekunden liegen, um die Datenbank nicht nutzlos zu belasten. Bei übermäßiger Benutzung behalten wir uns vor, die API-Zugänge ohne Rückmeldung zu kündigen.

Beispielaufruf

http://vvz.phil.tu-dresden.de/api?auth_code=$AUTH_CODE&notitle=1&first_name=Holm&last_name=Bräuer&gebaeude=BZW

Zeigt, ohne dass die Titel in der ersten Zeile sind, die Veranstaltungen von Holm Bräuer im BZW.

Fragen und Feature-Wünsche

Sollten Sie zur Benutzung der API Fragen haben oder benötigen Sie andere Daten, als die API sie gerade zur Verfügung stellt, zögern Sie nicht, uns zu kontaktieren.