API for oppdatert milepæl, nytt
- Veslemøy Søbak
- Helga Jerven
API for oppdatert milepæl er et API-kall som brukes til å informere søker når saksbehandlingen har ført til en endring av milepælene. Disse dataene sendes strukturert i tillegg til et eventuelt utgående dokumentet. API-et inneholder informasjon om saksbehandlingsprosessen.
API for oppdatert milepæl utløses når saksbehandler endrer en milepæl, for eksempel når søknaden er komplett eller når søknaden må sendes til vurdering av en annen myndighet.
Innhold
Milepæl
API for oppdatert milepæl må dekke milepælene:
Søknad komplett (KS)
Sendt til uttalelse annen myndighet (SUA)
Mottatt uttalelse fra annen myndighet (MUA)
API for oppdatert milepæl kan også dekke milepælene:
Søknad uaktuell (US)
Avsluttet (PA)
Nøkkeldata
Hovedformålet med API for oppdatert milepæl er å gi søker informasjon om følgende:
At saksbehandlingen har ført til en oppdatering av milepælene
Datamodell
Beskrivelse av felter
Under ligger en beskrivelse av feltene for API oppdatert milepæl. Vi har også lagt med en kolonne med eksempeldata, for slik å gi et inntrykk av hvordan vi ønsker at API-et skal brukes.
I dette eksemplet viser vi hvordan API-et kan brukes ved milepælene søknad komplett og oversendelse til annen myndighet. Alle feltene er fra felles datafelt.
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 virksomheten som har mottatt innsendingen. Skal samsvare med kommunennummer for kommune, og organisasjonsnummer for sektormyndigheter. |
|
AvsenderNavn | Navnet på kommunen/sektormyndigheten som har mottatt innsendingen. |
|
OffentligJournalUrl | Lenke til kommunenes offentlige journal for byggesaken. |
|
Saksnummer
Felt | Beskrivelse | Eksempel |
|---|---|---|
Saksnummer | Saksnummer i kommunen: | - |
Saksaar | Saksåret i saksnummeret som er tildelt. |
|
Sakssekvensnummer | Sekvensnummeret i saksnummeret som er tildelt. |
|
Journalpostnummer | Journalpostnummeret i saksforløpet på saken . |
|
Milepæl
Felt | Beskrivelse | Eksempel |
|---|---|---|
Milepæl | Milepælen kallet gjelder for. |
|
Saksbehandlingsfrist
Felt | Beskrivelse | Eksempel |
|---|---|---|
Saksbehandlingsfrist | Fristen kommunen har til å ferdigstille saksbehandlingen. Denne datoen kan endres og oppdateres underveis i prosessen. |
|
Utgående dokument
Felt | Beskrivelse | Eksempel |
|---|---|---|
UtgaaendeDokument | Liste med informasjon om dokument eller dokumentene som sendes fra kommunen. | - |
Distribusjon (1..*) | Liste med informasjon om hvordan dokumentet er distribuert: |
|
| Angir hvordan dokumentet er sendt/distribuert. Følger kodeliste på GeoNorge. |
|
| Lenke for nedlasting av dokumentet dersom FtPBs dokumentformidler brukes. Les mer om FtPBs dokumentformidler. |
|
DokumentNavn | Navn på utgående dokument. |
|
MimeType | Filtype for utgående dokument. |
|
DokumentStorrelse | Dokumentets størrelse. |
|
Hoveddokument | Boolsk verdi for å angi om dokumentet er et hoveddokument eller vedlegg. |
|
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. |
|