Version 2
Copyright © 2006-2012 Delaware Environmental Observing System
Published: October 6th 2006
| Revision History | ||
|---|---|---|
| Revision 2.1 | 2006/10/06 | GEQ |
| Initial version | ||
| Revision 2.2 | 2006/10/12 | GEQ |
| Added first cut at web service method descriptions. | ||
| Revision 2.3 | 2006/10/26 | GEQ |
| Removed explicit discussion of SOAP interface, revised options descriptions. | ||
| Revision 2.4 | 2006/12/08 | GEQ |
| Added getDataTypeList method. | ||
| Revision 2.5 | 2007/2/14 | GEQ |
| Updated document with span zero handling for data requests. | ||
Table of Contents
This document summarizes the available data feeds for the DEOS system. Feeds are divided into syndication feeds of daily and completed monthly data pages, and web service feeds.
The external interface to the web services are described in this section.
The following section describes the method implemented to retrieve the list of networks providing web service data.
To provide a list of networks providing data for the DEOS web services. The network names returned by this method are needed in subsequent calls to retrieve station IDs and station data.
The following are the options understood by this component.
The following section describes the method implemented to retrieve a list of stations from a given network or state, or county within a state.
To provide a list of stations in a given subset providing data for the DEOS web services. The station IDs returned by this method are needed in subsequent calls to retrieve the station data itself.
The following are the options understood by this component.
The following section describes the method implemented to retrieve the list of data types available.
To provide a list of data types providing data for the DEOS web services. The abbreviations returned by this method are needed in subsequent calls to retrieve station data if the user wishes to educe the volume of returned data.
The following are the options understood by this component.
The following section describes the method implemented to retrieve the meteorological data of a given station via the web service.
The following are the options understood by this component.
The following items are required.
key; a valid access key.
station; the station name.
network; the network name.
The following items are optional.
dataTypes; the list if data type
abbreviations
to use. The default is to retrieve data for all data types.
time; the date and time for the data retrieval. The default is the current date and time.
[1]
span; the time span (in minutes) for the data retrieval. The default is one hour. Spans over 24 hours are not permitted.
If a span of zero is requested, then any time parameter is ignored and the most recent data for all relevant data types are returned.
N.B. The date of this data may not be recent, so the user needs to check on the data currency.
units; either SI (default) or English
tz; the time zone that the data will be generated for. The default is UTC (GMT).
[2]
The following section describes the output in the case of a processing error.
The following list of parameters are the configurable items for the web services component and can be found
in the ofnidb.jnk file in the odd-divas directory.
gDEBUG: this is the setting that allows more output to be generated, assisting fixing problems.
gRECORDMAX: this is the maximum number of data items that can be retrieved.
Care must be exercised when setting this too large values. Other limits from PHP, both memory and execution time may occur.
The following sections describe the DEOS syndicated data feeds.
The DEOS Atom feeds are based on Atom Version 1.0.
The DEOS RSS (Real Simple Syndication) feeds are based on RSS Version 2.0.
Both the Atom and RSS feeds utilize GeoRSS encodings to specify the geographical location of the station providing the data.
It is expected that the web developer of the site hosting the data feeds will provide a summary page of all the feeds to allow subscribers easy access to all the available feeds. This section summarizes where the data feed files originate for the benefit of the web developer.
The daily feeds files are accessible as described in the following example:
The completed monthly data feeds are accessible as described in the following example:
Example 12. Monthly Feed Access
[DF_BASE_URI]/[feed type]/[network]/[station]/monthly-[unit type].xml
The options are as follows:
DF_BASE_URI: is set in the DCF and must match the DF_BASE_DIR setting, relative to the web site root.
feed type: Either Atom or rss.
network: the name of the network.
station: the name of the station.
unit type: either SI or english.