MatrikkelsokServiceWS

Namespace: http://matrikkel.statkart.no/matrikkelapi/wsapi/v1/service/matrikkelsok
Oversikt

findTekstelementerForAutoutfylling

Finner elementer (adresse [veg, vegadresse, matrikkeladresse], eiendom eller bygning) fra en søkeindeks basert på en søkestreng og andre parametere.

(Dokumentasjon hentet fra MAT-8733, "Utvikling og bruk av søkeindeks for nasjonale geodataregistre ver 0.7" [gjelder kun søk mot Matrikkelen] og dokumentasjon av lucene-funksjoner i API-1840 [http://jira.statkart.no:8080/browse/API-1840].)

Søkeindeksen (Lucene-indeksen, se API-1840) innebærer at elementene fra Matrikkelen som det søkes etter er ordnet etter metadatafelt.
Metadatafelt: Id (unik ID), Title (benyttes som tittellinje ved visning, i autoutfylling), Kommunenr (benyttes for å kunne filtrere søk) osv. Feltene er spesifikke for de ulike elementene.
Søkeapplikasjonen indekserer informasjon og holder denne oppdatert ved direkte tilgang til databasen eller ved tilgang til datatjenester som leverer informasjon fra registret.

Søket går altså ikke mot levende matrikkeldata. Indeksen genereres én gang i døgnet, og dette betyr at endringer gjort det siste døgnet ikke nødvendigvis vil returneres her.

Søkesvaret følger et fellesformat: Tittel (title) og en beskrivelse, som er en samling av visse metadatafelt.
Eksempler:

Veg:         Havnegata, Kristiansand (Veg)
Type: Veg, Kommune: 1001 Kristiansand, Kilde: Adresse
Vegadresse:  Havnegata 22, Kristiansand (Adresse)
Adresse: Havnegata 22, 4622 Kristiansand, Type: Adresse, Kommune: 1001 Kristiansand, Fylke: Vest-Agder, Gårds- og bruksnr: 1001-150/654, Kilde: Adresse
Eiendom:     Kristiansand -150/654 (Eiendom)
Gårdsnr: 150, Bruksnr: 654, Type: Eiendom, Adresse: Havnegata 22, 4622 Kristiansand, Kommune: 1001 Kristiansand, Kilde: Eiendom
Bygning:     168241011- Kristiansand (Bygning)
Bygningsnr: 16824101, Type: Tomannsbolig, horisontaldeltKommune: 1001 Kristiansand, Fylke: Vest-Agder, Kilde: Bygning

sokeStreng: Inneholder teksten søket baseres på. Søket retter seg mot ulike metadatafelt for elementene:

Veg: NAVN (adressenavn f.eks. Høybyveien)
Vegadresse: NAVN (adressenavn husnr[bokstav])
Matrikkeladresse: NAVN (kommunenr-gårdsnr/bruksnr[/festenr][-undernr])
Eiendom: NAVN (kommuenr-matrikkelnr, f.eks. 0605-49/120*), TITTEL2 (kommunenavn-matrikkelnr), TITTEL3 (matrikkelnr, kommunenavn), TITTEL4 (adressenavn husnr[bokstav], postnr poststed-matrikkelnr) eller VEGADRESSE2 (adressenavn husnr[bokstav])
Bygning: NAVN (bygningsnr-kommunenavn)

For videre informasjon, se http://jira.statkart.no:8080/browse/MAT-8733.
* Matrikkelnr: Gårdsnr/bruksnr

Søket vil også splitte sokeStreng på komma og prøve å finne innhold etter komma i metadatafeltet TILHOERIGHET. Dette feltet inneholder informasjon om plassering av elementet ved kommunenavn, fylkesnavn og eventuelt kretsnavn.

Eksempler:

Kartverksveien 21, Ringerike -- Gir tilbake alle elementer som matcher hele strengen, eller "Kartverksveien 21*" og TILHOERIGHET="Ringerike".
Kartverksveien -- Gir tilbake alle elementer som matcher hele strengen eller som begynner på strengen.
0605-38 -- Gir tilbake alle elementer som matcher hele strengen eller som begynner på strengen. Dette vil matche NAVN-feltet for eiendom.
Ringerike-38/69 -- Gir tilbake alle elementer som matcher hele strengen eller som begynner på strengen. Dette vil matche TITTEL2-feltet for eiendom.

parametre: Spesifiserer hvilke felt filtreringen skal gå på. Felter som kan brukes er beskrevet i MAT-8733 som er gitt over.
Disse skal brukes sammen med sokeStreng og skal ikke angis alene.

Eksempler:

KILDE:Eiendom KOMMUNENR:0605 -- Gir tilbake alle eiendommer i kommune med nr 0605.
FYLKESNAVN:Buskerud TILHOERIGHET:Hønefoss -- Gir tilbake alle elementer som ligger i Buskerud og har TILHOERIGHET Hønefoss.
Kan ikke ha mellomrom etter kolon.

returFelter: Her kan man angi hvilke felter man vil ha i retur, eksempelvis KILDE, ID osv. Må skrives i store bokstaver.
Dersom ingenting angis her får man alle felter tilbake.

startPosisjon: Parameter som gjør det mulig å "bla" i søkeresultatene; den angir startposisjon for paginering. Dvs. at når denne ikke angis, returneres de 20 mest relevante elementene. Det er det samme som å gi startPosisjon verdien 0. For verdien 1 vil alle resultatene forskyves 1 plass opp så det øverste resultatet forskyves ut. Støtte for verdier opp til 100. Dersom man angir et høyere tall enn 100 vil man få det samme resultatet som om man hadde angitt 100. (Denne begrensningen på hvor mye data som returneres er utviklet fordi tjenesten er ment for bruk i klienter som ønsker autofylling ved søk.)

Input
  • sokeStreng - Strengen som søkeapplikasjonen sammenlikner visse felter i indekseringen med.
  • parametre - Inneholder felt(er) for eventuell filtrering.
  • returFelter - Felt(er) i index som skal returneres. Tom tabell gir alle felt.
  • startPosisjon - Startposisjon for paginering.
  • matrikkelContext - Context for søk.
Response
  • return - Liste av elementer (strenger: tittel og beskrivelse) som matcher sokeStreng.
    StringList
  • ServiceException - ved applikasjonsfeil
    ServiceException