Gå til hovedinnhold

Dokumentasjon for API

Introduksjon​

API-et er et webtjeneste-API laget for å gi tilgang til matrikkeldata, både i små og store mengder. Det finnes tjenester for å søke etter data basert på logiske inndata, som adressenavn og husnummer, samt tjenester for å hente data basert på numeriske ID-er.

Denne dokumentasjonen skal gi et innblikk i hvordan API-et er bygget opp og hvordan man kan bruke det. Det vil gi innsikt i hvordan man går fram for å ta API-et i bruk, hvordan man gjør søk og hvordan man navigerer i API-ets modell.

Oppsett av dokumentasjon​

Dokumentasjonen er delt inn i følgende deler:

  1. Komme i gang: Hvordan laste ned WSDL-er og XSD-er, og hva som kreves for å ta API-et i bruk.

  2. Boblemodellen: Introduksjon til boblemodellen som brukes i matrikkelen og API-et, inkludert navigasjon i modellen.

  3. Historikk i matrikkelen: En sentral del av API-et som forklarer hvordan historikk håndteres i matrikkeldata.

  4. Tekniske detaljer: Detaljert informasjon om struktur, formater, regler og tekniske prinsipper i API-et.

  5. Tjenester: Klassifisering og typer tjenestemetoder i API-et — søk, identoppslag og inversrelasjoner.

  6. Tjenesteliste: Fullstendig oversikt over alle tjenester med WSDL-lenker, gruppert etter domene.

  7. Spesielle tjenester: Detaljert dokumentasjon av StoreService, RapportService, KodelisteService, NedlastningService, EndringsloggService og feilhåndtering.

  8. Forklaring av datafeltene: Beskrivelse av datafeltene i matrikkelens implementasjonsmodell.

  9. GeointegrasjonsAPI: Tjenester for uthenting av matrikkeldata i henhold til geointegrasjonsstandarden.

  10. RegisterOppdateringAPI: Webservicer for oppdatering av data fra eksterne registre (grunnforurensing, kulturminne).

  11. WFS og WMS: Web Feature Service og Web Map Service for uthenting og visning av utvalgte matrikkeldata.

  12. Berettiget interesse: Dokumentasjon av rollen «Berettiget interesse» og hvilke felter som begrenses for brukere med denne rollen.