BPAPI Methods

BPAPI method Places

Places

Executes a search for places recognized by the given service (typical a weather forecast service).

Authorization required: Yes

HTTP methods allowed: GET

Syntax: Places/{service}/{search_criteria}/  Details   Details 

Executes a search for places recognized by the given service (typical a weather forecast service).

A maximum of 20 places are returned.

Returns a key / value collection where the format of the key is suitable for direct insertion into REST URLs as used by the given service.
For instance if yr.no is used as the service the format of the keys will be in one of the following two forms:

[COUNTRY]/[REGION]/[PLACE] like "Zimbabwe/Matabeleland_South/Springfontein" or
"Norway/[FYLKE]/[KOMMUNE]/[STED] like "Norge/Sør-Trøndelag/Trondheim/Lade"

These strings can in turn be inserted directly into a REST URL consumed by yr.no like

http://www.yr.no/sted/Zimbabwe/Matabeleland_South/Springfontein/varsel.xml or like
http://www.yr.no/sted/Norge/Sør-Trøndelag/Trondheim/Lade/varsel.xml

The value in every key / value pair returned will be in a form suitable for human consumption.
For instance like "Springfontein (Matabeleland_South, Zimbabwe)" or like "Lade (Trondheim, Sør-Trøndelag, Norway)"

Note: This method requires authentication in order to facilitate tailored result for the customer identified by the authorization credentials used.

A cache of places is kept within BPAPI. As of February 2014 the following URL is used to look for unknown places:
https://ws.geonorge.no/SKWS3Index/ssr/sok?navn=[search_criteria]*&eksakteForst=true
Confer with this URL if search through BPAPI does not give the desired result.
Places with "navnetype" other than
Kommune, By, Bydel, Tettbebyggelse, Bygdelag (bygd), Grend, Skogområde, Flyplass, Bruk (gardsbruk), Enebolig/mindre bolig (villa)
are ignored by BPAPI.


Unit-tests: 2 test(s)

Popularity: 332474 (number of times method has been accessed)

Documentation and tests automatically generated from source-code 2020-04-07 11:17