API for endret saksnummer
- Veslemøy Søbak
- Helga Jerven
API for endret saksnummer er et enkelt API-kall som brukes til å gi søker og søknadsløsningen informasjon om at saksnummeret i kommunen er endret. API-et krever ikke at det sendes med et utgående dokument. Dette API-et sørger for at kommunikasjonen i den videre søknadsprosessen importeres på riktig saksnummer, og håndterer scenarioer der kommunen må flytte saken til et annet saksnummer, dele opp saken i to eller flere, eller slå to eller flere saker sammen til én. Les mer om bruk av saksnummer og andre ID-er.
Dette API-et har ingen kobling til milepæl eller utfall.
Innhold
Nøkkeldata
Hovedformålet med API for endret saksnummer er å gi søker informasjon dersom:
saksnummeret endres
saksnummeret slås sammen med et annet
saksnummeret deles opp i to eller flere
Datamodell
TypeOppdateringer definerer de forskjellige operasjonene og har noen begrensinger som blir sjekket i validering av API kallet:
Flytting (FraSaksnummer og TilSaksnummer er begge enkle element)
Splitting (FraSaksnummer er et enkelt element og TilSaksnummer kan være en til flere)
Samling (FraSaksnummer er en liste og TilSaksnummer et enkelt element)
Beskrivelse av felter
Under ligger en beskrivelse av feltene for API for endret saksnummer. Vi har også lagt med en kolonne med eksempeldata, for slik å gi et inntrykk av hvordan vi ønsker at API-et skal brukes. Felt i blått er felles datafelt, mens røde felt er spesielle for API for vedtak.
Feltene for metadata, melding og saksnummer er felles på tvers av alle API-ene. Vi har likevel lagt de til her med relevante eksempeldata.
Metadata
Felt | Beskrivelse | Eksempel |
|---|---|---|
Metadata | Metadata for forsendelsen: |
|
FraEbyggesakssystem | Navn på eByggesakssystemet som kvitteringen er sendt fra. |
|
Innsendingsreferanse | Referansen for innsendingen. Dette vil typisk være altinnreferansen. |
|
FtBID | Prosjekt-ID fra FtPB. Les mer her: FtBID i Sluttrapport for bygningsavfall |
|
AvsenderID | ID til kommunen som har mottatt innsendingen. Skal samsvare med kommunennummer for kommune, og organisasjonsnummer for sektormyndigheter. |
|
AvsenderNavn | Navnet på kommunen/sektormyndigheten som har mottatt innsendingen. |
|
EkspedertDato | Datoen for utsendingen |
|
Melding
Felt | Beskrivelse | Eksempel |
|---|---|---|
Melding | Kort melding fra saksbehandler i de tilfeller milepælsoppdateringen ikke krever et utgående dokument. Kan være generert automatisk fra saksbehandlingssystemet, feks fra loggen. | Innsending med referanse
|
Type oppdatering
Felt | Beskrivelse | Eksempel |
|---|---|---|
TypeOppdatering | Hvilken endring som har skjedd. Vil følge kodeliste på GeoNorge. Kodelisten vil inneholde følgende:
| - |
Kodeverdi | - |
|
Kodebeskrivelse | - |
|
Opprinnelig saksnummer
Felt | Beskrivelse | Eksempel |
|---|---|---|
OpprinneligSaksnummer (1…*) | Det opprinnelige saksnummeret. Kan være en liste. | - |
Saksnummer | Det opprinnelige saksnummeret: | - |
Saksaar | Saksåret i saksnummeret som er tildelt. |
|
Sakssekvensnummer | Sekvensnummeret i saksnummeret som er tildelt. |
|
Dokumentnummer | Dokumentnummeret i saksforløpet på saken. |
|
Eiendom | Informasjon om eiendommen. | - |
| - |
|
| - |
|
| - |
|
Tiltakstype (0…*) | Tiltakstypen(e) som gjelder for de(t) nye saksnummeret/-numrene. Følger kodeliste på GeoNorge. | - |
Kodeverdi | - |
|
Kodebeskrivelse | - |
|
Til saksnummer
Felt | Beskrivelse | Eksempel |
|---|---|---|
TilSaksnummer (0…*) | Saksnummeret som nå gjelder. Kan være en liste. | - |
Saksnummer | Saksnummeret som nå gjelder: | - |
Saksaar | Saksåret i saksnummeret som er tildelt. |
|
Sakssekvensnummer | Sekvensnummeret i saksnummeret som er tildelt. |
|
Dokumentnummer | Dokumentnummeret i saksforløpet på saken. |
|
Eiendom | Informasjon om eiendommen | - |
|
|
|
|
|
|
|
|
|
Tiltakstype (0…*) | Tiltakstypen(e) som gjelder for de(t) nye saksnummeret/-numrene. Følger kodeliste på GeoNorge. | - |
Kodeverdi | - |
|
Kodebeskrivelse | - |
|