Server-API - Versionsgeschichte

Froehlich: SydroTimeSeries/attributes Beispiel ergänzt

2024-02-07T16:05:08Z

SydroTimeSeries/attributes Beispiel ergänzt

@@ Zeile 224: / Zeile 224: @@
 <!--T:48-->
-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.
+Werden als Parameter <code>Customer</code>, <code>User</code>, <code>Id</code> übergeben, erhält man als Antwort u.a. einen String im Format FeldName=Wert, der alle Metadaten der Zeitreihe zeigt.
 <!--T:49-->
 Alternativ kann auch mittels POST ein SydroTimeSeriesAttributes Objekt gesendet werden, welches die zu schreibenden Eigenschaften beinhaltet.
 ===SydroTimeSeries/attributes/fieldnames=== <!--T:50-->

Froehlich: fix issue number

2024-02-07T07:20:00Z

fix issue number

← Nächstältere Version		Version vom 7. Februar 2024, 09:20 Uhr
Zeile 159:		Zeile 159:

	<div class="info">		<div class="info">
	'''Hinweise:''' (#~~278~~)		'''Hinweise:''' (#279)
	* Bei einem POST Aufruf darf im XML-Dokument kein Namespace (<code>xmlns</code>) angegeben werden (d.h. der Root Tag muss genau <code><SydroTimeSeries></code> lauten.		* Bei einem POST Aufruf darf im XML-Dokument kein Namespace (<code>xmlns</code>) angegeben werden (d.h. der Root Tag muss genau <code><SydroTimeSeries></code> lauten.
	* Im Request Header muss als "Content-Type" "text/plain" angegeben sein.		* Im Request Header muss als "Content-Type" "text/plain" angegeben sein.

Froehlich: Erläuterungen

2024-02-07T07:18:11Z

Erläuterungen

← Nächstältere Version		Version vom 7. Februar 2024, 09:18 Uhr
Zeile 127:		Zeile 127:

	<!--T:34-->		<!--T:34-->
	Wird ein POST Aufruf an diesen Endpunkt mit entsprechendem XML im body 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~~:		Wird ein POST Aufruf an diesen Endpunkt mit entsprechendem XML im body 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 erwartete XML-Dokument entpricht dem, was man bei GET Aufrufen bekommt. Beispiel:
			<source lang="xml">
			<SydroTimeSeries>
			<Customer>TestApi</Customer>
			<Attribute>0</Attribute>
			<DeleteBeforeInsert>true</DeleteBeforeInsert>
			<Length>6</Length>
			<User>tester</User>
			<SaveMetadata>true</SaveMetadata>
			<Metadata>
			<Id>1924</Id>
			<Name>tangermuende</Name>
			<StationId>0</StationId>
			<Unit>m3/s</Unit>
			<AttributeDescription>Default</AttributeDescription>
			<ErrorValue>NaN</ErrorValue>
			<TSClass>0</TSClass>
			</Metadata>
			<TimeSeriesString>
			2021-03-28 00:15:00,514.0#
			2021-03-28 00:30:00,517.0#
			2021-03-28 00:45:00,514.0#
			2021-03-28 01:00:00,514.0#
			2021-03-28 01:15:00,514.0#
			2021-03-28 01:30:00,514.0#
			</TimeSeriesString>
			</SydroTimeSeries>
			</source>

			<div class="info">
			'''Hinweise:''' (#278)
			* Bei einem POST Aufruf darf im XML-Dokument kein Namespace (<code>xmlns</code>) angegeben werden (d.h. der Root Tag muss genau <code><SydroTimeSeries></code> lauten.
			* Im Request Header muss als "Content-Type" "text/plain" angegeben sein.
			</div>

	<!--T:35-->		<!--T:35-->
	<~~pre~~>		Erläuterungen:
	<~~SydroTimeSeries~~>		* <code><Attribute></code>: (short)
	<~~Attribute~~> (short)		* <code><Customer></code>: (string)
	<Customer> (string)		* <code><DateValuePairSeparator></code>: (string) shows how Date/Value Pairs in TimeSeriesString can be split
	<DateValuePairSeparator> (string) shows how Date/Value Pairs in TimeSeriesString can be split		* <code><ErrorValue></code>: (double) Indicator what is an error value, will be replaced by NaN.
	<ErrorValue> (double) Indicator what is an error value, will be replaced by NaN.		* <code><HasError></code>: (boolean) shows if an error occured during processing the request
	<HasError> (boolean) shows if an error occured during processing the request		* <code><Id></code>: (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
	<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		* <code><Length></code>: (integer) Number or records in the TimeSeriesString
	<Length> (integer) Number or records in the TimeSeriesString		* <code><Lat></code>: (double) Latitude coordinate
	<Lat> (double) Latitude coordinate		* <code><Lon></code>: (double) Longitude coordinate
	<Lon> (double) Longitude coordinate		* <code><Name></code>: (string) Short name of the time series
	<Name> (string) Short name of the time series		* <code><Path></code>: (string) Path to the time series on the server
	<Path> (string) Path to the time series on the server		* <code><ResultMsg></code>: (string) Plain text describing errors if any or return a success message
	<ResultMsg> (string) Plain text describing errors if any or return a success message		* <code><SaveMetadata></code>: (boolean) Indicates whether or not metadata should be updated when posting time series values
	<SaveMetadata> (boolean) Indicates whether or not metadata should be updated when posting time series values <Separator> (string) indicates how date/values can be split		* <code><Separator></code>: (string) indicates how date/values can be split
	<StationId> (integer) ID of the station		* <code><StationId></code>: (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.		* <code><TimeSeriesHeader></code>: (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>		* <code><TimeSeriesString></code>: (string) This is the time series as text, where date/values are separated by the attribute <code><Separator></code> and entries are separated by <code><DateValuePairSeparator></code>
	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>		: Example: <code><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></code>
	<TsClass> (short) Represents the time series class with -1= unknown, 0=Default, 1=Flagged, 2=Forecast		* <code><TsClass></code>: (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		* <code><Unit></code>: (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.		* <code><User></code>: Name of the user requesting or posting the time series or the owner of the time series.
	~~</SydroTimeSeries>~~
	~~</pre>~~

	===SydroTimeSeries/process=== <!--T:36-->		===SydroTimeSeries/process=== <!--T:36-->

Froehlich: Update für TalsimNGSrv v2.0.5

2023-11-13T14:56:22Z

Update für TalsimNGSrv v2.0.5

← Nächstältere Version		Version vom 13. November 2023, 16:56 Uhr
Zeile 121:		Zeile 121:


	===SydroTimeSeries=== <!--T:32-->		===SydroTimeSeries/new=== <!--T:32-->

	<!--T:33-->		<!--T:33-->
Zeile 127:		Zeile 127:

	<!--T:34-->		<!--T:34-->
	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:		Wird ein POST Aufruf an diesen Endpunkt mit entsprechendem XML im body 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:

	<!--T:35-->		<!--T:35-->
Zeile 154:		Zeile 154:
	</SydroTimeSeries>		</SydroTimeSeries>
	</pre>		</pre>


	===SydroTimeSeries/process=== <!--T:36-->		===SydroTimeSeries/process=== <!--T:36-->

Froehlich: Formatierung

2023-05-08T06:51:51Z

Formatierung

← Nächstältere Version		Version vom 8. Mai 2023, 08:51 Uhr
Zeile 79:		Zeile 79:

	<!--T:25-->		<!--T:25-->
	Abfrage einer Zeitreihe		Abfrage einer Zeitreihe im XML-Format

	<!--T:26-->		<!--T:26-->
Zeile 85:		Zeile 85:

	<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/{customer},{user},{id}</nowiki></code>		<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/{customer},{user},{id}</nowiki></code>

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

	Optional kann noch ein SQL Statement <code>SQLCriteria</code> angegeben werden. Das SQL Statement ist momentan nur zum Testen aktiviert und wird wenn alle anderen Endpoints gesetzt sind wieder eingestellt.		Optional kann noch ein SQL Statement <code>SQLCriteria</code> angegeben werden. Das SQL Statement ist momentan nur zum Testen aktiviert und wird wenn alle anderen Endpoints gesetzt sind wieder eingestellt.
Zeile 97:		Zeile 94:
	<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/{customer},{user},{id},{startdate},{enddate},{attribFlag}</nowiki></code>		<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/{customer},{user},{id},{startdate},{enddate},{attribFlag}</nowiki></code>

	~~Weiterhin gibt es die Möglichkeit~~, ~~die Zeitreihen~~ im ASCII-Format ~~abzufragen~~:		<!--T:27-->
			Beispiel 1: <code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/TestAPI,MusterUser,9999,attribFlag=0</nowiki></code>

			===SydroTimeSeries/ASCII===

			Abfrage einer Zeitreihe im ASCII-Format:

	<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/ASCII?customer={customer}&user={user}&id={id}&startdate={startdate}&enddate={enddate}</nowiki></code>		<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/ASCII?customer={customer}&user={user}&id={id}&startdate={startdate}&enddate={enddate}</nowiki></code>

	~~oder~~ im BIN-Format:		===SydroTimeSeries/BIN===

			Abfrage einer Zeitreihe im BIN-Format:

	<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/BIN?customer={customer}&user={user}&id={id}</nowiki></code>		<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/BIN?customer={customer}&user={user}&id={id}</nowiki></code>

Froehlich am 8. Mai 2023 um 06:30 Uhr

2023-05-08T06:30:37Z

← Nächstältere Version		Version vom 8. Mai 2023, 08:30 Uhr
Zeile 85:		Zeile 85:

	<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/{customer},{user},{id}</nowiki></code>		<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/{customer},{user},{id}</nowiki></code>

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

	Optional kann noch ein SQL Statement <code>SQLCriteria</code> angegeben werden. Das SQL Statement ist momentan nur zum Testen aktiviert und wird wenn alle anderen Endpoints gesetzt sind wieder eingestellt.		Optional kann noch ein SQL Statement <code>SQLCriteria</code> angegeben werden. Das SQL Statement ist momentan nur zum Testen aktiviert und wird wenn alle anderen Endpoints gesetzt sind wieder eingestellt.
Zeile 101:		Zeile 104:

	<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/BIN?customer={customer}&user={user}&id={id}</nowiki></code>		<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/BIN?customer={customer}&user={user}&id={id}</nowiki></code>

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

	===SydroTimeSeries/combine=== <!--T:28-->		===SydroTimeSeries/combine=== <!--T:28-->

Froehlich: Beschreibung aktualisiert, verschiedene Endpoints ausgeführt

2023-05-08T06:11:38Z

Beschreibung aktualisiert, verschiedene Endpoints ausgeführt

← Nächstältere Version		Version vom 8. Mai 2023, 08:11 Uhr
Zeile 82:		Zeile 82:

	<!--T:26-->		<!--T:26-->
	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.		Als Parameter sind zu übergeben <code>customer</code>, <code>user</code>, <code>id</code> der Zeitreihe.
	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.
			<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/{customer},{user},{id}</nowiki></code>

			Optional kann noch ein SQL Statement <code>SQLCriteria</code> angegeben werden. Das SQL Statement ist momentan nur zum Testen aktiviert und wird wenn alle anderen Endpoints gesetzt sind wieder eingestellt.

			<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/{customer},{user},{id},{criteria}</nowiki></code>

			Alternativ akzeptiert die Schnittstelle auch drei Parameter für <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.

			<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/{customer},{user},{id},{startdate},{enddate},{attribFlag}</nowiki></code>

			Weiterhin gibt es die Möglichkeit, die Zeitreihen im ASCII-Format abzufragen:

			<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/ASCII?customer={customer}&user={user}&id={id}&startdate={startdate}&enddate={enddate}</nowiki></code>

			oder im BIN-Format:

			<code><nowiki>http://talsim.de:8092/TalsimNGServer/HttpZreSrv/SydroTimeSeries/BIN?customer={customer}&user={user}&id={id}</nowiki></code>

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


	===SydroTimeSeries/combine=== <!--T:28-->		===SydroTimeSeries/combine=== <!--T:28-->

Doeser am 1. Juli 2021 um 12:50 Uhr

2021-07-01T12:50:07Z

← Nächstältere Version		Version vom 1. Juli 2021, 14:50 Uhr
Zeile 52:		Zeile 52:
	<!--T:18-->		<!--T:18-->
	Beispiel: <code><nowiki>http://talsim.de:8090/TalsimNGServer/HttpDataSrv/requestZreFiles/Nile,hubert,16</nowiki></code>		Beispiel: <code><nowiki>http://talsim.de:8090/TalsimNGServer/HttpDataSrv/requestZreFiles/Nile,hubert,16</nowiki></code>

	~~===requestSystemAndSysVar=== <!--T:19-->~~


Zeile 61:		Zeile 59:

	Beispiel: <code><nowiki>http://talsim.de:8090/TalsimNGServer/HttpDataSrv/requestZreFile/Nile,hubert,1</nowiki></code>		Beispiel: <code><nowiki>http://talsim.de:8090/TalsimNGServer/HttpDataSrv/requestZreFile/Nile,hubert,1</nowiki></code>


			===requestSystemAndSysVar=== <!--T:19-->

	<!--T:20-->		<!--T:20-->

Doeser am 1. Juli 2021 um 12:45 Uhr

2021-07-01T12:45:10Z

← Nächstältere Version		Version vom 1. Juli 2021, 14:45 Uhr
Zeile 54:		Zeile 54:

	===requestSystemAndSysVar=== <!--T:19-->		===requestSystemAndSysVar=== <!--T:19-->


			===requestZreFile===

			Abfrage einer bestimmten Zeitreihen-Datei. Parameter sind <code>customer</code>, <code>user</code> sowie die ID der Zeitreihe.

			Beispiel: <code><nowiki>http://talsim.de:8090/TalsimNGServer/HttpDataSrv/requestZreFile/Nile,hubert,1</nowiki></code>

	<!--T:20-->		<!--T:20-->
Zeile 60:		Zeile 67:
	<!--T:21-->		<!--T:21-->
	Beispiel: <code><nowiki>http://talsim.de:8090/TalsimNGServer/HttpDataSrv/requestSystemAndSysVar/WFP_SSD,hubert,1</nowiki></code>		Beispiel: <code><nowiki>http://talsim.de:8090/TalsimNGServer/HttpDataSrv/requestSystemAndSysVar/WFP_SSD,hubert,1</nowiki></code>


	==HttpZreSrv== <!--T:22-->		==HttpZreSrv== <!--T:22-->

Doeser: Diese Seite wurde zum Übersetzen freigegeben

2020-09-23T13:29:31Z

Diese Seite wurde zum Übersetzen freigegeben

Änderungen zeigen