Quelltext der Seite Server-API

<div class="achtung">Die Server-API befindet sich noch in der Entwicklungsphase, Änderungen sind zu erwarten</div>

Die Serverkomponente von Talsim-NG ([[TalsimNGSrv]]) bietet eine REST (HTTP) Schnittstelle (API), über die Daten abgerufen und an den Server übermittelt werden können. Daten werden über diese Schnittstelle im XML oder JSON Format ausgetauscht. Im Folgenden wird diese Schnittstelle dokumentiert:
__TOC__
<div class="info">In den unten angegebenen Beispielen wird als Server-Adresse <code>talsim.de</code> verwendet, dies ist mit der Adresse oder IP des tatsächlich verwendeten Talsim-Servers zu ersetzen.</div>
==HttpDataSrv==
Der HttpDataSrv Service dient zur Abfrage von Daten mit Bezug zum System, Systemvarianten, Listen zu Zeitreihen-Ordnern oder Zeitreihen. Der HttpDataSrv ist standardmäßig über den Port 8090 ansprechbar und bietet die folgenden Schnittstellen:
===requestClients===
Generelle Abfrage aller Kunden.

===requestCustomers===
Generelle Abfrage aller Kunden. Identisch zu <code>requestClients</code>

Beispiel: <code><nowiki>http://talsim.de:8090/TalsimNGServer/HttpDataSrv/requestCustomers/|</nowiki></code>
===requestZreDirectories===
Abfrage von Zeitreihen-Ordnern. Es werden Zeitreihen-Ordner mit ihren Zeitreihen zurückgegeben. Parameter sind <code>customer</code> und mit Komma getrennt ein "|".

Beispiel: <code><nowiki>http://talsim.de:8090/TalsimNGServer/HttpDataSrv/requestZreDirectories/Nile,|</nowiki></code>
===ZreDirectories===
Abfrage von Zeitreihen-Ordnern. Es werden nur Zeitreihen-Ordner zurückgegeben. Parameter sind <code>customer</code> und mit Komma getrennt ein "|".

Beispiel: <code><nowiki>http://talsim.de:8090/TalsimNGServer/HttpDataSrv/ZreDirectories/Nile,|</nowiki></code>

===requestZreFiles===
Abfrage von vorhandenen Zeitreihen. Parameter sind <code>customer</code>, <code>user</code> sowie die ID des Zeitreihen-Ordners. Ist die ID des Zeitreihen-Ordners 0, werden alle Zeitreihen zurückgegeben.

Beispiel: <code><nowiki>http://talsim.de:8090/TalsimNGServer/HttpDataSrv/requestZreFiles/Nile,hubert,16</nowiki></code>
===requestSystemAndSysVar===
Abfrage von Systemen und Systemvarianten

Beispiel: <code><nowiki>http://talsim.de:8090/TalsimNGServer/HttpDataSrv/requestSystemAndSysVar/WFP_SSD,hubert,1</nowiki></code>
==HttpZreSrv==
HttpZreSrv ist der zentrale Service zur Interaktion mit Zeitreihen. Der HttpZreSrv ist standardmäßig über den Port 8092 ansprechbar. Es gibt folgende Schnittstellen, um auf Zeitreihen und deren Metadaten zuzugreifen:

===SydroTimeSeries===
Abfrage einer Zeitreihe

Als Parameter sind zu übergeben <code>Customer</code>, <code>User</code>, <code>Id</code> der Zeitreihe, Weitere Parameter sind aktuell noch ein SQL Statement <code>SQLCriteria</code> oder alternativ drei Parameter als <code>Startdate</code>, <code>Enddate</code> und <code>AttributeFlag</code>. Das SQL Statement ist momentan nur zum Testen aktiviert und wird wenn alle anderen Endpoints gesetzt sind wieder eingestellt. 
Wenn Startdate und Enddate mit <code>0</code> angegeben werden, wird die gesamte Zeitreihe gelesen. Um nur einen Teil der Zeitreihe zu bekommen, können Anfang und/oder Ende mit Datumsformat <code>yyyy-MM-dd HH:mm</code> (z.B. <code>2010-08-15 08:00</code>) angegeben werden.

Beispiel 1: <code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/TestAPI,MusterUser,9999,attribFlag=0</nowiki></code> 

===SydroTimeSeries/combine===
Kombinieren von zwei Zeitreihen. Dies ist zum Beispiel sinnvoll, um eine Messzeitreihe mit Vorhersagedaten zu kombinieren.

Als Parameter sind zu übergeben <code>customer</code>, <code>user</code>, <code>id1</code>, <code>id2</code>,<code>startdate1</code>, <code>endstartdate</code>, <code>enddate2</code>, <code>flag1</code>,<code>flag2</code>. <code>Id1</code> bezieht sich auf die erste Zeitreihe und <code>Id2</code> auf die Reihe, welche angehängt wird. <code>Startdate1</code> definiert wo die erste Zeitreihe anfangen soll, <code>endstartdate</code> wo diese aufhöhrt und die zweite beginnen soll und <code>enddate2</code> das Enddatum der zweiten Reihe. Ist <code>enddate2</code> 0 oder leer wird bis zum Ende der zweiten Zeitreihe gelesen. 

Beispiel 1: <code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/combine/TestAPI,MusterUser,9999,8888,2019-02-01 00:00,2019-10-01 00:00, 0,0</nowiki></code>

===SydroTimeSeries===
Erstellen einer neuen Zeitreihen oder Überschreiben einer bestehenden Zeitreihe

Wird ein POST Aufruf mit dem SydroTimeSeries Objekt gestartet, kann eine Zeitreihe neu erstellt oder eine bestehende überschrieben werden. Soll eine bestehende Zeitreihe überschrieben oder ergänzt werden, muss das Attribute <code>ID</code> gesetzt sein. Soll eine neue Zeitreihen angelegt werden, muss <code>ID</code> gleich 0 sein. Das Objekt SydroTimeSeries besitzt folgende Struktur: 

<pre>
<SydroTimeSeries> 
<Attribute> (short) 
<Customer> (string) 
<DateValuePairSeparator> (string) shows how Date/Value Pairs in TimeSeriesString can be split 
<ErrorValue> (double) Indicator what is an error value, will be replaced by NaN. 
<HasError> (boolean) shows if an error occured during processing the request 
<Id> (Integer) ID of time series. If ID=0 when POST is performed a new time series will be created and the new ID will be returned 
<Length> (integer) Number or records in the TimeSeriesString
<Lat> (double) Latitude coordinate  
<Lon> (double) Longitude coordinate 
<Name> (string) Short name of the time series 
<Path> (string) Path to the time series on the server 
<ResultMsg> (string) Plain text describing errors if any or return a success message 
<SaveMetadata> (boolean) Indicates whether or not metadata should be updated when posting time series values <Separator> (string) indicates how date/values can be split
<StationId> (integer) ID of the station 
<TimeSeriesHeader> (string) Indicates how one time series entry must be interpreted, e.g. "Date,Value,Flag" if one entry has date/value/flag attributes. 
<TimeSeriesString> (string) This is the time series as text, where date/values are separated by the attribute <Separator> and entries are separated by <DateValuePairSeparator>
 Example: <TimeSeriesString>2001-01-01 00:00:00,3.106106,0#2001-01-02 00:00:00,4.209204,0#2001-01-03 00:00:00,0.1453788,#2002-01-02 00:00:00,0,0</TimeSeriesString>
<TsClass> (short) Represents the time series class with -1= unknown, 0=Default, 1=Flagged, 2=Forecast 
<Unit> (string) gives the unit string, e.g. mm or m3/s 
<User>Name of the user requesting or posting the time series or the owner of the time series.  
</SydroTimeSeries> 
</pre>

===SydroTimeSeries/process===
Eine zweite Art eine Zeitreihe zu erstellen bzw. hochzuladen, ist durch <code>process</code> gegeben.

In diesem Fall sind aber mehrere Interaktionen mit dem Server erforderlich, die nur per Software sinnvoll sind. Parameter sind <code>customer</code>, <code>user</code>, <code>id</code>, <code>SydroTimeSeriesFile</code>. Der Parameter <code>SydroTimeSeriesFile</code> ist eine Datei mit dem Inhalt eines SydroTimeSeries Objektes, welches vor dem Aufruf per Streaming in Kommunikation mit dem Server auf den Server hochgeladen werden muss. Dies erfordert das <code>TalsimNGZreClient</code> Modul, welches in eine Software integriert werden muss. Das Werkzeug <code>SydroCmd</code> besitzt die Fähigkeit, Dateien hochzuladen und ist deshalb für den operationellen Einsatz mit dem TalsimNGServer geeignet. Nach dem Aufruf sorgt der Server für die Verarbeitung der Datei und liefert eine Meldung zurück, dass der Prozess gestartet wurde. Es gibt keine Erfolgsmeldung, da der Server diesen Prozess asynchron in einem Thread verarbeitet. 

Beispiel 1: <code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/process/TestAPI,MusterUser,9999,..serververzeichnis/file.sydrots</nowiki></code>

===SydroTimeSeries/delete===
Löschen einer Zeitreihe.

Als Parameter sind zu übergeben <code>Customer</code>, <code>User</code>, <code>Id</code>. Es gibt kein Undo zu diesem Vorgang.

===SydroTimeSeries/deleteRecords===
Löschen von Einträgen in einer Zeitreihe.

Als Parameter sind zu übergeben <code>Customer</code>, <code>User</code>, <code>Id</code>, <code>Startdate</code>, <code>Enddate</code> und <code>AttributeFlag</code>. Gelöscht werden die Einträge, die zwischen <code>Startdate</code> und <code>Enddate</code> liegen und den <code>AttributeFlag</code> besitzen. 

===SydroTimeSeries/attributes===
Abfrage oder Setzen von Metadaten zu einer Zeitreihe

Werden als Parameter <code>Customer</code>, <code>User</code>, <code>Id</code> übergeben, erhält man als Antwort einen String im Format FeldName=Wert getrennt durch "#" Zeichen, der alle Metadaten der Zeitreihe zeigt. Wird zusätzlich ein weiterer Parameter <code>KeyValuePairs</code> übergeben, so setzt man Metadaten. Der String KeyValuePairs muss im Format Feldname=Wert getrennt durch "#" angegeben sein. Die gegebenen Eigenschaften werden gespeichert, vorausgesetzt es handelt sich nicht um geschützte Felder.

Alternativ kann auch mittels POST ein SydroTimeSeriesAttributes Objekt gesendet werden, welches die zu schreibenden Eigenschaften beinhaltet. 

===SydroTimeSeries/attributes/fieldnames===
Dieser Aufruf gibt alle Feldnamen der Metadaten getrennt durch Komma zurück.

===SydroTimeSeries/fieldnames===
Dieser Aufruf gibt alle Feldnamen der Zeitreihentabelle getrennt durch Komma zurück.

===SydroTimeSeries/flags===
Mit diesem Aufruf erhält man alle in der Zeitreihe verwendeten Flags. Erforderliche Parameter sind <code>Customer</code>, <code>User</code>, <code>Id</code>

===SydroTimeSeries/class===
Mit diesem Aufruf erhält man die Klasse einerZeitreihe, also -1= unknown, 0=Default, 1=Flagged, 2=Forecast. Erforderliche Parameter sind <code>Customer</code>, <code>User</code>, <code>Id</code>

===requestSydroTimeSeries===
Abfrage einer Zeitreihe

Als Parameter sind zu übergeben <code>Customer</code>, <code>User</code>, <code>Id</code> der Zeitreihe, <code>Startdate</code>, <code>Enddate</code> und <code>Separator</code> (Trennzeichen für den CSV-Inhalt)

===requestSydroTimeSeries===
Abfrage einer Zeitreihe

Als Parameter sind zu übergeben <code>Customer</code>, <code>User</code>, <code>Id</code> der Zeitreihe, <code>Startdate</code>, <code>Enddate</code> und <code>Separator</code> (Trennzeichen für den CSV-Inhalt)

Wenn Startdate und Enddate mit <code>0</code> angegeben werden, wird die gesamte Zeitreihe gelesen. Um nur einen Teil der Zeitreihe zu bekommen, können Anfang und/oder Ende mit Datumsformat <code>dd.MM.yyyy HH:mm</code> (z.B. <code>01.01.2010 00:00</code>) oder <code>yyyyMMddHHmm</code> (z.B. <code>201001010000</code>) angegeben werden.

Beispiel: <code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/requestSydroTimeSeries/CSV/UNDP_Kura,Kura,318,0,0,comma</nowiki></code>
===postTimeSeriesValues===
Setzen von Zeitreihenwerten (POST)

Beispiel: <code><nowiki>http://10.0.0.5:8092/TalsimNGServer/HttpZreSrv/postTimeSeriesValues</nowiki></code><br/>
Post data (raw text):
<source lang="xml" gutter="false">
<SydroTimeSeries>
    <Client>UNDP_Kura</Client>
    <Id>318</Id>
    <Length>427</Length>
    <Name>GE.Iori</Name>
    <ResultMsg></ResultMsg>
    <StationId>21</StationId>
    <TimeSeriesString>
	1975-01-01 00:00:00,0.09&#xD;
	1975-02-01 00:00:00,0.1&#xD;
	1975-03-01 00:00:00,0.3&#xD;
	1975-04-01 00:00:00,0.99&#xD;
	1975-05-01 00:00:00,1.19&#xD;
	1975-06-01 00:00:00,0.58&#xD;
	1975-07-01 00:00:00,0.22&#xD;
	1975-08-01 00:00:00,0.11&#xD;
	1975-09-01 00:00:00,0.09&#xD;
	1975-10-01 00:00:00,0.1&#xD;
</TimeSeriesString>
</SydroTimeSeries>
</source>

===requestSydroZreBin===
Beispiel: <code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/requestSydroZreBin/WFP_SSD,hubert,724,201001010000,201201010000,0</nowiki></code>

===refreshSydroZreBin===
Beispiel: <code><nowiki>http://localhost:8092/TalsimNGServer/HttpZreSrv/refreshSydroZreBin/All/WFP_SSD,hubert</nowiki></code>