This page contains detailed documentation on the forecast layer capabilities feed.
The forecast layer capabilities feed provides information on when the forecast layers that are currently available were issued, details the timesteps that are available, and lists the URIs at which they can be found. The forecast layer capabilities feed provides information on the available layers for the following products:
The forecast layer capabilities web service can be used to retrieve the output of the forecast layer capabilities feed. You should set the data format in the URL to specify whether the web service should return XML or JSON, and include your API key in the query string.
The following examples show a typical result of a call to the forecast layer capabilities web service.
The XML that follows is a representative response to a call to the following URL, with a valid key:
The JSON that follows shows the structure of a representative response to a call to the following URL, with a valid key:
The XML response produced by this web service contains a single Layers node, defined as follows:
The Layers object contains a single attribute, type, which always has the value 'Forecast'. It also contains single BaseUrl element, which gives the base url of the forecast layer feeds. This can be used to derive the URLs of the feeds themselves. BaseUrl contains a single attribute, forServiceTimeFormat, which specifies the format in which the timesteps are presented. This always has the value 'Timesteps', as each timestep is presented as an integer representing the number of hours after a specified default time. It also contains a number of Layer elements, one for each product for which the forecast layer capabilities feed provides data. The structure of each Layer element is described below.
A Layer object defines a single layer, and contains a single attribute,displayName, whose value indicates the product described by the Layer element. Each Layer object contains a single Service element, described below.
The Service object defines a single layer, and contains a single attribute,name, whose value indicates the name of the service that produced the data. The Service element contains the following elements.
The Timesteps object contains a single attribute,defaultTime, whose value indicates the time at which the forecast that generated the layers was run in ISO8601 format. The Timesteps object contains a number of Timestep elements. The value of each of these elements gives a time for which a forecast is available, expressed as a whole number of hours after the default time.