API for mangler, v2
- Veslemøy Søbak
- Helga Jerven
API for mangler er et API-kall som brukes til å informere søker om søknadens mangler, og saksbehandlers behov for at søknaden blir supplert. Disse dataene sendes strukturert i tillegg til det utgående dokumentet. API-et inneholder informasjon søker trenger for å kunne supplere søknaden slik at søknaden kan registreres som komplett. Med supplering av søknaden menes både mangler og annen dokumentasjon.
API for mangler utløses når sjekklisteutfallene krever behov for mer informasjon, og saksbehandler kvitterer ut milepælen “Mangelbrev” (MB).
Innhold
Milepæl
API for mangler skal dekke følgende milepæl:
Mangelbrev (MB)
Utfall
Følgende utfall er lovlige verdier å sende ved API for mangler:
Be om dokumentasjon (DOK)
Mangel (MG)
Mangel/tidsfrist starter ikke (MSI)
Oppfordre til innsending (OTI)
Nøkkeldata
Hovedformålet med API for mangler er å gi søker informasjon om følgende:
Liste over mangler og oppfølgingspunkt saksbehandler har bemerket
Svarfrist på manglene
Kobling mellom mangel, utfall og prosess
Lenke til det utgående dokumentet
Datamodell
Beskrivelse av felter
Under ligger en beskrivelse av feltene for API for mangler. 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 gule felt er spesielle for API for mangler.
Feltene for metadata, saksnummer, milepæl, saksbehandlingsfrist og utgående dokument er felles på tvers av alle API-ene. Les mer om det i Felles datafelt 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: FtBID i Sluttrapport for bygningsavfall |
|
AvsenderD | 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. |
|
EkspedertDato | Datoen for utsendingen. |
|
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 mangler vil dette alltid være “Mangelbrev” (MB). |
|
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. |
|
Svarfrist
Felt | Beskrivelse | Eksempel |
|---|---|---|
Svarfrist | Fristen søker har på å besvare utfallene. Dersom det er behov for å purre eller endre svarfrist etter utsending av mangelbrevet, må dette gjøres via meldingsfeltet i API for saksoppdatering. |
|
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 mangelen 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 mangelen. Denne informasjonen kan være endret av saksbehandler: | - |
| Mangelens tittel etter at saksbehandler evt. har justert den. Skal ta utgangspunkt i de standardiserte tekstene dersom de er tilgjengelige. |
|
| Mangelens 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 mangelen må være oppfylt for. Følger kodeliste for søknadstype. |
|