<< Click to Display Table of Contents >>
Navigation: Live > Agents > Web API Agents > Web API Open Data >
Live UK Gov Flood Monitoring Agent
The United Kingdom (UK) Government Flood Monitoring Agent is a data loading agent available in EQuIS Live, used for obtaining sensor data from environment.data.gov.uk Flood Data API into EQuIS Live.
Before using the Agent, add one or more stations to the DT_LOGGER table:
1.Execute the equis.get_ids stored procedure to get a new LOGGER_ID, or add the station manually (DT_LOGGER row) in EQuIS Professional.
2.Set LIVE_DATA_SOURCE to http://environment.data.gov.uk/flood-monitoring/.
3.Set LOGGER_CODE to a station ID. You can search for a station ID here; it is the last set of values at the end of the listed ID (e.g., "@id": "http://environment.data.gov.uk/flood-monitoring/id/stations/2001" will have a station ID of 2001). Search (within the page linked previously in Step 3) for a specific river (e.g., Severn) or town (e.g., Bewdley) to get the station ID. The stations can also be searched via map here.
4.Set STATUS_FLAG to 'A' to activate the logger.
The United Kingdom (UK) Government Flood Monitoring Agent or Historical Data Loader can be run as a scheduled EQuIS Information Agent (EIA), at the desired frequency, to automatically load data as often as needed. The web API provides values at a minimum of 15 minute intervals. Therefore, the EIA for this report should not be scheduled to run more often than every 15 minutes.
The UK Government Flood Monitoring Agent or Historical Data Loader can also be run in EQuIS Professional or Enterprise (using the EZView widget) to manually load data, without having to schedule an EIA.
The UK Government Flood Monitoring Agent will load data for all loggers with LIVE_DATA_SOURCE set to http:/environment.data.gov.uk/flood-monitoring/. It does not have any input parameters, and only gets the latest value for each series (from http://environment.data.gov.uk/flood-monitoring/data/readings?latest).
The UK Government Flood Monitoring Historical Data Loader allows for the selection of the loggers, date range, and whether or not to update existing values.
Note: The UK Government Flood Monitoring Historical Data Loader can be run as a scheduled EIA, with no Logger(s) selected, and Date Range: 'Get all values from a logger's most recent value till now', to request recent values for all loggers. When the report is run initially, the Historical Data Loader will retrieve values from a logger's station (DT_LOGGER.LOGGER_CODE) for the past one month. If data has been previously loaded for that logger, the Historical Data Loader will request data from the logger's most recent date (in DT_LOGGER_DATUM.DATUM_UTC_DT) until today's date.
The UK Government Flood Monitoring Agent may miss values if it is not run often enough. The UK Government Flood Monitoring Historical Data Loader should not miss any values as long as it is run at least once per month (the UK Government Flood Monitoring Historical Data Loader allows us to specify start and end dates, but the API only seems to retain data for the past month or so).
A series can be activated or deactivated, by setting its STATUS_FLAG = "A" or "R", to start or stop (respectively) obtaining data for it. A series' SERIES_DESC may be changed, but not the SERIES_NAME and SERIES_UNIT; they uniquely identify the series using the parameter names and units from the UK Government Flood Monitoring API.
Copyright © 2023 EarthSoft, Inc • Modified: 26 Apr 2022