API for vedtak: Valideringsregler

API for vedtak: Valideringsregler

Oversikt

Feltene merket med rødt er alltid obligatoriske å angi. Felter merket med oransje er obligatoriske å oppgi under gitte betingelser. Hvilke betingelser det er fremgår av kravtabellen under.

Det vil ikke alltid være utfall ved utsending av vedtak, derfor er bolken for SjekklisteUtfall frivillig. Utfall skal sendes strukturert dersom det er vilkår eller oppfølgingspunkt.

Informasjon om sjekkpunktID og sjekkpunktTittel er bare obligatorisk dersom sjekkpunktEier er DiBK eller SSB/Kostra.

For mer informasjon om validering av metadata, saksnummer, milepæl og utgående dokument, se felles datafelt eller kravtabellen under.

Copy of API-er for saksbehandlingsdata - API for vedtak - endelig (1).jpg
Valideringsregler - API for vedtak

 

Kravtabell

Kravtabellen under angir validering av API for vedtak.

Felt

Beskrivelse

Validering

Kommentar/betingelse

Felt

Beskrivelse

Validering

Kommentar/betingelse

Metadata

Du må fylle ut metadata om forsendelsen.

Påkrevd

 

FraEbyggesakssystem

Du må fylle ut navnet på eByggesakssystemet som oppdateringen sendes fra.

Påkrevd

 

InnsendingReferanse

Du må fylle ut referansen til innsendingen som oppdateringen svarer på. Dette er ofte en Altinn-referanse.

Påkrevd

 

FtBID

-

Frivillig

 

AvsenderID

Du må fylle ut ‘avsenderID’. Dersom oppdateringen sendes fra en kommune, skal kommunenummer oppgis. Dersom oppdateringen sendes fra en sektormyndighet, skal organisasjonsnummer brukes.

Påkrevd

 

 

‘AvsenderID’ ({0}) er på feil format. ‘AvsenderID’ skal bestå av 4 siffer ved bruk av kommunenummer, eller 9 siffer ved bruk av organisasjonsnummer.

Betinget

Slår ut dersom ‘AvsenderID’ ikke er 4 eller 9 siffer.

AvsenderNavn

Du må fylle ut navnet på kommunen/sektormyndigheten oppdateringen sendes fra.

Påkrevd

 

EkspedertDato

Du må fylle ut datoen for når oppdateringen blir ekspedert.

Påkrevd

 

 

‘EkspedertDato’ kan ikke være nyere enn dagens dato.

Betinget

Slår ut dersom ‘EkspedertDato’ er dagens dato eller tidligere.

OffentligJournalUrl

-

Frivillig

 

Saksnummer

Du må oppgi tildelt saksnummer med saksår og sakssekvensnummer.

Påkrevd

 

Saksaar

Du må oppgi saksnummer med saksår.

Påkrevd

 

 

Saksår ({0}) for kommunens saksnummer er ikke gyldig. Saksåret må inneholde fire siffer, og kan ikke være nyere enn inneværende år.

Betinget

Slår ut hvis

  • saksår ikke er 4 siffer.

  • saksår er nyere enn inneværende år

Sakssekvensnummer

Du må oppgi saksnummer med sekvensnummer.

Påkrevd

 

Journalpostnummer

-

Frivillig

 

Milepæl

Du må oppgi hvilken milepæl vedtaket gjelder. Du kan sjekke tilgjengelige milepæler på https://register.geonorge.no/kodelister/ebyggesak/milepel

Påkrevd

 

 

‘{0}' er en ugyldig kodeverdi for 'milepæl’. Gyldige kodeverdier er: VT. Du kan sjekke gyldige verdier her: https://register.geonorge.no/kodelister/ebyggesak/milepel

Betinget

 Slår ut om milepæl er ugyldig.

Utgående dokument

Du må fylle ut informasjon om dokumentene som blir sendt.

Påkrevd

 

Distribusjon

Du må fylle ut informasjon om distribusjon av utgående dokument.

Påkrevd

 

  • DistribusjonsMetode

Du må fylle ut distribusjonsmetoden for utgående dokument. Du kan sjekke gyldige distribusjonsmetoder på https://register.geonorge.no/kodelister/ebyggesak/distribusjonsmetode

Påkrevd

 

 

‘{0}' er en ugyldig kodeverdi for 'distribusjonsmetode’. Gyldige kodeverdier er: ftb, svarut, epost, annen. Du kan sjekke gyldige verdier her: https://register.geonorge.no/kodelister/ebyggesak/distribusjonsmetode

Betinget

Slår ut om distribusjonsmetoden er feil.

  • DokumentUrl

Du har valgt å laste opp det utgående dokumentet til Fellestjenester BYGGs dokumentlager. Da må du oppgi dokumentets URL for nedlastning.

Betinget

Slår ut dersom distribusjonsmetode = ftb

DokumentNavn

Du må fylle ut navnet til det utgående dokumentet.

Påkrevd

 

MimeType

Du har valgt å laste opp det utgående dokumentet til Fellestjenester BYGGs dokumentlager. Da må du oppgi filtypen for det utgående dokumentet.

Betinget

Slår ut dersom distribusjonsmetode = ftb

DokumentStorrelse

-

Frivillig

 

Hoveddokument

Du må velge om det utgående dokumentet er et hoveddokument eller et vedlegg.

Påkrevd

 

 

Du kan kun sette ett dokument som ‘hoveddokument'. De øvrige må være 'vedlegg’.

Betinget

Slår ut om flere dokumenter er markert som hoveddokument.

OversiktGodkjenteDokumenter

-

Frivillig

 

DokumentTittel

Tittel på dokumentet er påkrevd

Frivillig

 

Versjonsdato

-

Frivillig

 

Versjonsnummer

-

Frivillig

 

VedleggsType

VedleggsType på dokumentet er påkrevd

Frivillig

 

VedtakStatus

Du må oppgi statusen for vedtaket. Du kan sjekke gyldige statuser på https://register.geonorge.no/kodelister/ebyggesak/vedtakstatus

Påkrevd

 

 

‘{0}' er en ugyldig kodeverdi for 'vedtakstatus’. Gyldige kodeverdier er: 1, 3, 9, 10. Du kan sjekke gyldige verdier her: https://register.geonorge.no/kodelister/ebyggesak/vedtakstatus

Betinget

Slår ut om vedtakstatus er ugyldig

Sjekklisteutfall

-

Frivillig

 

UtfallID

Du må oppgi en ID for utfallet.

Betinget

Slår ut hvis det er verdi i noen av de andre feltene for sjekklisteutfall, f.eks. tittel.

UtfallType

Du må oppgi utfallstypen. Hvilket utfall som er riktig bestemmes av det aktuelle sjekkpunktet. Du kan sjekke tilgjengelige utfall på https://register.geonorge.no/kodelister/ebyggesak/utfall

Betinget

Slår ut hvis det er verdi i noen av de andre feltene for sjekklisteutfall, f.eks. tittel.

 

'{0}' er en ugyldig kodeverdi for utfallstype. Gyldige kodeverdier er: MKV, AVV, AVS, SVV. Du kan sjekke gyldige utfall ved å velge milepælen oppdateringen gjelder: https://register.geonorge.no/kodelister/ebyggesak/milepel

Betinget

Slår ut om utfallstype er ugyldig

UtlostFraSjekkpunkt

Du må fylle ut informasjon om sjekkpunktet som utfallet er utløst fra.

Betinget

Slår ut hvis det er verdi i noen av de andre feltene for sjekklisteutfall, f.eks. tittel.

  • SjekkpunktID

Du har oppgitt sjekkpunkteier {0}. Da må du også fylle ut ID-en til sjekkpunktet som utfallet er utløst fra.

Betinget

Slår ut dersom ‘sjekkpunktEier’ er Dibk, Kostra eller SSB.

 

‘SjekkpunktID’ ({0}) er på feil format. Sjekkpunktet skal bestå av siffer og punktum. Du kan finne riktig sjekkpunkt på https://sjekkliste-bygg.ft.dibk.no

Betinget

Slår ut dersom

  • ‘sjekkpunktEier’ er Dibk, Kostra eller SSB, og

  • sjekkpunktID består av ikke kun tall og punktum

  • SjekkpunktTittel

Du har oppgitt sjekkpunkteier ‘{0}’. Da må du også fylle ut tittelen på sjekkpunktet som utfallet er utløst fra.

Betinget

Slår ut dersom ‘sjekkpunktEier’ er DiBK, Kostra eller SSB.

  • SjekkpunktUrl

-

Frivillig

 

  • SjekkpunktEier

Du må fylle ut hvem som er eier av sjekkpunktet som utfallet er utløst fra.

Betinget

Slår ut hvis det er verdi i noen av de andre feltene for sjekklisteutfall, f.eks. tittel.

BeskrivelseAvUtfall

Saksbehandler må legge inn informasjon om utfallet, med tittel og beskrivelse.

Betinget

Slår ut hvis det er verdi i noen av de andre feltene for sjekklisteutfall, f.eks. utfallID.

  • Tittel

Du må fylle ut en tittel for utfallet.

Betinget

Slår ut hvis det er verdi i noen av de andre feltene for sjekklisteutfall, f.eks. utfallID.

 

Utfallets tittel kan maksimalt være på 150 tegn.

Betinget

Slår ut om tittelen er for lang.

  • Beskrivelse

Du må fylle ut en beskrivelse av utfallet.

Betinget

Slår ut hvis det er verdi i noen av de andre feltene for sjekklisteutfall, f.eks. tittel.

  • Veiledningstekst

-

Frivillig

 

  • Lovhjemmel (0…*)

-

Frivillig

 

OppfyllesTilFase

‘{0}' er en ugyldig kodeverdi for 'OppfyllesTilFase’. Gyldige kodeverdier er: TA, ET, RS, IG, MB, FA, ES, NV. Du kan sjekke gyldige verdier her: https://register.geonorge.no/kodelister/byggesoknad/soknadstype

Betinget

Slår ut om feltet har en ugyldig verdi. Ikke påkrevd å fylle ut.