Server-API

2019-10-17T13:36:39Z

Admin: /* postTimeSeriesValues */ XML Formatierung

<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 entweder ein SQL Statement <code>SQLCriteria</code> oder alternativ drei Parameter als <code>Startdate</code>, <code>Enddate</code> und <code>AttributeFlag</code>.
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>

Beispiel 2: <code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/TestAPI,MusterUser,9999,2001-05-15 00:00,2001-10-15 00:00,-1</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/delete===
Löschen einer Zeitreihe.

Als Parameter sind zu übergeben <code>Customer</code>, <code>User</code>, <code>Id</code>.

===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
1975-02-01 00:00:00,0.1
1975-03-01 00:00:00,0.3
1975-04-01 00:00:00,0.99
1975-05-01 00:00:00,1.19
1975-06-01 00:00:00,0.58
1975-07-01 00:00:00,0.22
1975-08-01 00:00:00,0.11
1975-09-01 00:00:00,0.09
1975-10-01 00:00:00,0.1
</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>

TALSIMWiki:Datenschutz

2019-10-16T09:07:11Z

Admin:

__NOTOC__
Sie erfahren hier, welche Informationen gesammelt werden und wie die Informationen verwendet werden.
Erläuterungen zum Datenschutz

Sie können im Regelfall alle Seiten dieses Wikis aufrufen, ohne Angaben über Ihre Person zu machen. Werden im Einzelfall Ihr Name, Ihre Anschrift oder sonstige persönliche Daten benötigt, so werden Sie zuvor darauf hingewiesen. Ihre personenbezogenen Nutzungsdaten werden verwendet, um den Service der SYDRO Consult GmbH für Sie so angenehm wie möglich zu gestalten und zu verbessern.

Wenn Sie sich entschließen, der SYDRO Consult GmbH oder ihren Geschäftspartnern persönliche Daten über das Internet zu überlassen, damit z.B. Korrespondenz abgewickelt oder eine Bestellung ausgeführt werden kann, so wird mit diesen Daten nach den strengen Regelungen des Bundesdatenschutzgesetzes (BDSG) sorgfältig umgegangen.

Durch die Aufrufe der Internetseite erhält die SYDRO Consult GmbH Nutzungsdaten, die für Sicherungszwecke gespeichert werden und möglicherweise eine Identifizierung zulassen (zum Beispiel IP-Adresse, Datum, Uhrzeit und betrachtete Seiten). Diese Daten werden von der SYDRO Consult GmbH ausgewertet, um das Nutzerverhalten kennen zu lernen und Statistiken aufzustellen. Dabei werden bei allen Maßnahmen die hohen Sicherheitsstandards des Teledienstedatenschutzgesetzes (TDDSG) und der Datenschutzverordnung für Telekommunikationsunternehmen (TDSV) beachtet. Es findet keine personenbezogene Verwertung statt. Die statistische Auswertung anonymisierter Datensätze bleibt vorbehalten.

Weitere Informationen zum Thema Datenschutz in der Bundesrepublik Deutschland finden Sie hier:
http://www.bfd.bund.de/

==Weitergabe personenbezogener Informationen an Dritte==

Sollten im Rahmen der Auftragsdatenverarbeitung Daten an Dienstleister weitergegeben werden, so sind diese an das BDSG, andere gesetzliche Vorschriften und vertraglich an die Privacy Policy der SYDRO Consult GmbH gebunden. Soweit die SYDRO Consult GmbH gesetzlich oder per Gerichtsbeschluss dazu verpflichtet ist, wird sie Ihre Daten im geforderten Umfang an auskunftsberechtigte Stellen übermitteln.

Für andere Zwecke gibt die SYDRO Consult GmbH Ihre Daten nicht ohne Ihr ausdrückliches Einverständnis an Dritte weiter.

==Recht auf Widerruf==

Wenn Sie die SYDRO Consult GmbH auffordern, Ihre personenbezogenen Daten nicht für die weitere Kontaktaufnahme zu verwenden und/oder zu löschen, so wird entsprechend verfahren. Daten, die für eine Auftragsabwicklung bzw. zu kaufmännischen Zwecken zwingend erforderlich sind, sind von einer Kündigung beziehungsweise von einer Löschung nicht berührt.

Bitte haben Sie Verständnis dafür, dass im Falle des Widerrufs der personalisierte Service nicht mehr erbracht werden kann, da er auf der Verwendung der Kundendaten aufbaut.

==Einsatz von Cookies==

In Cookies werden während einer Onlinesitzung Textinformationen gesammelt und in einer speziellen Datei im ASCII-Format (cookie.txt) auf der Festplatte des Benutzers abgelegt. Wohin der Cookie beim Anwender gespeichert wird, kontrolliert der WWW-Browser des Anwenders. Cookies sind Informationen, die bei dem nächsten Onlinebesuch an den Server zurückgesandt werden. Sie können jeweils nur von dem Server, der sie vorher auch abgelegt hat, gelesen werden.

Die SYDRO Consult GmbH setzt Cookies nur dann ein, wenn sie für Benutzerfunktionen dringend erforderlich sind bzw. die Navigation der Websites erleichtern. Die Informationen werden keinem Dritten zur Verfügung gestellt, da Cookies nur für die o.g. Zwecke verwendet werden.

Die meisten Browser sind so eingestellt, dass sie Cookies automatisch akzeptieren. Diese Funktion kann jedoch jederzeit im Browser deaktiviert werden. Sie können Ihren Browser so einstellen, dass er Sie benachrichtigt, sobald Cookies gesendet werden.
Links zu anderen Websites

Die Webseiten dieses Wikis enthalten Links zu anderen Websites. Die SYDRO Consult GmbH hat keinen Einfluss auf den redaktionellen Inhalt fremder Webseiten und darauf, dass deren Betreiber die Datenschutzbestimmungen einhalten.

TALSIM Docs - Benutzerbeiträge [de]

Server-API

TALSIMWiki:Datenschutz