API NOAA Reports: Difference between revisions

656 bytes added ,  15:59, 18 October 2020
no edit summary
m (Mcrossley moved page API Reports to API Get Reports without leaving a redirect)
No edit summary
Line 1: Line 1:
''Back to [[Cumulus MX Local API]]''
''Back to [[Cumulus MX Local API]]''


== Year Reports ==
== Get Year Reports ==
The general format of the NOAA Year Report API request is as follows...
The general format of the NOAA Year Report API request is as follows...
<pre>http://localhost:8998:/api/reports/noaayear&year=NNNN</pre>
<pre>http://localhost:8998:/api/reports/noaayear&year=NNNN</pre>
Line 24: Line 24:




== Month Reports ==
== Get Month Reports ==
The general format of the NOAA Month Report API request is as follows...
The general format of the NOAA Month Report API request is as follows...
<pre>http://localhost:8998:/api/reports/noaamonth&year=NNNN&month=XX</pre>
<pre>http://localhost:8998:/api/reports/noaamonth&year=NNNN&month=XX</pre>
Line 46: Line 46:
     ... etc
     ... etc
  ]
  ]
== Regenerate Year Report ==
The general format of the API request to regenerate a NOAA year report from the data logs is as follows...
<pre>http://localhost:8998:/api/genreports?year=NNNN</pre>
Where NNNN is the year to regenerate.
Cumulus MX will return the new report in the format described above.
== Regenerate Month Reports ==
The general format of the API request to regenerate a NOAA monthly reports from the data logs is as follows...
<pre>http://localhost:8998:/api/genreports/noaamonth&year=NNNN&month=XX</pre>
Where NNNN is the year requested, and XX the month.
Cumulus MX will return the new report in the format described above.