Instrument Status API

Note


The files are provided courtesy of SSEC/AOSS UW-Madison. Clients causing issues due to size or quantity of queries may be blocked from further access until the issue is resolved


Disclaimer

Products Available

Instrument and site status is technically available for any site/instrument archived as part of this system. However, some may not be configured on the backend and will return missing or unknown information.

Query Format

Base URL

The base URL of a status query specifies the requested site, instrument (optional), and file format (optional) to return:

http://metobs.ssec.wisc.edu/api/status/<site>/<inst>.<fmt>

Valid values for fmt are: 

                    html (default if not provided)
                    json

Valid values for site are: 

                    aoss
                    mendota

Valid values for inst at the "aoss" site are: 

                    tower
                    ceilo

Valid values for inst at the "mendota" site are: 

                    buoy

Response Format

The response is a key-value mapping (dictionary) with the following keys:

  • name: short computer-friendly name
  • short_name: Short human-friendly name
  • long_name: Long human-friendly name. For instruments this may include site name.
  • status_code: Integer code for current instrument status (see below)
  • status_message: Description and reason for current status
  • last_updated: YYYY-MM-DD HH:MM:SSZ

Status Code Meanings

  • 0: Nominal operation
  • 1: Limited functionality but data being produced
  • 2-7: reserved
  • 8: Out for the season (acceptable/expected out-of-operation)
  • 9: Hardware maintenance (acceptable/expected)
  • 10: Software maintenance (acceptable/expected)
  • 11-15: reserved
  • 16: Hardware failure (unexpected)
  • 17: Software failure including processing hardware failures (unexpected)
  • 18-254: reserved
  • 255: Unknown

Example Queries