Meldingstyper
Protokollen har flere meldingstyper, gjerne omtalt som tjenester, noen med tilhørende skjema som følger med i denne protokollen og andre uten skjema da de ikke har payload.
Meldingstypene i protokollen og hvordan de henger sammen er definert i json-filen meldingstyper.json
Fiks Plan V2 er i piloteringsfase. Det vil si at vi har releaset tjenestene/meldingstypene som kandidater til ferdig versjon. I piloteringsfasen vil det kunne komme oppdateringer på tjenestene.
Vi ser også at grunnet eksterne faktorer kan det være at enkelte tjenester vil forbli i pilotstatus fordi man ser at endringer kan komme, selv etter vi er ferdig med pilotfase. Dette er f.eks. eksterne prosjekter som påvirker objekter og krav relevant for Fiks Plan og som ikke blir ferdige innenfor Fiks Plan V2 prosjektets tidsramme.
Fiks Plan V2 vil når den blir ferdig releaset ha tydelig beskrevet hvilke tjenester som fremdeles må anses som pilot-tjenester. Se status kolonnen.
Under arbeid. Prioritering og Ferdig/Pilot vil endre seg. Tjenester kan også flyttes til neste versjon
Prioritering er en vekting på prioritert implementering/testing fra 1-3 hvor 1 er må, 2 er bør og 3 er uavklart.
Tanken er at de som har 1 og 2 som prioritet er de som skal implementeres i tidlig pilot-fase nå fra "begge sider".
Tjenester med prioritet 3 kan oppjusteres senere etter pilotering etter hvert som vi gjør oss erfaringer om behov. Noen tjenester er satt til prioritet 3 nå gitt at vi ønsker å gjøre oss erfaringer med andre tjenester først.
Ferdig/Pilot viser til om meldingstypen kan ansees som ferdig i Fiks Plan V2 eller om den fremdeles ansees som i pilot og kan endres innenfor denne versjonen.
Prioritering er gjort ut i fra det som trengs som minimum for byggesak, innbyggertjenester og plansak.
Følg lenkene under Tjeneste kolonnen for å gå direkte til den tjenesten, eller se alle på siden for Tjenester.
| Tjeneste | Prioritering | Ferdig/Pilot | Sees i sammenheng med |
|---|---|---|---|
| Hent Aktører | 3 | Pilot | |
| Hent Arealplan | 1 | Pilot | Byggesak, innbyggertjeneste |
| Finn Arealplaner | 1 | Pilot | Innbyggertjeneste |
| Finn Arealplaner (adresse) | 1 | Pilot | Innbyggertjeneste |
| Finn Arealplaner (matrikkelenhet) | 1 | Pilot | Byggesak |
| Finn Arealplaner (flate) | 1 | Pilot | Plansak |
| Finn Dispensasjoner | 1 | Pilot | Byggesak, innbyggertjeneste |
| Hent Dokumentfil | 1 | Pilot | Byggesak, innbyggertjeneste |
| Hent Gjeldende Plandokumenter | 1 | Pilot | Byggesak, innbyggertjeneste |
| Hent Kodeliste | 3 | Pilot | |
| Finn Midlertidigforbudmottiltak | 1 | Pilot | Byggesak, innbyggertjeneste |
| Finn Planbehandlinger | 3 | Pilot | |
| Hent Planomraader | 3 | Pilot | |
| Hent Relaterteplaner | 1 | Pilot | Byggesak, plansak |
| Oppdater Arealplan | 2 | Pilot | Plansak |
| Opprett Arealplan | 1 | Pilot | Plansak |
| Oppdater Dispensasjon | 2 | Pilot | Byggesak |
| Registrer Dispensasjon | 1 | Pilot | Byggesak |
| Registrer Midlertidigforbudmottiltak | 3 | Pilot | |
| Registrer Planavgrensning | Notat (*1) | Pilot | Se Notat |
| Registrer Planbehandling | 3 | Pilot | |
| Registrer Planomraade | 1 | Pilot | Plansak |
| Registrer Gjeldendeplandokumenter | 2 (*2) | Pilot | Plansak |
Vi sjekker om tjenesten/skjema er korrekt utformet. Hva er formål? Det er litt forvirrende bruk av terminologi. Er denne nødvendig hvis man kan bruke Registrer Planomraade? Vi må gjøre oss erfaringer under pilotering. Se issue 104 for videre oppfølging.
Skal gjeldende plandokumenter ta inn dokumenter slik den er nå? Eller skal den bare brukes for å "tagge" dokumenter som er gjeldende, altså alle registrerte dokumenter i planregister. Hvis det er tilfelle så skal meldingen ikke ta inn dokument objekter, men id-er til dokumentene som skal settes til gjeldende. Dette må vi finne ut av i pilotering. Derfor er prioritet ikke 1 på denne tjenesten.
Ved feil i innhold i innsendt melding eller feil i bruk av tjeneste så skal en ugyldig forespørsel (no.ks.fiks.plan.v2.feilmelding.ugyldigforespoersel) melding sendes tilbake til klient som inneholder en feilmelding som tydelig forklarer hva som er feil.
Feil i innhold kan være manglende påkrevde felter, logisk feil, ikke korrekt id osv. Feil i bruk av tjeneste kan være at man prøver å "registrere gjeldende plandokumenter" i en sak som ikke er klar for dette.
Leverandørenes status for implementering av tjenestene samt egenerklæring kan man se her:
Disse skjemaene inneholder felles datatyper brukt i flere skjema for meldingstyper. De er da refert til i skjema.
Skjema: no.ks.fiks.plan.v2.felles.arealplan.schema.json
Skjema: no.ks.fiks.plan.v2.felles.dispensasjon.schema.json
Skjema: no.ks.fiks.plan.v2.felles.dokument.schema.json
Skjema: no.ks.fiks.plan.v2.felles.flate.schema.json
Skjema: no.ks.fiks.plan.v2.felles.midlertidigforbud.schema.json
Skjema: no.ks.fiks.plan.v2.felles.nasjonalarealplanid.schema.json
Skjema: no.ks.fiks.plan.v2.felles.planbehandling.schema.json
Skjema: no.ks.fiks.plan.v2.felles.posisjon.schema.json
Skjema: no.ks.fiks.plan.v2.felles.saksnummer.schema.json
| Tjeneste | Meldingsnavn | Lenke til skjema |
|---|---|---|
| Hent Aktører | no.ks.fiks.plan.v2.innsyn.aktoerer.hent |
json |
| Hent Aktører | no.ks.fiks.plan.v2.innsyn.aktoerer.hent.resultat |
json |
| Hent Arealplan | no.ks.fiks.plan.v2.innsyn.arealplan.hent |
json |
| Hent Arealplan | no.ks.fiks.plan.v2.innsyn.arealplan.hent.resultat |
json |
| Finn Arealplaner | no.ks.fiks.plan.v2.innsyn.arealplaner.finn |
json |
| Finn Arealplaner (adresse) | no.ks.fiks.plan.v2.innsyn.arealplaner.finn.for.adresse |
json |
| Finn Arealplaner (matrikkelenhet) | no.ks.fiks.plan.v2.innsyn.arealplaner.finn.for.matrikkelenhet |
json |
| Finn Arealplaner (flate) | no.ks.fiks.plan.v2.innsyn.arealplaner.finn.for.flate |
json |
| Finn Arealplaner | no.ks.fiks.plan.v2.innsyn.arealplaner.finn.resultat |
json |
| Finn Dispensasjoner | no.ks.fiks.plan.v2.innsyn.dispensasjoner.finn |
json |
| Finn Dispensasjoner | no.ks.fiks.plan.v2.innsyn.dispensasjoner.finn.resultat |
json |
| Hent Dokumentfil | no.ks.fiks.plan.v2.innsyn.dokumentfil.hent |
json |
| Hent Dokumentfil | no.ks.fiks.plan.v2.innsyn.dokumentfil.hent.resultat |
- |
| Hent Gjeldende Plandokumenter | no.ks.fiks.plan.v2.innsyn.gjeldendeplandokumenter.hent |
json |
| Hent Gjeldende Plandokumenter | no.ks.fiks.plan.v2.innsyn.gjeldendeplandokumenter.hent.resultat |
json |
| Hent Kodeliste | no.ks.fiks.plan.v2.innsyn.kodeliste.hent |
json |
| Hent Kodeliste | no.ks.fiks.plan.v2.innsyn.kodeliste.hent.resultat |
json |
| Finn Midlertidigforbudmottiltak | no.ks.fiks.plan.v2.innsyn.midlertidigforbudmottiltak.finn |
json |
| Finn Midlertidigforbudmottiltak | no.ks.fiks.plan.v2.innsyn.midlertidigforbudmottiltak.finn.resultat |
json |
| Finn Planbehandlinger | no.ks.fiks.plan.v2.innsyn.planbehandlinger.finn |
json |
| Finn Planbehandlinger | no.ks.fiks.plan.v2.innsyn.planbehandlinger.finn.resultat |
json |
| Hent Planomraader | no.ks.fiks.plan.v2.innsyn.planomraader.hent |
json |
| Hent Planomraader | no.ks.fiks.plan.v2.innsyn.planomraader.hent.resultat |
json |
| Hent Relaterteplaner | no.ks.fiks.plan.v2.innsyn.relaterteplaner.hent |
json |
| Hent Relaterteplaner | no.ks.fiks.plan.v2.innsyn.realterteplaner.hent.resultat |
json |
| Tjeneste | Meldingsnavn | Lenke til skjema |
|---|---|---|
| Oppdater Arealplan | no.ks.fiks.plan.v2.oppdatering.arealplan.oppdater |
json |
| Oppdater Arealplan | no.ks.fiks.plan.v2.oppdatering.arealplan.oppdater.mottatt |
tom melding |
| Oppdater Arealplan | no.ks.fiks.plan.v2.oppdatering.arealplan.oppdater.kvittering |
tom melding |
| Opprett Arealplan | no.ks.fiks.plan.v2.oppdatering.arealplan.opprett |
json |
| Opprett Arealplan | no.ks.fiks.plan.v2.oppdatering.arealplan.opprett.mottatt |
tom melding |
| Opprett Arealplan | no.ks.fiks.plan.v2.oppdatering.arealplan.opprett.kvittering |
json |
| Oppdater Dispensasjon | no.ks.fiks.plan.v2.oppdatering.dispensasjon.oppdater |
json |
| Oppdater Dispensasjon | no.ks.fiks.plan.v2.oppdatering.dispensasjon.oppdater.mottatt |
tom melding |
| Oppdater Dispensasjon | no.ks.fiks.plan.v2.oppdatering.dispensasjon.oppdater.kvittering |
tom melding |
| Registrer Dipsensasjon | no.ks.fiks.plan.v2.oppdatering.dispensasjon.registrer |
json |
| Registrer Dispensasjon | no.ks.fiks.plan.v2.oppdatering.dispensasjon.registrer.mottatt |
tom melding |
| Registrer Dispensasjon | no.ks.fiks.plan.v2.oppdatering.dispensasjon.registrer.kvittering |
json |
| Registrer midlergidigforbudmottiltak | no.ks.fiks.plan.v2.oppdatering.midlertidigforbudmottiltak.registrer |
json |
| Registrer midlergidigforbudmottiltak | no.ks.fiks.plan.v2.oppdatering.midlertidigforbudmottiltak.registrer.mottatt |
tom melding |
| Registrer midlergidigforbudmottiltak | no.ks.fiks.plan.v2.oppdatering.midlertidigforbudmottiltak.registrer.kvittering |
tom melding |
| Registrer Planavgrensning | no.ks.fiks.plan.v2.oppdatering.planavgrensning.registrer |
json |
| Registrer Planavgrensning | no.ks.fiks.plan.v2.oppdatering.planavgrensning.registrer.mottatt |
tom melding |
| Registrer Planavgrensning | no.ks.fiks.plan.v2.oppdatering.planavgrensning.registrer.kvittering |
tom melding |
| Registrer Planbehandling | no.ks.fiks.plan.v2.oppdatering.planbehandling.registrer |
json |
| Registrer Planbehandling | no.ks.fiks.plan.v2.oppdatering.planbehandling.registrer.mottatt |
tom melding |
| Registrer Planbehandling | no.ks.fiks.plan.v2.oppdatering.planbehandling.registrer.kvittering |
tom melding |
| Registrer Planomraade | no.ks.fiks.plan.v2.oppdatering.planomraade.registrer |
json |
| Registrer Planomraade | no.ks.fiks.plan.v2.oppdatering.planomraade.registrer.mottatt |
tom melding |
| Registrer Planomraade | no.ks.fiks.plan.v2.oppdatering.planomraade.registrer.kvittering |
tom melding |
| Registrer gjeldendeplandokumenter | no.ks.fiks.plan.v2.oppdatering.gjeldendeplandokumenter.registrer |
json |
| Registrer gjeldendeplandokumenter | no.ks.fiks.plan.v2.oppdatering.gjeldendeplandokumenter.registrer.mottatt |
tom melding |
| Registrer gjeldendeplandokumenter | no.ks.fiks.plan.v2.oppdatering.gjeldendeplandokumenter.registrer.kvittering |
tom melding |
| Meldingsnavn | Skjema |
|---|---|
no.ks.fiks.plan.v2.feilmelding.ugyldigforespoersel |
json |
no.ks.fiks.plan.v2.feilmelding.serverfeil |
json |
no.ks.fiks.plan.v2.feilmelding.ugyldigforespoersel |
json |
| Meldingsnavn | Skjema | Årsak |
|---|---|---|
... |
json |
_
Dette kartet er generert ut i fra meldingstyper.json vha PlantUML
id: Navn på meldingstypen.
harPayload: Skal melding inneholde payload.
payloadFilnavn: Navnet payload-filen skal ha. Payload er meldingen som skal være i henhold til skjemaet som tilhører denne meldingstypen.
kanSvareMed: Meldingstyper denne meldingen kan svare med. Typisk en respons, kvittering, mottatt eller eventuelle feilmeldinger.
erSvarPaa: Hvilken melding(er) er denne meldingen et svar på.
