Validering av API-ene
Under følger en oversikt over valideringen av datafelt som går igjen på tvers av API-ene. Spesifikke valideringsregler er dokumentert på egne sider for hvert API.
Feltene er merket med følgende fargekoder:
Dersom et felt ikke er merket, vil det si at feltet er frivillig å sende.
Felles datafelt
Under følger en oversikt over datafelt som blir brukt på tvers av API-ene:
Om feltene er obligatoriske eller frivillige, avhenger både av hvilke API-er som brukes og betingelser internt i det enkelte API-et.
Felt | Beskrivelse |
|---|---|
Metadata | Obligatorisk for alle API-er. |
Saksnummer | Obligatorisk for alle API-er. |
Avsenders kontaktpunkt | Alltid frivillig å sende. |
Milepæl | Obligatorisk ved:
|
Saksbehandlingsfrist | Er frivillig for alle API-er i og med at fristen ikke alltid vil være satt ved API for kvittering. Feltet skal kun benyttes når ny eller oppdatert dato settes, som en følge av milepælene. Merk at søknadsleverandørene må være tydelig på at fristen kan endres underveis i saksbehandlingen siden den følger milepælene og saksbehandlingsfasene, slik at søker/tiltakshaver ikke oppfatter den som fastsatt. |
Utgående dokument | Obligatorisk ved følgende oppdateringer:
Kan være ett eller flere dokumenter/vedlegg. |
Melding | Alltid frivillig å sende. |
Distribusjonstype for utgående dokument
Vi foreslår å opprette en ny kodeliste for distribusjonsmetode med følgende verdier:
Fellestjenester BYGG
SvarUt
E-post
Annen
Det er obligatorisk å velge distribusjonsmetode. Hver fil kan ha flere distribusjonsmetoder, for eksempel dersom dokumentet sendes både via SvarUt og tilgjengeliggjøres i FtB.
Hvis distribusjonsmetode er Fellestjenester BYGG, vil DokumentUrl være obligatorisk. Da vil en lenke mellomlagres i FtB frem til søknadssystemet har hentet dokumentet.
Spesifikk validering for hvert API
Kravtabeller og validering finnes på egne sider under hvert API: