API Records Data: Difference between revisions

3,329 bytes added ,  14:44, 18 October 2020
no edit summary
(Created page with "''Back to Cumulus MX Local API'' == All Time Records == The all time records data response is designed for displaying on a web page, the text is formatted with HTML codes...")
 
No edit summary
 
Line 67: Line 67:
     ]
     ]
  }
  }
== Monthly Records ==
The monthly records data response is designed for displaying on a web page, the text is formatted with HTML codes.
The general format of the records data API request is as follows...
<pre>http://localhost:8998:/api/records/month/ZZ/xxxxx</pre>
Where ZZ is the month number (1 - 12) and xxxx is the specific request as below:
=== temperature.json ===
{
    "data": [
        ["High temperature", "14.0 &deg;C", "09 January 2015 22:45"],
        ["Low temperature", "-7.9 &deg;C", "29 January 2011 08:07"],
        ["High dew point", "11.8 &deg;C", "24 January 2016 19:34"],
        ["Low dew point", "-8.8 &deg;C", "29 January 2011 08:10"],
        ["High apparent temp", "12.9 &deg;C", "24 January 2016 14:38"],
        ["Low apparent temp", "-10.9 &deg;C", "29 January 2011 08:26"],
        ["High feels like", "13.5 &deg;C", "24 January 2016 14:40"],
        ["Low feels like", "-8.7 &deg;C", "18 January 2013 18:19"],
        ["High Humidex", "-999.0 &nbsp;", "01 January 0001 00:00"],
        ["Low wind chill", "-8.7 &deg;C", "18 January 2013 18:19"],
        ["High heat index", "14.0 &deg;C", "09 January 2015 22:45"],
        ["Highest minimum temp", "9.1 &deg;C", "13 January 2011 00:15"],
        ["Lowest maximum temp", "0.2 &deg;C", "23 January 2019 02:52"],
        ["High daily temp range", "10.4 &deg;C", "01 January 2019"],
        ["Low daily temp range", "0.9 &deg;C", "19 January 2017"]
    ]
}
=== humidity.json ===
{
    "data": [
        ["High humidity", "100 %", "15 February 2014 12:28"],
        ["Low humidity", "31 %", "26 February 2019 14:44"]
    ]
}
=== pressure.json ===
{
    "data": [
        ["High pressure", "1043.6 hPa", "29 March 2020 13:34"],
        ["Low pressure", "975.7 hPa", "28 March 2016 04:23"]
    ]
}
=== wind.json ===
{
    "data": [
        ["High gust", "40.0 mph", "17 April 2013 20:14"],
        ["High wind speed", "22.0 mph", "29 April 2012 17:07"],
        ["High daily windrun", "258.9 miles", "29 April 2012"]
    ]
}
=== rain.json ===
{
    "data": [
        ["High rain rate", "132.4 mm/hr", "28 May 2015 02:00"],
        ["High hourly rain", "5.9 mm", "22 May 2011 02:10"],
        ["High daily rain", "25.2 mm", "19 May 2015"],
        ["Highest monthly rainfall", "124.4 mm", "May 2015"],
        ["Longest dry period", "20 days", "21 May 2020"],
        ["Longest wet period", "14 days", "18 May 2011"]
    ]
}
== This Month Records ==
The this months records data response is designed for displaying on a web page, the text is formatted with HTML codes.
The responses are the same format as the monthly records above
The general format of the records data API request is as follows...
<pre>http://localhost:8998:/api/records/thismonth/xxxxx</pre>
Where xxxx is the specific request as below:
temperature.json
humidity.json
pressure.json
wind.json
rain.json
== This Year Records ==
The this months records data response is designed for displaying on a web page, the text is formatted with HTML codes.
The responses are the same format as the monthly records above
The general format of the records data API request is as follows...
<pre>http://localhost:8998:/api/records/thismonth/xxxxx</pre>
Where xxxx is the specific request as below:
temperature.json
humidity.json
pressure.json
wind.json
rain.json