Entwicklerdokumentation

REST API

Auf dieser Seite sind die Endpunkte der REST API erläutert. Diese werden aktuell von dem Frontend genutzt und könnten für Erweiterungen genutzt werden.

Grid API

Endpunkt	/api/grid/validate
Beschreibung	Überprüft ob das übergebene Grid vollständig und korrekt ist. Sollte ein Fehler vorliegen, so wird eine Fehlernachricht ausgegeben.
Methode	POST
Body	GridRequest
Response	Status 200

Endpunkt	/api/grid/verify
Beschreibung	Überprüft ob das übergebene Grid bisher korrekt ist. Es werden noch nicht alle Prüfungen (etwa, dass alle Nodes verbunden sein müssen) geprüft. Sollte ein Fehler vorliegen, so wird eine Fehlernachricht ausgegeben.
Methode	POST
Body	GridRequest
Response	Status 200

Endpunkt	/api/grid/massenstrom
Beschreibung	Ermittelt zu dem Grid den maximalen Massenstrom auf Stundenbasis. Dieser wird in Abhängigkeit der Außentemperatur und der daraus resultierenden Vorlauf/Rücklauftemperatur sowie dem Wärmebedarf berechnet.
Methode	POST
Body	GridRequest
Response	MassenstromResponse

Loadprofile API

Endpunkt	/api/profiles/names
Beschreibung	Gibt die Namen der verfügbaren Standardlastprofile zurück.
Methode	GET
Body	-
Response	List

Endpunkt	/api/profiles/profile/{name}
Beschreibung	Gibt ein Standardlastprofil mit seiner Verteilung zurück.
Methode	GET
Body	-
Response	LoadProfile

Temperature API

Endpunkt	/api/temperature/keys
Beschreibung	Gibt die Namen der verfügbaren Temperaturzeitreihen zurück.
Methode	GET
Body	-
Response	List

Endpunkt	/api/temperature/series/{name}
Beschreibung	Gibt eine Temperaturzeitreihe zurück.
Methode	GET
Body	-
Response	TemperatureTimeSeries

Optimization API

Endpunkt	/api/optimize
Beschreibung	Optimiert das Netz und liefert die optimalen Rohrdurchmesser, soviel die wesentlichen Kennzahlen zurück.
Methode	Post
Body	OptimizationRequest
Response	OptimizationResponse