B<Tidalwater> - Tidal water information


NAME

Tidalwater - Tidal water information


DESCRIPTION

Returns data about waterlevel for a given harbor. Waterlevel have two components: tidal forces and the influence of weather. Tidal forces is the basis for calculating waterlevel. Forecast of weather conditions for the specified harbor is then used to adjust this basis. Waterlevels based on tidal forces are available for the entire current year. Weather condition adjustments are generally available for the immediate three days.

Values are given as centimeters above seamap zero.


Available

The /available - action is not implemented for Tidalwater.


Restrictions

Access to tidal data is restricted and is not freely available. This applies to both 'combined' and 'tidal'. Please refer to our general documentation regarding this topic.


Schema

The schema for the xml delivered by this product is available from http://api.yr.no/weatherapi/tidalwater/1.1/schema.


Parameters

A request must specify content-type and the harbour of interest. Content-type can be either text/plain or text/xml.

Required parameters for a specified content_type: text/xml: Requires content_type, datatype, harbour, to and from.

text/plain: Requires content_type, harbour and datatype. Additionally, datatype 'tidal' requires parameter year.

harbor (mandatory)

Specify the harbor of interest.

Available harbors:

andenes, bergen, bodø, hammerfest, harstad, heimsjø, helgeroa, honningsvåg, kabelvåg, kristiansund, måløy, narvik, ålesund, oscarsborg, oslo, rørvik, stavanger, tregde, tromsø, trondheim, vardø, viker

from

The start time for which data is wanted. Hourly resolution.

Value-format: yyyy-mm-ddThh:00:00Z (UTC)

This parameter is required when content_type is text/xml.

to

The end time for which data is wanted. Hourly resolution.

Value-format: yyyy-mm-ddThh:00:00Z (UTC)

This parameter is required when content_type is text/xml.

content_type (mandatory)

Specify content type for the returned data.

Valid values is text/plain and text/xml

datatype (mandatory)

Specify type of data. 'combined' returns both type of data and can only be used when content_type is text/xml.

Valid values is tidal, weathercorrection and combined.

year

Specify which year data is wanted for. This option is only valid when type is tidal and content_type is text/plain, and is required.


Example requests

http://api.yr.no/weatherapi/tidalwater/1.1/?harbor=bergen;from=2008-02-25T00:00:00Z;to=2008-02-28T12:00:00Z;content_type=text/xml;datatype=combined

http://api.yr.no/weatherapi/tidalwater/1.1/?harbor=trondheim;content_type=text/plain;datatype=tidal;year=2008

http://api.yr.no/weatherapi/tidalwater/1.1/?harbor=trondheim;content_type=text/plain;datatype=weathercorrection


Changelog

1.1 2008-02-25

- New version 1.1 available
- Changed name of parameter: type => datatype.
- Parameter datatype is now mandatory.
- Access to tidal data has been restricted.
- Old version, 1.0, expires 1.april 2008.
 B<Tidalwater> - Tidal water information