RapportServiceWS

De samme metodene som ligger internt implementeres i WS-API

Dette er en tjeneste for å lage rapporter fra matrikkeltjeneren. Tjenesten kan lage rapporter med rammeverket Jasper Report eller Velocity avhengig av hvilken type rapport som skal produseres.

Rapporter med layout for utskrift eller eksport til PDF/RTF produseres ved hjelp av Jasper Report. SOSI rapporter eller komma-separerte rapporter produseres ved hjelp av Velocity.

Hver enkelt rapporttype er definert gjennom en predefinert rapport-mal/fil (ihhv. Jasper Report eller Velocity). Denne tjenesten vil fylle en rapport med data basert på angitt søke-utvalg.

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

createMatrikkelbrev

Lager rapporten matrikkelbrev (attestert utskrift over registrerte opplysninger for matrikkelenhet) per dags dato for angitt matrikkelenhet. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert. Kan hentes ut ved hentRapport-funksjon med JobbIdnår rapporten er generert ferdig.

Input
  • matrikkelenhetId - matrikkelenheten det skal lages matrikkelbrev over.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (pdf (2) eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createMatrikkelbrevHistorisk

Lager rapporten historisk matrikkelbrev (attestert utskrift over registrerte opplysninger for matrikkelenhet) for angitt matrikkelenhet på angitt dato og klokkeslett. ved hentRapport-funksjon med JobbIdnår rapporten er generert ferdig.

Input
  • matrikkelenhetId - matrikkelenheten det skal lages matrikkelbrev over.
  • tidspunkt - timestamp (dato og klokkeslett) for de historiske dataene (format: 9999-01-01T00:00:00+01:00).
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (pdf (2) eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createSamletRapportForMatrikkelenhet

Lager rapporten samlet rapport (utskrift over registrerte opplysninger for matrikkelenhet) for angitt matrikkelenhet. Har med oversiktskart, kart over hovedteig og arealkoordinater. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbIdnår rapporten er generert ferdig.

Input
  • matrikkelenhetId - matrikkelenheten det skal lages matrikkelbrev over.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (pdf (2) eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createSamletRapportForMatrikkelenhetUtenKart

Lager rapporten samlet rapport (utskrift over registrerte opplysninger for matrikkelenhet) uten kart for angitt matrikkelenhet. Har ikke med oversiktskart, kart over hovedteig og arealkoordinater. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • matrikkelenhetId - matrikkelenheten det skal lages matrikkelbrev over.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (pdf (2) eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createKommunalTilleggsdelForMatrikkelenhet

Lager rapporten kommunal tilleggsdel (utskrift av data registrert i kommunal tilleggsdel på matrikkelenhet) for angitt matrikkelenhet. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • matrikkelenhetId - matrikkelenheten det skal lages matrikkelbrev over.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (pdf (2) eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createAdresseendringsRapport

Lager en adresseendringsrapport (endrede adresseidenter, endrede adressedata, utgåtte osv.) basert på kommune og aktuelt tidsrom for endringer. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • kommuneId - id til aktuell kommune vi ønsker å se adresseendringer for.
  • fra - evt dato fra og med endringer har skjedd (format: 9999-01-01T00:00:00+01:00).
  • til - evt dato til og med endringer har skjedd (format: 9999-01-01T00:00:00+01:00).
  • endringskilder - filter for endringskilder for oppdateringer (f.eks. oppdatering fra matrikkelen eller fra eksternregister), se kodeliste EndringsKildeKode.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (pdf (2) eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createAdresseendringerForFlereKommunerRapport

Lager en adresseendringsrapport (endrede adresseidenter, endrede adressedata, utgåtte osv.) for flere kommuner angitt ved KommuneId for aktuelt tidsrom for endringer. De enkelte kommunerapportene samles i en zip-fil som kan hentes etter generering gjennom JobbId. som metoden returnerer. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Hentes ut vha en url til en zip-fil ved hentRapport-funksjon med JobbIdnår rapporten er generert ferdig. Zip-filen består av en pdf-rapport per kommune.

Input
  • kommuneIds - Liste av id'ene til kommunene som skal inngå i adresseendringsrapporten.
  • fra - evt dato fra og med endringer har skjedd (format: 9999-01-01T00:00:00+01:00).
  • til - evt dato til og med endringer har skjedd (format: 9999-01-01T00:00:00+01:00).
  • endringskilder - filter for endringskilder for oppdateringer (f.eks. oppdatering fra matrikkelen eller fra eksternregister), se kodeliste EndringsKildeKode.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (sosi (0), tekstformat (1), pdf (2), eller semikolonseparert (3), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres
    ServiceException

createAdresseRapport

Lager adresserapport for adresser som tilfredsstiller kriteriene for adresser gitt i AdressesokModel. Innholdet i rapporten bestemmes gjennom valgt rapportformat som knytter seg til en rapportmal (enkel/massiv).

Generelle krav i søkemodell for adresse:

  • Krets: Kretsnummer krever at også kretstypeKodeId er oppgitt og omvendt.
  • Person: Kan ikke søke på fornavn alene, krever óg etternavn.
  • Matrikkelenhet: Verken gårdsnummer, bruksnummer, festenummer eller seksjonsnummer kan ikke være lavere enn null.
  • Bruksenhetsnummer: Kan ikke angis uten vegadresse og må være gyldig.
  • Fonetikk: Kan ikke angi at adressenavn, adressetilleggsnavn eller navn er gitt fonetisk uten at tilhørende tekstfelt er fylt ut.
  • Kommunenr: Kommunenr og KommuneId har samme verdi, men må ikke blandes i den forstand at i kommunenr kan ikke en eventuell null som første siffer utelates.
Søket må tilfredsstille bestemte krav (f.eks. krever søk ved person at ikke bare fornavn oppgis, men etternavn også), ellers kastes exception av validate-metode i klassen AdressesokModel. Andre rapporttyper støttes ikke, f.eks. vil rapportTypeId = 4 (adressehistorikk) kaste exception. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • adresseSokModel -
  • adresseRapportTypeId - Verdi 1-8 gir hvilken mal rapporten skal følge. 0 for massiv, 1 for SOSI 4.0, 2 for enkel,8 for enkel SOSI 4.5. Se kodeliste AdresseRapportType.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (sosi (0), pdf (2), eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - Context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createAdresseRapportForKommuneutvalg

Genererer adresserapport(er) for en samling av kommuner angitt ved KommuneId. Returnerer en zip-fil som inneholder en rapport for hver kommune. er kommunenavnet og stemmer overens med tilhørende KommuneId. strengen beskriver filnavnet, og settet beskriver kommuneutvalget til hver rapport-fil som legges til arkivet. Se kodeliste AdresseRapportType. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Hentes ut vha en url til en zip-fil ved hentRapport-funksjon med JobbIdnår rapporten er generert ferdig. Zip-filen består av en fil per kommune.

Input
  • kommuneUtvalg - Et map der nøkkelen er en streng som beskriver filnavnet, og tilhørende verdi er en KommuneId. Settet beskriver utvalget om filnavn
  • adresseRapportTypeId - Verdi 1-8 gir hvilken mal rapporten skal følge. Støtte for 1 - SOSI 4.0, ikke støtte for 0, massiv og 2, enkel.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (sosi (0), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createAdresseKontrollRapport

Kontrollrapport (oversikt over feil med feilmelding) for adresser i kommune angitt ved KommuneId, f.eks. om adresse mangler representasjonspunkt. Kan velge om rapport av typen SOSI eller tekst. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • kommuneId - kommune som kontrollrapporten skal gjelde for.
  • rapportTypeId - hvilken type rapport som skal produseres støtte for 5, AdresseKontrollSOSI og 6,AdresseKontrollTekst, se AdresseRapportType.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (sosi (0) eller tekstformat (1), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres
    ServiceException

createByggKontrollRapport

Kontrollrapport (oversikt over feil med feilmelding) for bygg i kommune angitt ved KommuneId, f.eks. om byggets representasjonspunkt er utenfor en av matrikkelenhetene ... osv. Kan velge om rapport av typen SOSI eller tekst. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • kommuneId - kommune som kontrollrapport gjelder for.
  • rapportTypeId - hvilken type rapport som skal produseres. Støtte for 10, ByggKontrollSOSI og 11, ByggKontrollTekst, se BygningRapportType.
  • bestaendeUtgatte - angir om bestående, utgåtte eller alle bygg skal med. 1 om bestående bygg skal med, 2 om utgåtte, 3 for alle bygg (ikke 1,2,4 eller 5!).
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (sosi (0) eller tekstformat (1), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres
    ServiceException

createMatrikkelenhetKontrollRapport

Lager en kontrollrapport for matrikkelenheter i en valgt kommune angitt ved KommuneId. Rapporten er en oversikt over alle matrikkelenhetene som har en feil, f.eks. om areal uten flateinformasjon ved angitt grensepunkt osv. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • kommuneId - kommune som kontrollrapport gjelder for.
  • rapportTypeId - hvilken type rapport som skal produseres, støtte for 18, MatrikkelenhetKontrollSOSI og 19, MatrikkelenhetKontrollTekst.
  • bestaendeUtgatte - angir om bestående, utgåtte eller alle matrikkelenheter skal med. 1 for bestående, 2 for utgåtte, 0 for bestående og utgåtte.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (sosi (0) eller tekstformat (1), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres
    ServiceException

createTeigerUtenMatrikkelnummerRapport

SOSI-rapport for teiger uten matrikkelnr i en kommune angitt ved KommuneId. Kan få teiger hvor matrikkelnr mangler og/eller vannteiger (har registrert vannareal i en eiendom som en teig) der matrikkelnummer mangler. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • kommuneId - kommune som rapport skal lages for.
  • teigerUtenMatrikkelnummer - true hvis rapporten skal finne teiger uten matrikkelnr (Mnr mangler), denne og/eller vannteigerUtenMatrikkelnummer må være true.
  • vannteigerUtenMatrikkelnummer - true hvis rapporten skal finne vannteiger uten matrikkelnr (Mnr vann mangler), denne og/eller teigerUtenMatrikkelnummer må være true.
  • rapportTypeId - hvilken type rapport som skal produseres, 22 for malen TeigerUtenMatrikkelnummerSOSI40, se MatrikkelenhetRapportType.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (sosi (0), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres
    ServiceException

createBoligbyggingRapport

(Obs: Metoden kunne ikke testes (01.07.15) så dokumentasjonen kan gjerne endres.)

Lager rapport for statistikk over boligbygginger som tilfredsstiller kriteriene i BoligbyggingsokModel. I søkemodellen kan man sette i hvilket tidsintervall man vil se boligbygginger for og hvilke kommuner statistikken skal omfatte.

Generelle krav i søkemodell for boligbygging:

  • Må ha både datoFra og/eller datoTil oppgitt, og datoFra må være før datoTil.
  • Må oppgi minst én kommune.
Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • boligbyggingsokModel - Felt i søkemodellen: Datoer for tidsintervall (format: YYYY-MM-DD), fylkenummmer og kommunenummer, eventuelt flere kommunenumre.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (tekstformat (1), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createGeovekstRapport

(Obs: Metoden kunne ikke testes (01.07.15) så dokumentasjonen kan gjerne endres.)

Lager rapport for geovekst, dvs. en statistikk som viser antall matrikkelenheter, vegadresser, bygninger, nye matrikkelenheter osv., for valgte kommuner.

Generelle krav i søkemodell for geovekst:

  • Må ha både datoFra og/eller datoTil oppgitt, og datoFra må være før datoTil.
  • Må oppgi minst én kommune.
Kommuner angis ved et map fra fylkesnummer som nøkkel til kommunenummer. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • geovekstsokModel - Søkemodell med felt for å angi tidsintervallet (format: YYYY-MM-DD) og hvilke kommuner rapporten skal gjelde for.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (tekstformat (1), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createForingskontrollRapport

(Obs: Metoden kunne ikke testes (01.07.15) så dokumentasjonen kan gjerne endres.)

Lager rapport for en foringskontrollsokModel. Dette er en oversikt over antall førte brukstilfeller (endringer gjort i matrikkelen) for valgte kommuner i et angitt tidsintervall. Eksempel på felter i rapport: Antall nyopprettede forretninger (ting som har skjedd med en matrikkelenhet som å registrere aktuell eier), antall slettinger osv.

Generelle krav i søkemodell for føringskontroll av brukstilfeller:

  • Må ha både datoFra og/eller datoTil oppgitt, og datoFra må være før datoTil.
  • Må oppgi minst én kommune.
som nøkkel til kommunenummer. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • foringskontrollsokModel - Søkemodell for føringer av brukstilfeller. Har felt for å sette tidsintervallet (format: YYYY-MM-DD), og kommuner angis ved et map fra fylkenummer
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (tekstformat (1), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createByggRapport

Lager en bygningsrapport basert på kriteriene satt i søkemodellen ByggsokModel. Søkemodellen angir hvilke bygninger det genereres rapport for.
Kan velge om vil ha med diverse subrapporter som en del av rapporten, se parameter subrapporter.

Kan velge mellom ulike rapporttyper: SOSI-rapport, FKB-rapport eller pdf.

Generelle krav i søkemodell for bygg:

  • Person: Kan ikke søke på kun fornavn, krever òg etternavn.
  • Veg: Adressekode og nummer kan ikke være lavere enn null.
  • Matrikkelenhet: Gårds
  • , bruks
  • , feste
  • og seksjonsnummer kan ikke være lavere enn null.
  • Bygning: Bygningsnummer og løpenummer kan ikke være lavere enn null.
  • Polygon: Må være korrekt angitt.
  • Bruksenhetsnummer: Kan ikke angis uten vegadresse og må være gyldig.
  • Fonetikk: Kan ikke angi at adressenavn, adressetilleggsnavn eller navn er gitt fonetisk uten at tilhørende tekstfelt er fylt ut.
  • Kommunenr: Kommunenr og KommuneId har samme verdi, men må ikke blandes i den forstand at i kommunenr kan ikke en eventuell null som første siffer utelates.
Kan søke på matrikkelnummer (gårdsnummer osv.), person, vegadresse osv. Bygning og/eller Bygningsendring. Se Byggklasse. "hjemmelshavere", "kulturminner". Ingen subrapporter blir tatt med om parameteren er tom, og parameteren kan ikke ikke slettes. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • byggsokModel - utvalgsparametre som fastsetter hvilke bygg som det lages rapport over. Se regler for spesifisering av parametere over.
  • byggKlasser - må angis. Parameteren begrenser rapport på subklasser av Bygg (som er parameterverdiene):
  • subrapporter - bestemmer om forskjellige subrapporter skal være med. Mulige verdier: "etasjer", "bruksenheter", "tiltakshavere", "kontaktpersoner",
  • bygningRapportTypeId - kode hvilken type bygningsrapport som skal produseres. Støtte for 1:BygningSOSI4, 3: BygningFKBSOSI4, 8: Bygg (jasper), se BygningRapportType.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (sosi (0), pdf (2), eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres
    ServiceException

createBygningstypeJasperRapport

Lager rapport over antall aktive bygninger per bygningstype basert på et fylke og valgte kommuner i fylket. Får generert korrekt statistikk for kommunene også om man ikke angir korrekt FylkeId for de valgte kommunene. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • fylkeId - id for fylket.
  • kommuneIds - avgrenset liste av kommuner innen samme fylke. Rapport genereres for alle kommuner i valgt fylke om parameteren ikke er angitt (== null).
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (pdf (2) eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createMatrikkelenhetRapport

Lager en matrikkelenhetsrapport basert på spesifiserte utvalgsparametre i søkemodellen MatrikkelenhetsokModel og rapporttype (Massiv, enkel, kartEnkel osv.)

Generelle krav i søkemodell for matrikkelenhet:

  • Ikke tilstrekkelig med parametere når: KommuneId ikke er angitt eller mindre enn null OG personnr, fornavn og etternavn er ikke angitt OG bygningsnr ikke er angitt eller mindre enn null OG polygon ikke er valgt.
  • Må ha angitt søkekriterier, dvs. at en må søke på minst én av disse måtene:
    • Bygning angitt: Bygningsnummer eller løpenummer forskjellig fra null.
    • Adresse angitt: Adressekode, adressenavn, adressetilleggsnavn, nummer eller bokstav er forskjellig fra null.
    • Matrikkelnummer: Gårdsnr, bruksnr, festenr eller seksjonsnummer er forskjellig fra null.
    • Personer: Fornavn, etternavn eller personnummer er forskjellig fra null.
    • Bruksenhetsnummer: Forskjellig fra null.
    • Utvalgspolygon: Har valgt et polygon og dets KoordinatsystemKode er forskjellig fra null.
    • True boolean for MatrikkelenhetsokModel#jordskifteKrevd har jordskifte krevd, MatrikkelenhetsokModel#inngarISamlaFastEiendom inngår i samla fast eiendom, MatrikkelenhetsokModel#anmerketKlage har anmerket klage, MatrikkelenhetsokModel#grunnerverv har grunnerverv, MatrikkelenhetsokModel#harGrunnforurensing har grunnforurensing eller MatrikkelenhetsokModel#harKulturminne har kulturminne.
  • Person: Kan ikke søke på kun fornavn, krever etternavn også.
  • Polygon: Må være korrekt angitt.
  • Må velge at rapporten skal gjelde for bestående og/eller utgåtte bygg.
  • Matrikkelnummer: Ingen av tallene (gårds
  • , bruks
  • , seksjons
  • og festenummer) kan ikke være mindre enn null.
  • Bruksenhetsnummer: Krever at vegadresse óg er oppgitt og må være gyldig.
  • Fonetikk: Kan ikke angi at adressenavn, adressetilleggsnavn eller navn er gitt fonetisk uten at tilhørende tekstfelt er fylt ut.
  • Kommunenr: Kommunenr og KommuneId har samme verdi, men må ikke blandes i den forstand at i kommunenr kan ikke en eventuell null som første siffer utelates.
se søkekriteriene for søkemodellen over. matrikkelkart enkel-SOSI3.4 (4), matrikkelkart fullstendig-SOSI4.0 (5), matrikkelkart enkel-SOSI4.0 (6), alle teiger-SOSI4.0(7). Se MatrikkelenhetRapportType. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • matrikkelenhetsokModel - Søkemodellen inneholder utvalgsparametre som spesifiserer utvalget matrikkelenheter det genereres rapport for,
  • rapportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle: Massiv (0), enkel (1), hovedteiger-SOSI4.0 (2),
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (sosi (0), pdf (2), eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres
    ServiceException

createNaboliste

Lager en rapport over eierforhold for valgte naboer for angitt matrikkelenhet. Angir matrikkelenhet og naboer ved MatrikkelenhetId. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • kommuneId - id til aktuell kommune.
  • matrikkelenhetId - id til matrikkelenheten hvis naboer skal være gitt.
  • matrikkelenhetIds - liste av id'er for matrikkelenhetene som skal være med i rapporten som naboer.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (tekstformat (1), pdf (2), eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createSamletRapportRestanserOppmaling

Lager en rapport over nåværende restanser over oppmålingsforretninger for angitt kommune ved KommuneId. Rapporten er en oversikt over alle matrikkelenheter som har forretninger (alt som skjer med en matrikkelenhet, f.eks. en omnummerering osv.) kodet lik "ikke fullført" og "mangel ved matrikkelføringskravet" i kommunen. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • kommuneId - id til aktuell kommune.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (pdf (2) eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom ingen rapport kan genereres
    ServiceException

createIkkeFullfortOppmalingsforretningRapport

Lager en rapport over nåværende ikke fullførte oppmålingsforretninger for aktuell kommune, dvs. en oversikt over alle matrikkelenheter som er registert med Matrikkelenhet#oppmalingIkkeFullfort "ikke fullført oppmålingsforretning". Rapporten tilfredsstiller kriterier gitt i søkemodellen MatrikkelenhetForForretningsokModel.

Generelle krav i søkemodell for matrikkelenhetForForretning:

  • MatrikkelenhetForForretningsokModel#kommuneId Kommuneid må være gitt og større enn 0.
  • Sortering enten på matrikkelnummer eller dato (frist for fullføring); må angi minst én, og ikke begge to.
dato, dvs. frist for fullføring (format YYYY-MM-DD). Sortering på dato gir alle "ikke fullførte oppmålingsforretninger" med frist for fullføring lik eller eldre enn oppgitt dato. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • matrikkelenhetForForretningsokModel - Søkemodell med parametere som ordner innholdet i rapporten. Må sette kommuneId, om det skal sorteres på matrikkelnummer eller på
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (pdf (2), eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom ingen rapport kan genereres.
    ServiceException

createGrensepunktmerkingManglerRapport

Lager en rapport over nåværende matrikkelenheter som ikke har fullført grensepunktmerking for aktuell kommune, dvs. en oversikt over alle matrikkelenheter som er registert med "grensepunktmerking mangler". Rapporten tilfredsstiller kriterier gitt i søkemodellen MatrikkelenhetForForretningsokModel. "grensepunktmerkingMangler" er et boolean felt i klassen Matrikkelenhet.

Generelle krav i søkemodell for matrikkelenhetForForretning:

  • MatrikkelenhetForForretningsokModel#kommuneId Kommuneid må være gitt og større enn 0.
  • Sortering enten på matrikkelnummer eller dato (frist for grensepunktmerking); må angi minst én, og ikke begge to.
dato, dvs. frist for grensepunktmerking (format YYYY-MM-DD). Sortering på dato gir alle "grensepunktmerking mangler" med frist for merking lik eller eldre enn oppgitt dato. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • matrikkelenhetForForretningsokModel - Søkemodell med parametere som ordner innholdet i rapporten. Må sette kommuneId, om det skal sorteres på matrikkelnummer eller på
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (pdf (2), eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom ingen rapport kan genereres.
    ServiceException

createManglerVedMatrikkelforingskravRapport

Lager en rapport over: matrikkelføringskrav/rekvisisjon av oppmålingsforretninger med mangler for kommune angitt ved KommuneId. Rapporten gir en oversikt over alle matrikkelenheter som er registrert med "mangel ved matrikkelføringskrav". "mangelMatrikkelforingskrav" er et booleanfelt i klassen Matrikkelenhet.

Generelle krav i søkemodell for matrikkelenhetForForretning:

  • MatrikkelenhetForForretningsokModel#kommuneId Kommuneid må være gitt og større enn 0.
  • Sortering enten på matrikkelnummer eller dato (frist for retting); må angi minst én, og ikke begge to.
dato, dvs. frist for retting (format YYYY-MM-DD). Sortering på dato viser alle "matrikkelføringskrav med mangler" med frist for retting lik eller eldre enn oppgitt dato. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • matrikkelenhetForForretningsokModel - Søkemodell med parametere som ordner innholdet i rapporten. Må sette kommuneId, om det skal sorteres på matrikkelnummer eller på
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (sosi (0), tekstformat (1), pdf (2), eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom ingen rapport kan genereres.
    ServiceException

createMidlertidigForretningRapport

Lager rapport over midlertidige forretninger for kommune angitt ved KommuneId. Rapporten gir en oversikt over alle matrikkelenheter som er registrert med ikke fullførte midlertidige forretninger, dvs matrikkelenheter med arealkildekode (direkte kobling) "Midlertidig forretning", "Midlertidig forretning, eiendom utgått" eller "Midlertidig forretning fullføres av SK".

Generelle krav i søkemodell for matrikkelenhetForForretning:

  • MatrikkelenhetForForretningsokModel#kommuneId Kommuneid må være gitt og større enn 0.
  • Sortering enten på matrikkelnummer eller etablert dato; må angi minst én, og ikke begge to.
etablert dato. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • matrikkelenhetForForretningsokModel - Søkemodell med parametere som ordner innholdet i rapporten. Må sette kommuneId, om det skal sorteres på matrikkelnummer eller på
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (pdf (2), eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createSefrakstatusRapport

Lager rapport for sefrakobjekter og bygningsstatus, dvs. en oversikt over sefrakobjekter med status på forskjellige datoer. Innholdet i rapporten bestemmes av innholdet i søkemodellen SefrakstatussokModel, og rapporten kan omfatte flere kommuner.
Direkte kobling fra Bygg til BygningsstatusKode.
MAT-6804 Rapport BYG0009 - Ny rapport: Sefrakobjekter og bygningsstatus

Generelle krav i søkemodell for sefrakstatus:

  • Må angi en eller flere kommuner.
  • Om en av de spefikke statusene er true, må også "Rapporter kun objekt med endret status i angitt periode" være true.
  • Både fraDato og tilDato må være satt om noen av boolean
  • verdiene (kunObjMedEndretStatus, utgatt osv) er true.
som ikke skal med i rapporten (false om ikke vil ha status med). Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • sefrakstatussokModel - Parametere som er utvalgskriteriene for rapporten. Kan angi flere kommuner, tidsintervall og hvilke statuser det er endret til
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (tekstformat (1), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createVegendringsRapport

Lager en vegendringsrapport (nye, endrede, slettede) basert på kommune ved KommuneIdog aktuelt tidsrom for endringer. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • kommuneId - id til aktuell kommune.
  • fra - dato fra og med endringer har skjedd (format YYYY-MM-DD).
  • til - evt dato til og med endringer har skjedd (format YYYY-MM-DD).
  • endringskilder - filter for å en eller flere endringskilder for oppdateringer. 0 for Matrikkel, 3 for eksternregister, se EndringsKildeKode.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (pdf (2), eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres
    ServiceException

createVeghistorikkRapport

Lager en historikkrapport som viser alle endringer gjort gjennom tidene for veger i en kommune som tilfredsstiller søkekriteriene i søkemodellen VegHistorikksokModel.

Generelle krav i søkemodell for vegHistorikk:

  • Kommunenummer: Må angis, bare inneholde tall og ikke være mindre enn null.
  • Må ha tilstrekkelig med parametere: Kan ikke ha både kommunenr, adressenavn, adressekode, helKommune, bestående og utgåtte som tomme felter/false.
Kan også sette adressekode og adressenavn. KommunenummerUtvalg trenger ikke å være satt, og kan eventuelt bare inneholde tall dvs. kommunenummeret til den aktuelle kommunen. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • sokemodell - sokekriterier rapporten skal tilfredsstille. Inneholder kommunenummer, om rapporten skal gjelde helKommune, utgåtte og/eller bestående veger (boolean datafelt).
  • rapportTypeId - angir mal for rapporten, støtte for type 1, veghistorikk. Se VegRapportType.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (pdf (2), eller kasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres
    ServiceException

createVegListeRapportForKommuner

Genererer en zip-fil med en txt-fil som inneholder alle veger for hver angitte kommune. Settet beskriver altså kommuneutvalget i rapporten. En txt-fil per nøkkel som angis. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut som et objekt med url til en zip-fil ved hentRapport-funksjon med JobbId når rapporten er generert ferdig. Rapportene er i txt-format.

Input
  • kommuneUtvalg - Et map med streng som gir filnavnet på txt-fila som nøkkel. Mapper til KommuneId.
  • vegRapportTypeId - kode for hvilken type vegrapport som skal produseres, støtte for 0 , Veger - VBase. Se VegRapportType.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (tekstformat (1), se kodeliste ExportType).
  • adressenavn - true om lange adressenavn skal være med i rapporten
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres
    ServiceException

createSefrakRapport

Lager en sosirapport for sefrakobjekter (objekter i registeret over eldre bygninger og andre kulturminner) basert på spesifiserte utvalgsparametre i søkemodellen SefraksokModel.

Generelle krav i søkemodell for sefrak:

  • Om har valgt et polygon, må polygonet ha blitt angitt korrekt.
Parameteren aktivKommune må være satt, den skal være lik kommunenummeret vi ønsker å se sefrakobjekter for, og den kan gis alene. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • sefraksokModel - utvalgsparametre for hvilke data som skal inn i rapporten: Kommunenr, kretsnr, løpenr (hus), bygningsnummer, eller bygningsløpenummer.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (sosi (0), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres
    ServiceException

createAdressemerkebestillingsRapportForAdressemerkeBestillinger

Lager fem rapporter over adressemerkebestilllinger, basert på en liste over adressemerkebestillinger.

De fem rapportene er adressemerker for Oslo/Bærum, Vegadresser for kommuner med Bokmål språkform, Matrikkeladresser for kommuner med Bokmål språkform, Vegadresser for kommuner med Nynorsk språkform og Matrikkeladresser for kommuner med Nynorsk språkform.

Input
  • adressemerkebestillinger - bestillinger som skal presenteres i aktuelt format.
  • matrikkelContext - context for kallet.
Response
  • return - en liste med rapport objekter.
    AdressemerkeBestillingRapportDTO
  • ServiceException - dersom feil på adressemerkebestillingene eller bruksenhetene.
    ServiceException

findRapportJobberForPaloggetBruker

Finner rapporter for pålogget bruker som har blitt lagt i kø for offline prosessering. Hvis listen er tom blir alle statuser akseptert (dvs. ingen items).

Input
  • statusListe - Liste av jobbstatuser som jobben kan ha. 1 for "I kø", 3 for "Klar" osv., se JobbStatusKode.
  • matrikkelContext - context for kallet.
Response
  • return - Liste av alle JobbId for pålogget bruker som viser til rapporter brukeren har lagt i køen for offline prosessering.
    JobbIdList
  • ServiceException - ved applikasjonsfeil
    ServiceException

findRapportJobberForBruker

Finner rapporter som har blitt lagt i kø for offline prosessering av bruker angitt ved BrukerId Hvis listen er tom blir alle statuser akseptert (dvs. ingen items).

Input
  • brukerId - id på bruker som eier rapportene. Hvis ikke angitt (slettet) returneres jobber for alle brukere.
  • statusListe - Liste av jobbstatuser som jobben kan ha. 1 for "I kø", 3 for "Klar" osv., se JobbStatusKode.
  • matrikkelContext - context for kallet.
Response
  • return - Liste av alle JobbId for valgt bruker som viser til rapporter brukeren har lagt i køen for offline prosessering.
    JobbIdList
  • ServiceException - ved applikasjonsfeil
    ServiceException

hentRapport

Henter en rapportjobb som er blitt ferdiggenerert utifra en JobbId.

Dersom rapporten har status 'Feil', returneres en soap:Fault med en teknisk feilmelding om hva som gikk galt ved produksjon av rapporten. Returnerer også feilmelding om rapporten eventuelt ikke er ferdigstilt ennå.

og en rapporttypeid. RapportTypeId viser til interfacet (mal, innhold, evt. størrelse) for rapporten, se RapportType.

Input
  • jobbId - Id på jobb for en rapport som er bestilt og lagt i kø for offlineprosessering.
  • matrikkelContext - context for kallet.
Response
  • return - Returnerer et objekt av typen matrikkelrapport som inneholder en url man kan hente generert rapport fra, informasjon om størrelse
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

slettRapportJobber

Sletter rapport-jobb(er) som har blitt ferdig eller som ligger i kø. Rapporter som er i ferd med å bli prossesert vil få status "slettes" inntil jobben er ferdig prossesert.
Obs: Sletting av rapportjobb krever at bruker har låst rapporten.

Input
  • jobbIds - jobbIs for rapportjobber som skal slettes.
  • matrikkelContext - context for kallet.
Response
  • return - liste av Ids som er blitt slettet.
    List
  • ServiceException - ved applikasjonsfeil
    ServiceException

createGrenselinjerMedMPIDRapport

Genererer rapporter for grenselinjer med MPID for en eller flere kommuner. Returnerer en zip-mappe med rapportene som sosi-filer. Kommunen angis med KommuneId. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Hentes ut som en zip-mappe eller en ren sosi-fil om kun én rapport er blitt generert.

Input
  • utvalgForRapporter - Et map der nøkkelen er en streng som blir filnavnet på sosi-rapporten som genereres i zip-mappen for den kommunen nøkkelen mapper til.
  • kunAdministrativeGrenser - true hvis kun administrative grenser i kommunen ('kommunegrenser') skal være med, ellers tas alle grenselinjer med.
  • medIds - true hvis database ids skal være med i MPID'en, ellers brukes 0.
  • rapportTypeId - hvilken type rapport som skal produseres, 0 for "GrenselinjerMedMPIDSOSI34. Se kodeliste DriftRapportType.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (sosi (0), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres.
    ServiceException

createKommunegrenseRapport

Genererer en rapport med kommunegrenser for en eller flere kommuner. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • kommuneIds - kommuner som skal med i rapporten.
  • rapportTypeId - hvilken type rapport som skal produseres, 2 for "KommunegrenserSOSI45", se DriftRapportType.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (sosi (0), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres.
    ServiceException

createMassivuttrekkRapport

Genererer en massivrapport for en eller flere kommuner. Se kodeliste MassivRapportType.

Input
  • kommuneIds - Liste av kommuner som skal med i rapporten, angitt ved KommuneId.
  • rapportTypeId - hvilken type rapport som skal produseres, 1 for MassivuttrekkP13Adresse, 10 for MassivuttrekkDokAdresse (tekstdokumentasjon), 5 for MassivutrekkBygg osv.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (semikolonseparert (3), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - en zippet rapportfil som inneholder en til flere kommunefiler med adressedata.
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres.
    ServiceException

createMassivuttrekkFylkeRapport

Generere en massivrapport for et eller flere fylker.

Input
  • fylkeIds - Liste med FylkeId for fylker vi vil ha med i rapporten.
  • rapportTypeId - avart av rapport
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (semikolonseparert (3), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - en zippet rapportfil som inneholder en til flere fylkesfiler med adressedata.
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createMeldingTilTinglysing

Genererer rapporten MeldingTilTinglysing for en forretning (ting som skjer med en matrikkelenhet, f.eks. en omnummerering). Forretningen på ha tinglysingsstatus "skal tinglyses" eller "sendt til tinglysing", og den settes i hvert enkelt brukstilfelle. uten eiers godkjennelse. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • forretningId - id til forretningen (for en matrikkelenhet) som det skal genereres melding til tinglysing for.
  • rekvirentTinglysing - rekvirent av tinglysingen, som regel en juridisk person innen kommunen.
  • rekvirenterForretning - rekvirenter av forretningen, som regel hjemmelshaverne til matrikkelenheten det genereres melding for (slik at ikke en forretning blir tinglyst
  • harBebygdAral - om arealet som overføres av arealoverføringsforretningen omfatter bebygd areal. Benyttes bare hvis forretningen er en arealoverføringsforretning.
  • harVedlegg - om det følger vedlegg med meldingen.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (sosi (0), tekstformat (1), pdf (2), eller semikolonseparert (3), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createMatrikkelenhetMedUfullstendingGeometriRapport

Genererer rapporten MatrikkelenhetMedUfullstendingGeometriRapport for en kommune. Kan spesifisere hvilke geometrier som skal inkluderes i rapporten. Spesifiert i MAT-8263 Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • kommuneId - id for kommunen rapporten skal kjøres for.
  • utenTeigUtenBygg - om det skal letes opp matrikkelenheter uten teig og uten bygg.
  • utenTeigMedBygg - om det skal letes opp matrikkelenheter uten teig, men med bygg.
  • attekant - om det skal letes opp matrikkelenheter med åttekantede teiger med én fiktiv teiggrense som eneste grense.
  • medFiktivExterior - om det skal letes opp matrikkelenheter med teig med bare fiktive grenser i ytterkant.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (pdf (2), eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - ved applikasjonsfeil
    ServiceException

createKretserRapport

Genererer rapporten KretserTekst som gir en oversikt over kretser i et valgt område eller i gjeldende kommune. Kan spesifisere søket til å omfatte et bestemt område i søkemodellen KretssokModel.

Generelle krav i søkemodell for krets:

  • Om angitt kretstypeKodeIdent er tettsted, kreves det at et polygon (søkerektangel) er angitt.
  • Må angi i koden at "kretstypeKodeIdent" er av typen GenerellKretstypeKodeIdent.
  • Om det er valgt et polygon: Må være gyldig, dvs ha koordinatsystemkode og et polygon.
P for postnummerområde, G for grunnkrets, V for valgkrets, K for kirkesogn, T for tettsted. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • kretssokModel - utvalgsparametere for hvilke data som skal inn i rapporten. Angir kommune ved KommuneId og eventuelt hvilken krets.
  • adresseRapportTypeId - kode hvilken type adresserapport som skal produseres, 7 for "KretserTekst, se AdresseRapportType.
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (tekstformat (1), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres
    ServiceException

createNyeMatrikkelenheterOgHendelserRapport

(Obs: Metoden kunne ikke testes (01.07.15) så dokumentasjonen kan gjerne endres.)
Lager rapporten: MAT0022 Oversikt over nye matrikkelenheter og hendelser for tidsintervall og kommuner satt i søkemodellen ForingskontrollsokModel.

Generelle krav i søkemodell for føringskontroll av brukstilfeller:

  • Må ha både datoFra og/eller datoTil oppgitt, og datoFra må være før datoTil.
  • Må oppgi minst én kommune.
Bestemmer tidsintervall for rapporten med formatetet YYYY-MM-DD. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig.

Input
  • foringskontrollsokModel - søkemodell som bestemmer innholdet i rapporten. Bestemmer hvilke kommuner gjennom et map fra fylkenummer som nøkkel til kommunenummer.
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier
    ServiceException

createGrunnboksutskriftNy

Genererer en grunnboksutskrift (oversikt over tinglyste eierforhold, rettigheter osv på en matrikkelenhet). Spesifiserer innholdet i rapporten gjennom GrunnboksutskriftNyUtvalg; om skal ha med personnummer, med hjemmelsinformasjon osv. og om servitutter på avgivere skal med. Objektet inneholder en JobbId som refererer til rapporten i køen "Samlet rapport" der den er blitt lagt bakerst og venter på å bli generert av rapportserver. Kan hentes ut ved hentRapport-funksjon med JobbId når rapporten er generert ferdig. tidspunkt, benytt #createGrunnboksutskrifter(MatrikkelenhetIdent, MatrikkelenhetIdentList, boolean, boolean, boolean, MatrikkelContext)

Input
  • utvalg - spesifiserer hva som skal skrives ut. Fastsetter kommunenummer, matrikkelnummer, om hisotrisk data skal tas med, om fødselsnummer skal med
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle (pdf (2), eller jasper (4), se kodeliste ExportType).
  • offline - må settes true om kallet er eksternt. Bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - Ved offline true returneres et objekt av typen OfflineMatrikkelRapport som er en subklasse av MatrikkelRapport (har flere subklasser).
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres
    ServiceException

createGrunnboksutskrifter

Hent grunnboksinformasjon fra grunnboka via matrikkelen, for oppgitt matrikkelenhet og matrikkelenheter som har avgitt areal til denne. grunnboksutskrift for ubekreftede grunnboksutskrifter.

Input
  • matrikkelenhetIdent - ident til matrikkelenhet man ønsker grunnboksutskrift for.
  • utelat - sett over identer til tidligere arealavgivere man ikke ønsker
  • historisk - ta med historiske matrikkelenheter
  • fodselsnummer - ta med fødselsnummer i utskrifter
  • offline - generer rapport offline(på jobbserver)
  • matrikkelContext -
Response
  • return - ett rapportarkiv(ZIP-fil) med-, eller én enkelt PDF-fil(er) med
    MatrikkelRapport
  • ServiceException -
    ServiceException

createKonsesjonsforholdKvittering

Genererer en utskrift om konsesjonsforhold.

Input
  • kommuneId - til kommuner som skal få en rapport laget.
  • konsesjonsforholdUtskriftId - id for konsesjonsforhold utskrift det skal lages kvittering for.
  • offline - bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver.
  • matrikkelContext - context for kallet.
Response
  • return - et objekt som inneholder den genererte rapporten eller et offline objekt som gir deg jobbnr som rapporten er blitt tildelt.
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres
    ServiceException

createBygningMedBygningssendringRapport

Genererer rapport for bygning med bygningsendringer for rapporttypene BygningTotal og BygningMassiv.

Input
  • byggsokModel - utvalgsparametre for hvilke data som skal inn i rapporten
  • byggKlasser - sett av subklasser av Bygg som skal hentes ut. Dersom settet er tomt, avgrenses ikke søket på type bygg
  • subrapporter - Hvilke subrapporter som skal være med i rapporten
  • hjemmelshavere - bestemmer om subrapport for hjemmelshavere skal være med.
  • tiltakshavere - bestemmer om subrapport for tiltakshavere skal være med.
  • kontaktpersoner - bestemmer om subrapport for kontaktpersoner skal være med.
  • bruksenheter - bestemmer om subrapport for bruksenheter skal være med.
  • rapportTypeId - kode hvilken type bygningsrapport som skal produseres
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle
  • offline - bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver
  • matrikkelContext - context for kallet.
Response
  • return - et objekt som inneholder den genererte rapporten eller et offline objekt som gir deg jobbnr som rapporten er blitt tildelt
    MatrikkelRapport
  • ServiceException - dersom utvalgsparametrene inneholder ugyldige verdier, eller ingen rapport kan genereres
    ServiceException

createKommuneendringKommunegrenseRapport

Kontrollrapport for kommuneendring med sjekk av kommunegrenser for hele landet

Input
  • kommuneIds - kommune som kontrollrapport gjelder for
  • rapportTypeId - hvilken type rapport som skal produseres
  • exportTypeId - brukes til å eksplisitt sette utformat der flere format kan være aktuelle. Kan være sosi(0) eller tekst(1).
  • offline - bestemmer om rapporten skal legges i kø og genereres offline av rammeverk til rapportserver
  • matrikkelContext -
Response
  • return - rapport objekt som inneholder den genererte rapporten
    MatrikkelRapport
  • ServiceException -
    ServiceException