API for dokumentformidler
- Veslemøy Søbak
- Helga Jerven
I forbindelse med bruken av API-ene for saksbehandlingsdata, vil det ofte være behov for kommunen å sende ut et eller flere dokumenter. Vi ønsker å tilgjengeliggjøre dette dokumentet for nedlasting til søknadssystemene. Dette er for at søker skal få en raskere og mer brukervennlig tilgang til dokumentene i byggesaken.
eByggesakssystemet kan bruke API-et for dokumentformidler til å laste opp dokumentet i FtBs mellomlager. API-et returnerer en dokument-URL som kan sendes med følgende API-er:
API for mangel
API for vedtak
API for oppdatert milepæl
API for saksoppdatering
Se teknisk dokumentasjon og eksempel på kall: API for dokumentformidler: API-kall
Last opp dokument
API-et er en Multipart/form-data request. For å laste opp dokument kreves informasjon om metadata og saksnummer, i tillegg til selve filen.
eByggesakssystemet får returnert en ‘dokumentID’ og en ‘dokumentURL’. DokumentURL-en legges deretter inn i ‘UtgaaendeDokument’ i API-et hvor dokumentet skal formidles, f.eks. API for mangel eller vedtak.
Størrelse
128 MB er maksgrense for hele payloaden i første omgang.
Automatisk sletting
Fellestjenester BYGG tilbyr kun mellomlagring av dokumenter, og skal ikke fungere som et arkiv. Dokumenter lastet opp til dokumentformidleren har derfor en midlertidig levetid.
Dokumentene slettes automatisk etter 30 dager. Gjøres det en GET-forespørsel på det slettede dokumentet vil APIet respondere med 410 Gone.
Gradert informasjon
Ved deling av dokumenter må eByggesaksystemet ta stilling til om brevet kan deles, eller om det skal graderes og må følge sikrere distribusjonskanaler. FtPBs dokumentformidler skal ikke brukes dersom dokumentet inneholder sensitive personopplysninger eller skjermet/gradert informasjon.
Distribusjonsmetode
Dokumentene kan formidles gjennom nåværende systemer og felleskomponenter som SvarUt, e-post og andre kanaler, i tillegg til via Fellestjenester BYGG. Datamodellen for utgående dokument har et eget felt for distribusjon, der distribusjonsmetode følger kodeliste på GeoNorge og gjenspeiler dette.
Hent dokument
Dokumentet hentes av søknadssystemene via dokumentURL-en som sendes som en del av ‘UtgaaendeDokument’ i API-et hvor dokumentet skal formidles.