Brukarrettleiing for stadnamn-API

Kartverkets hurtigsøk på stadnamn er eit REST-API som hentar data frå det nasjonale stadnamnregisteret. Du finn API-et på Geonorge.

Dokumentasjon

Den til eikvar tid oppdaterte dokumentasjonen er Swagger/OpenAPI dokumentasjon.

Tenesta opererer mot datasettet «Stedsnavn (Komplett SSR» (Geonorge). I produktspesifikasjon for datasettet på Geonorge kan du lese meir om kva dei ulike felta i tenesta tyder. Tenesta krev ikkje registrering.

Bruk av Stadnamn REST-API

Tenesta fungerer slik:

1. Set saman ei spørjing i nettlesaren
2. Spørjing blir send til databasen
3. Du får så tilbake data i nettlesaren

På Swagger/OpenAPI dokumentasjonssida får du hjelp til å setje saman spørjesetningar og du kan teste spørjinga mot databasen.

Spørjefunksjonalitet

GET / navneobjekttyper – gir deg liste over alle lovlege namneobjekttypar ein kan avgrense søket til.

GET / sprak – gir deg liste over alle lovlege språk ein kan avgrense søket til.

GET / navn – gir tilbake alle namn innafor avgrensinga til søket, med kommunenummer, namneobjekttype, namnestatus, skrivemåtestatus, språk og stadnummer for staden det høyrer til, samt eit representasjonspunkt for staden.

Eksempel: Søk etter alle namn som startar med Porsanger i Porsanger kommune (5436):

https://ws.geonorge.no/stedsnavn/v1/navn?knr=5436&sok=Porsanger*&treffPerSide=100&side=1

GET / sted – gir tilbake alle stader innafor avgrensinga til søket med alle offentlege stadnamn på staden med informasjon om namnestatus, skrivemåtestatus, namneobjekttype, språk, stadnamnnummer for namnet på staden og stadnummer, samt geometrien og eit representasjonspunkt for staden.

Eksempel: Søk etter alle stader i Porsanger kommune(5436) som har namn som startar med Porsanger:

https://ws.geonorge.no/stedsnavn/v1/sted?knr=5436&sok=Porsanger*&treffPerSide=10&side=1

GET / punkt – gir tilbake alle stader innafor avgrensinga til søket med alle offentlege stadnamn på staden med informasjon om namnestatus, skrivemåtestatus, namneobjekttype, språk, stadnamnnummer for namnet på staden og stadnummer, samt eit representasjonspunkt for staden.

Eksempel: Søk etter alle stader som ligg inntil 500 meter frå den oppgitte Euref89 koordinaten i UTM sone 33(25833):

https://ws.geonorge.no/stedsnavn/v1/punkt?nord=7824313&ost=869210&radius=500&koordsys=25833&treffPerSide=10&side=1

Med enkel programmering kan spørjetenesta integrerast i for eksempel publikumstenester på nett, for å verifisere eit stadnamn og posisjon, eller for å hente ut ei liste av stadnamn. Alt som kan koplast til eit stadnamn kan ved hjelp av REST-API-et koplast til eit geografisk punkt.

Respons

Dersom du ikkje ønsker alle elementa i treffet, kan det gjerast eit utval av felt. I eksemplet under ber vi om å få levert sjølve skrivemåten og skrivemåtestatusen for stadnamna.

Søk skrivemåte og skrivemåtestatus for alle namn som byrjar med Porsanger i Porsanger kommune:

https://ws.geonorge.no/stedsnavn/v1/navn?knr=5436&sok=Porsanger*&filtrer=navn.stedsnavn.skrivemåte,navn.stedsnavn.skrivemåtestatus&treffPerSide=10&side=1

I tillegg kan du velje kor mange treff per side og kor mange sider du ønskjer levert.