API for kvittering er et enkelt API-kall som brukes til å gi kvittering om at en sending er mottatt og tildelt saksnummer i kommunen. API-et inneholder informasjon søker trenger for å vite at innsendingen er registrert.
API for kvittering responderer på hver innsending (feks. rammesøknad, søknad om igangsettingstillatelse og supplering av søknad), og ikke kun hovedsøknaden. Kvitteringen sendes når innsendingen blir journalført i saksbehandlingssystemet. Det kan ta noe tid fra innsendingen er sendt, til den er innregistrert og kvittering blir sendt. Dette fordi saksbehandlingssystemene og kommunene har ulike rutiner for kvalitetssikring før/etter import.
API for kvittering skal kun være en bekreftelse på mottatt innsending, og skal ikke oppdateres underveis i saksbehandlingsprosessen. Oppdateringer i saken dekkes via andre API-er når milepælen endres eller ved andre viktige oppdateringer.
Innhold
Milepæl
API for kvittering skal dekke følgende milepæl:
Søknad mottatt (MS)
Tilleggsdokumentasjon mottatt (MT)
I tillegg ser vi for oss at API for kvittering kan bli brukt i fremtiden ved følgende milepæl:
Forespørsel om forhåndskonferanse mottatt (FM)
Nøkkeldata
Hovedformålet med API for kvittering er å gi søker informasjon om følgende:
mottaksdato
hvilke filer som er mottatt
saksnummer
kontaktpunkt dersom det er tildelt
Datamodell
Beskrivelse av felter
Under ligger en beskrivelse av feltene for API for kvittering. 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 lysgrønne felt er spesielle for API for kvittering.
Feltene for metadata, saksnummer, milepæl og saksbehandlingsfrist 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. |
|
InnsendingReferanse | 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. |
|
EkspedertDato | Dato for utsendingen. |
|
Saksnummer
Felt | Beskrivelse | Eksempel |
|---|---|---|
Saksnummer | Saksnummer i kommunen/sektormyndigheten: | - |
Saksaar | Saksåret i saksnummeret som er tildelt. |
|
Sakssekvensnummer | Sekvensnummeret i saksnummeret som er tildelt. |
|
Journalpostnummer | Journalpostnummeret i saksforløpet på saken . |
|
Avsenders kontaktpunkt
Felt | Beskrivelse | Eksempel |
|---|---|---|
AvsenderKontaktpunkt | Navn og kontaktinformasjon til saksbehandler eller avdeling som er ansvarlig for å behandle søknaden. | - |
Navn | - |
|
E-post | - |
|
Telefon | - |
|
Mobil | - |
|
Saksbehandlingsfrist
Felt | Beskrivelse | Eksempel |
|---|---|---|
Saksbehandlingsfrist | Fristen kommunen har til å ferdigstille saksbehandlingen. Denne datoen kan endres og oppdateres underveis i prosessen. |
|
Milepæl
Felt | Beskrivelse | Eksempel |
|---|---|---|
Milepæl | Milepælen kallet gjelder for. I API for kvittering vil være “Søknad mottatt” (MS) eller “Tilleggsdokumentasjon mottatt” (MT). | - |
Kodeverdi | - |
|
Kodebeskrivelse | - |
|
Mottatt dato
Felt | Beskrivelse | Eksempel |
|---|---|---|
MottattDato | Datoen sendingen er mottatt. Dette er samme dato som innsendingen er mottatt av kommunen/sektormyndigheten i SvarUt. |
|
Registrert dato
Felt | Beskrivelse | Eksempel |
|---|---|---|
RegistrertDato | Dato innsendingen er journalført i saksbehandlingssystemet. |
|
MottattFil
Felt | Beskrivelse | Eksempel |
|---|---|---|
MottattFil (0…*) | Liste over søknad, underskjema og vedlegg som er mottatt i kommunen: | - |
DokumentType | Dokumenttype på mottatt dokument/skjema. Følger dokumentkategori i NOARK. Viser til to eksempler, søknaden og fasadetegning. |
|
FilNavn | Navn på mottatt dokument/skjema. |
|
MimeType | Filformat. |
|
Filstorrelse | Filens størrelse. |
|
EkstraMetadata | Felt for ekstra metadata, feks filens opprinnelige navn. |
|
OffentligJournalUrl | Lenke til kommunenes offentlige journal for byggesaken. |
|
Legg til kommentar