<< Click to Display Table of Contents >>
Navigation: Live > Agents > Web API Agents > Web API Open Data >
Live Air Ontario Agent
The Air Ontario Agent is a data loading agent available in EQuIS Live for obtaining Air Pollutant data from Air Quality Ontario.
Before using the Air Ontario 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 (DT_LOGGER row) in EQuIS Professional.
2.Set LIVE_DATA_SOURCE to http://airqualityontario.com.
3.Set LOGGER_CODE to an Air Quality Ontario Station Name (e.g., Windsor Downtown).
4.Set STATUS_FLAG to 'A' to activate the logger.
The Air Ontario 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 Air Ontario Agent or Historical Data Loader can also be run in EQuIS Professional or Enterprise (using the EZView widget) to load the data manually, without having to schedule an EIA.
The Air Ontario Agent will load data for all loggers with LIVE_DATA_SOURCE set to http://airqualityontario.com. The agent will request data from the logger's most recent date (in DT_LOGGER_DATUM.DATUM_UTC_DT) until today's date. If a logger does not have any values, it gets values for the past month.
The Air Ontario Historical Data Loader allows you to select the loggers and date range and pollutants. It has the following input parameters:
•Logger(s) – Select the stations for which to load data. If no station is selected, the agent will load data for all Air Ontario stations.
•Pollutant(s) – Select the pollutants.
•Date Range – Select a date range, choose from recent, period, or start and end dates. The recent option works the same way as the Air Ontario Agent. If the period option is selected, a period must be specified in ISO-8601 duration format. If the start and end dates option is selected, start and end dates must be specified.
•Update existing values? – Check this box to update existing EQuIS Live data values.
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 Air Ontario API.
Copyright © 2023 EarthSoft, Inc • Modified: 26 Apr 2022