API for vedtak, v2
API for vedtak er et API-kall som brukes til å informere søker når vedtak er fattet, og hvilke vilkår som er satt. Disse dataene sendes strukturert i tillegg til det utgående dokumentet. API-et inneholder informasjon om vedtaket, og hvilke vilkår søker må oppfylle før neste fase.
API for vedtak utløses når vedtak er fattet og hvis sjekklisteutfallene krever vilkår eller oppfølgingspunkt i neste fase.
Innhold
Milepæl
Vedtak fattet (VT)
Vedtaksstatus
Vedtaket kan ha følgende vedtaksstatus:
Godkjent
Delvis godkjent
Avvist
Avslått
Utfall
Følgende utfall er lovlige verdier å sende ved API for vilkår:
Vilkår i vedtak
Oppfølgingspunkt i vedtak
Avslå søknad
Avvise søknad
Nøkkeldata
Hovedformålet med API for vilkår er å gi søker informasjon om følgende:
At vedtak er fattet, og hvilket resultat som er gitt
Hvilke vilkår søker må oppfylle før neste saksbehandlingsfase
Datamodell
Beskrivelse av felter
Under ligger en beskrivelse av feltene for API for vedtak. 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 lilla felt er spesielle for API for vedtak.
Feltene for metadata, saksnummer, milepæl, saksbehandlingsfrist og kommunens utgående dokument er felles på tvers av alle API-ene. Les mer om det i Felles datafel under API-er for oppdatert milepæl. 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: https://dibk.atlassian.net/wiki/spaces/FB/pages/2605613097 |
|
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. I API for vilkår vil dette alltid være “Vedtak fattet” (VT). |
|
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. |
|
Oversikt over godkjente dokumenter
Felt | Beskrivelse | Eksempel |
|---|---|---|
OversiktGodkjenteDokumenter (0..*) | En liste/tabell som gjør at søknadssystemet kan identifisere grunnlagsdokumentene for vedtaket. | - |
DokumentNavn | Navnet på tegningen/dokumentet som er godkjent. |
|
VersjonsDato | Versjonsdato for godkjent kart/tegning. |
|
Versjonsnummer | Versjonsnummer for godkjent kart/tegning. |
|
VedleggType | Indikasjon på om dokumentet er et kart, en tegning eller annen dokumentasjon. Følger kodeliste for VedleggsType. |
|
Vedtakets status
Felt | Beskrivelse | Eksempel |
|---|---|---|
VedtakStatus | Status på vedtaket som er fattet. Gyldige statuser bestemmes av kodeliste, og angis som en tallverdi:
|
|
Sjekklisteutfall
Felt | Beskrivelse | Eksempel |
|---|---|---|
SjekklisteUtfall (0…*) | Utfall, eller liste av utfall, som er oppdatert etter førstegangsinnsending. | - |
UtfallID | eByggesaksystemets ID for utfallet. |
|
UtfallType | Hvilket utfall et gitt sjekkpunkt har fått. Følger kodeliste på GeoNorge:
|
|
UtlostFraSjekkpunkt | Sjekkpunktet som har utløst utfallet: | - |
| Sjekklistepunktet vilkåret/oppfølgingspunktet er utløst fra. |
|
| Sjekkpunktets tittel. |
|
| Lenke til mer informasjon om sjekkpunktet. |
|
| Eier av sjekkpunktet mangelen er utløst fra. Det kan være DiBK, SSB eller den enkelte kommunes lokale mangler. |
|
BeskrivelseAvUtfall | Beskrivelse av vilkåret. Denne informasjonen kan være endret av saksbehandler: | - |
| Vilkårets tittel etter at saksbehandler evt. har justert den. Skal ta utgangspunkt i de standardiserte tekstene dersom de er tilgjengelige. |
|
| Vilkårets beskrivelse/undertekst etter at saksbehandler evt. har justert den. Skal ta utgangspunkt i de standardiserte tekstene dersom de er tilgjengelige. |
|
| Mer informasjon fra saksbehandler |
|
| Lovhjemmel, eller en liste av hjemler, som er knyttet til mangelen |
|
OppfyllesTilFase | Saksbehandlingsfasen/-prosessen vilkåret må være oppfylt for. Følger kodeliste for søknadstype. |
|