API for kvittering (v2)
- Helga Jerven
- Veslemøy Søbak
Utkast per 31. august 2022. Endringer vil komme etter innspill fra økosystemet.
Den nye versjonen av API for kvittering er et enkelt API-kall som brukes til å gi automatisk kvittering om at en sending er mottatt i kommunen. API-et inneholder informasjon søker trenger for å vite at innsendingen er mottatt i kommunen og registrert, som mottaksdato, hvilke filer som er mottatt, saksnummer i kommunen, og saksbehandler dersom det er tildelt.
API for kvittering er kun tenkt som en bekreftelse på mottatt søknad, og skal ikke oppdateres underveis i saksbehandlingsprosessen. Hvis saken får tildelt en saksbehandler på et senere tidspunkt, blir den informasjonen levert via API for oppdatering. Det samme gjelder om saksnummeret endres, for eksempel fra en fordelingssak til å bli en egen sak.
Innhold:
Oversikt
Beskrivelse av felter
Metadata
Felt | Beskrivelse | Eksempel |
|---|---|---|
Metadata | Metadata for forsendelsen: |
|
| Navn på eByggesakssystemet som kvitteringen er sendt fra. |
|
| Referansen for innsendingen. Dette vil typisk være Altinnreferansen. |
|
| Prosjekt-ID fra FtPB. Les mer her: FtBID i Sluttrapport for bygningsavfall |
|
| ID til virksomheten som har mottatt søknaden. Kommunennummer, eventuelt organisasjonsnummer dersom kvitteringen sendes fra en sektormyndighet. |
|
Kvittering
Felt | Beskrivelse | Eksempel |
|---|---|---|
Kvittering |
|
|
MottakerNavn | Navn på kommunen/sektormyndigheten som har mottatt innsendingen. |
|
MottattDato | Datoen sendingen er mottatt. |
|
MottattFil (0…*) | Liste over søknad, underskjema og vedlegg som er mottatt i kommunen: | - |
| Dokumenttype på mottatt dokument/skjema. Følger kodeverdier for Kodeliste: Dokumenttype. |
|
| Navn på mottatt dokument/skjema. |
|
Saksnummer
Felt | Beskrivelse | Eksempel |
|---|---|---|
Saksnummer | Saksnummer i kommunen: | - |
| Saksåret i saksnummeret som er tildelt |
|
| Sekvensnummeret i saksnummeret som er tildelt |
|
| Journalåret som er tildelt forsendelsen |
|
| Journalsekvensen som er tildelt forsendelsen |
|
Saksbehandler
Felt | Beskrivelse | Eksempel |
|---|---|---|
Saksbehandler | Navn og kontaktinformasjon til saksbehandler i kommunen: | - |
|
|
|
|
| - |
|
| - |
|
| - |
Felter som er vurdert, men ikke tatt med
Saksbehandlers avdeling
SvarUtReferanse
Matrikkelopplysninger
Søkers kontaktperson og prosjektnavn
Kvitteringsmelding i fritekst fra kommunen
Kodelister
DokumentType
DokumentType vil typisk følge kodeverdier for vedlegg og underskjema: https://register.geonorge.no/kodelister/byggesoknad/vedlegg-og-underskjema I tillegg vil selve søknaden være en gyldig dokumenttype.
Spørsmål til diskusjon
Spørsmål 1: Hvordan bør kvitterings-APIet brukes på et overordnet plan?
Skal kvittering bare returneres ved hovedsøknader, eller også andre innsendinger?
Hvis kvittering skal returneres ved andre innsendinger: hvordan skal automatisk tildeling av saksnummer håndteres?
Spørsmål 2: Treffer feltene behovet til saksbehandler og søker?
Er det noen opplysninger som mangler?
Er det ønskelig med et eller to telefonnummer til saksbehandler?
Hva brukes journalår til, og er det nødvendig?
Skal MottattFil inneholde en liste med DokumentTittel, DokumentType og eventuelt andre opplysninger, eller kun en liste med navn?
Spørsmål 3: Hva slags validering er ønskelig?
Hvilke felter skal være påkrevde og ikke?
Andre begrensninger i innholdet i feltene?