Kartverkets indekserte søk på stedsnavn henter data fra Sentralt stedsnavnregister (SSR).
Denne veiledningen er rettet mot utviklere som vil bruke tjenesten i egne løsninger. Ønsker du bare å søke etter en adresse, kan du søke på norgeskart.no. Er du interessert i å laste ned datasett med stedsnavn, kan du gå videre til nedlastingsportalen vår, Geonorge.
Om stedsnavnsøket
Det indekserte søket går mot en kopi av Sentralt stedsnavnregister (SSR) i form av en Lucene-indeks, optimalisert for hastighet, for å gjøre søket egnet for ”Typeahead”-funksjonalitet.
Tjenesten er tilgjengelig som en webservice med en rekke obligatoriske og frivillige parametere. Den har både et SOAP-grensesnitt og et REST- grensesnitt med retur i XML-format, med identiske spørrings- og returparametere for de to grensesnittene.
URL til SOAP WSDL for tjenesten: https://ws.geonorge.no/SKWS3Index/ssrIndexSearch?wsdl
REST-URL til tjenesten: https://ws.geonorge.no/SKWS3Index/ssr/sok?
Spørreparametere
Spørreparameterne er:
- ssrId (ikke kompatibel med andre søkeparametere, unik id fra gamle SSR): Stedsobjekt id (SSR id) for et stedsnavn. For eksempel " 1148612" som er "Ask" i Ringerike kommune.
- ssrObjId (ikke kompatibel med andre søkeparametere): Objekt id (SSR Obj id) for et stedsnavn. For eksempel " 33602" som er "Glomma", og som vil returnere treff for både "Glomma" og "Glåma", som er begge navneenheter tilknyttet SSR Obj id 33602.
- navn: Skrivemåte stedsnavn i SSR. Kan ta "*" som trunkeringstegn foran eller etter strengen (men ikke begge). For eksempel "Ask*", som vil returnere alle stedsnavn som begynner på "Ask".
- nordLL: avgrensning for nord koordinat, nedre venstre hjørne.
- ostLL: avgrensning for øst koordinat, nedre venstre hjørne.
- nordUR: avgrensning for nord koordinat, øvre høyre hjørne.
- ostUR: avgrensning for øst koordinat, øvre høyre hjørne.
- fylkeKommuneListe: liste med kommune eller fylkesnummer. For eksempel "605,612" som vil begrense søket til navn i Ringerike og Hole kommune.
- antPerSide: Maksimum antall treff som blir returnert. Standardverdi er 50, hvis parameter ikke er satt. Høyeste tillatte verdi er 5000.
- side: Hvilken side treffene skal begynne fra. Side 0 (fra første treff) er standard verdi. Ettersom
5000 er maks pr. side må man hente en og en side der det er mer enn 5000 i treffet.
- epsgKode: Epsg kode for koordinatsystem for koordinater i spørring og retur. Standardverdi er 25833 (Euref 89, utm sone 33), hvis parameter ikke er satt.
- eksakteForst: Hvis verdien er "true", så vil navn som matcher nøyaktig ved et trunkert søk, sorteres først, uavhengig av prioritet for navnet.
- json: for å få json tilbake kan man oppgi dette i søkestreng
Returparametere
Returparameterne er:
- sokStatus
- ok : ”true” hvis søket var vellykket, ”false” hvis ikke.
- melding: tom hvis søket var vellykket, vil inneholde beskrivelse av feilmelding hvis det ikke var vellykket.
- stedsnavn (liste)
- ssrId: Stedsobjekt id (SSR id) for stedsnavnet.
- navnetype: tekst for navnetypen til stedsnavnet.
- kommunenavn: navn på kommune for stedsnavnet.
- stedsnavn: Den offentlig representasjonen for stedsnavnet.
- aust: Øst koordinat for representasjonspunkt for stedsnavnet.
- nord: Nord koordinat for representasjonspunkt for stedsnavnet.
- epsgKode: kode for koordinatsystem til stedsnavnet (25833) er Euref89 utm sone 33.
- skrivemaatestatus: Status for skrivemåten.
- skrivemaatenavn: Skrivemåte for stedsnavnet.
- spraak: Navnets språk.
Ingen av parameterne er obligatoriske, men minst en av parameterne ssrObjId, ssrId, navn og geografisk begrensning (nordLL,ostLL, nordUR og ostUR) må være satt.
Eksempler på bruk av REST-service
Eksemplet https://ws.geonorge.no/SKWS3Index/ssr/sok?navn=Ask*&maxAnt=50&epsgKode=42
58&fylkeKommuneListe=605,612&eksakteForst=true returnerer de opptil 50 første navnene som begynner på "Ask" i Ringerike og Hole kommune, med navn som er nøyaktig ”Ask” sortert først.
Eksemplet https://ws.geonorge.no/SKWS3Index/ssr/sok?ssrId=1148612&epsgKode=25833 returnerer "Ask" i Ringerike kommune.
Eksemplet https://ws.geonorge.no/SKWS3Index/ssr/json/sok?antPerSide=5000&epsgKode=25832&side=0&fylkeKommuneListe=403 returnerer alle navnene i kommune 403 dersom det ikke er flere enn 5000.