API for mangler, v2
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: |
|
FraEbyggesaksystem | Navn på eByggesakssystemet som kvitteringen er sendt fra. |
|
InnsendingReferanse | Referansen for innsendingen. Dette vil typisk være altinnreferansen. |
|
FtBID | Prosjekt-ID fra FtPB. Les mer her: |