Data readout example - Revision history

KKoPV at 12:09, 19 December 2014

2014-12-19T12:09:36Z

KKoPV at 17:27, 16 March 2014

2014-03-16T17:27:28Z

KKoPV: /* Returned content type */

2014-02-28T08:11:22Z

‎Returned content type

KKoPV at 07:26, 28 February 2014

2014-02-28T07:26:16Z

KKoPV at 13:21, 27 February 2014

2014-02-27T13:21:28Z

KKoPV: Created page with "For full list of supported request parameters refer to the API parameters documentation == Time period == If the queried time period (end – AP..."

2014-02-27T13:20:54Z

Created page with "For full list of supported request parameters refer to the API parameters documentation == Time period == If the queried time period (end – AP..."

New page

For full list of supported request parameters refer to the [[API parameters]] documentation

== Time period ==

If the queried time period ([[API parameters#end|end]] – [[API parameters#start|start]]) is less than the [[API parameters#period|consolidation period]], the result can be only one line by design.

(Remember the defaults: <tt>start=00:00</tt>, <tt>end=24:00</tt>)

== Time declarations ==

Here are some useful examples for relative <tt>start</tt> and <tt>end</tt> declarations

{| class="wikitable"
|-
! What !! Request as <tt>start</tt> or <tt>end</tt>
|-
| 1-Jan this year || <tt>1/1 first day of this year</tt>
|-
| 1-Jan of last year || <tt>1/1-1year first day of last year</tt>
|-
| 1st day of this month|| <tt>first day of this month</tt>
|-
| 1st day of last month || <tt>first day of last month</tt>
|}

'''Don't forget''' to URL encode your parameters, e.g. as <tt>first+day+of+this+year</tt>

== Returned content type ==

The returned content type is deteced by the requested file extension
* <tt>.json</tt> or not set → JSON
* <tt>.csv</tt> → Semicolon separated values
* <tt>.tsv</tt> → TAB separated values

== Examples ==

'''Get all feed-in power values from today as CSV, so many lines as data records exists'''

<nowiki>http://your.domain.here/api/r3/data/{GUID}.csv</nowiki>

'''As above, but as JSON array of objects'''

<nowiki>http://your.domain.here/api/r3/data/{GUID}.json</nowiki>

'''Get only one CSV line of the last stored data record today'''

<nowiki>http://your.domain.here/api/r3/data/{GUID}.csv?period=last</nowiki>

'''Get CSV lines of data on daily basis.'''

Because of the queried time period (00:00 – now), the result will be one line...

<nowiki>http://your.domain.here/api/r3/data/{GUID}.csv?period=1day</nowiki>

'''Get CSV lines on daily basis, start at begin of the year'''

This will return one line for each day in the time period.

<nowiki>http://your.domain.here/api/r3/data/{GUID}.csv?start=1/1&period=1day</nowiki>

'''Get data as above, but on a weekly basis'''

http://your.domain.here/api/r1/{GUID}.csv?start=1/1&period=1week

'''Get all data for last 7 days'''

<nowiki>http://your.domain.here/api/r3/data/{GUID}.csv?start=-7days</nowiki>

'''Get the monthly data since commissioning'''

<nowiki>http://your.domain.here/api/r3/data/{GUID}.csv?start=0&period=1month</nowiki>

'''Get CSV lines of data on yearly basis'''

Because of the queried time period ("1-Jan this year" ... "now" is lower than aggregation period), the result will be one line...

<nowiki>http://your.domain.here/api/r3/data/{GUID}.csv?start=1/1&period=1year</nowiki>

[[Category:Example]]

@@ Line 1: / Line 1: @@
-{{TOCright}}
+{{TOCright}}[[Category:API]][[Category:Example]]
 == Parameters ==
@@ Line 76: / Line 76: @@
   <nowiki>http://your.domain.here/api/r3/data/{GUID}.csv?start=1/1&period=1year</nowiki>

@@ Line 1: / Line 1: @@
 == Parameters ==
@@ Line 5: / Line 6: @@
 == Time period ==
-If the queried time period ([[API parameters#end|end]] – [[API parameters#start|start]]) is less than the [[API parameters#period|consolidation period]], the result can be only one line by design.
+If the queried time period ([[API#Parameters|end]] – [[API#Parameters|start]]) is less than the [[API#Parameters|consolidation period]], the result can be only one line by design.
 (Remember the defaults: <tt>start=00:00</tt>, <tt>end=24:00</tt>)

← Older revision		Revision as of 07:26, 28 February 2014
Line 1:		Line 1:
−	For full list of supported request parameters refer to the [[API parameters]] documentation	+	== Parameters ==
		+
		+	For full list of supported request parameters refer to the [[API#Data_readout\|API parameters]] documentation

	== Time period ==		== Time period ==

@@ Line 30: / Line 30: @@
 == Returned content type ==
-The returned content type is deteced by the requested file extension
+see [[API#Requested format|explanation]]
 == Examples ==

@@ Line 61: / Line 61: @@
 '''Get data as above, but on a weekly basis'''
-  http://your.domain.here/api/r1/{GUID}.csv?start=1/1&period=1week
+  <nowiki>http://your.domain.here/api/r1/{GUID}.csv?start=1/1&period=1week</nowiki>
 '''Get all data for last 7 days'''