Einleitung

Einhaltung von Standards

Bei der Entwicklung und Umsetzung der API werden folgende Standards berücksichtigt:

  • JSON HAL – JSON Hypertext Application Language

  • RFC 7807 – Problem Details for HTTP APIs

  • Semantic Versioning

HTTP-Anfrage

Eine HTTP-Anfrage besteht aus einer HTTP-Methode, einem Endpunkt und einer Liste von Pfad-Parametern. In dieser API-Referenz werden HTTP-Anfragen wie folgt dargestellt:

Hinweis

Beim Senden einer HTTP-Anfrage mit dem Content-Typ "application-json" im Anfrage-Header, wird neben den Inhalten eine Problembeschreibung ausgeliefert.

 

METHODE https://api.studienangebot.uni-halle.de/endpunkt

HTTP-Methoden

Hinweis

In der aktuellen Version dieser API steht nur die HTTP-Methode GET zur Verfügung.
HTTP-Methode Beschreibung

GET

Holen der Daten vom entsprechenden Endpunkt.

Endpunkt

Ein Endpunkt ist ein Pfad, der eine Ressource des Studienangebotes eindeutig identifizert.

Um eine HTTP-Anfrage an einen Endpunkt zu senden, muss der entsprechende Pfad an die URL https://api.studienangebot.uni-halle.de angehängt werden.

Die Antwort eines Endpunktes kann eine oder mehrere Ressourcen oder eine Problembeschreibung im JSON-Format enthalten.

Query-Parameter

Mit Query-Parametern können Studiengangslisten gefiltert (eingeschränkt) werden. Das Verwenden von Query-Parametern ist abhängig vom gewählten Endpunkt.

Bei Verwendung müssen Query-Parameter bei einer Anfrage an den Endpunkt angehängt werden.

Anfrage (Request)

GET https://api.studienangebot.uni-halle.de/studycourses{?bezeichner=wert}

Query-Parameter

Bezeichner Datentyp Mögliche Werte Beschreibung

degree_group

String

bachelor

Liefert eine Liste aller Bachelor-Studiengänge.

master

Liefert eine Liste aller Master-Studiengänge.

Antwort (Response)

HTTP-Status Erläuterung

200 (OK)

Die Liste der Studiengänge wurde ausgeliefert.

400 (Bad Request)

Die Anfrage ist fehlerhaft.

Authentifizierung

Die API ist nur aus dem Netzwerk der Uni Halle erreichbar. Jede Anwendung, die die Schnittstelle verwenden möchte, muss ein eigenes Authentifizierungs-Token im Anfrage-Header senden. Dieses Authentifizierungs-Token wird vom Studienangebot zur Verfügung gestellt.

Anfrage (Request)

CURL https://api.studienangebot.uni-halle.de/studycourses -H "Authorization: Studienangebot token=xyz12345

Antwort (Response)

HTTP-Status Erläuterung

200 (OK)

Die Authentifizierung ist gültig.

401 (Unauthorized)

Authentifizierung ist ungültig (z.B. durch unvollständige Angaben).

403 (Forbidden)

Authentifizierung mit verwendeten Angaben ist nicht zulässig.