API for validering av Varsel om oppstart av reguleringsplanarbeid v2
Alle valideringsregler ligger i en valideringstjeneste utenfor altinn appen. Den blir brukt som en del av innsendingsprosessen i appen, men kan og brukes for å prevalidere data.
Valideringer
Planvarsel Valideringsregler for varsel om planforslag v2
Planområde https://dibk.atlassian.net/wiki/x/CwDwfQ
Prevalidering - Ftpb validationService
Valideringstjeneste (ValService) for nye byggsøknader og plantjenester
Validering i altinn app - varselplanoppstart
Altinn appen sjekker at data som lastes opp til instansen er i henhold til konfigurasjonen av dataelementet i applicationMetadata. Det blir og gjort validering ved process next, der det sjekkes om alle påkrevde data er lastet opp for det aktuelle prosessteget.
Altinn har i tillegg endepunkt for å prevalidere data og intans. Her har vi koblet på våre valideringer fra valideringstjenseten og gjør de samme valideringene som ved prevalidering.
https://docs.altinn.studio/nb/api/apps/validation/
Opplasting av data - utvidet filvalidering
DataTyper
Planvarsel
I tillegg til altinn appen sine valideringer om data er i henhold til konfigurasjon i applicationMetadata, så har vi lagt på data analyse og validering av enkelte datatyper, for å sjekke at data er henhold til datamodellen.
GET /api/v1/applicationmetadata
enabledFileAnalysers
enabledFileValidator
Eksempel - Legg til data
POST https://dibk.apps.tt02.altinn.no/dibk/varselplanoppstart/instances/50096175/b1f579d4-5f9b-4bae-92ce-8c4cdf20a55b/data?dataType=Planvarsel
Sender inn data i henhold til datamodell
Respons - 201 Created
Sender inn feil data
Respons - 400 Bad Request
Innholdet er ikke gyldig i henhold til datamodell. Feilmelding: There is an error in XML document (1, 7).
Data validering
https://docs.altinn.studio/nb/api/apps/validation/#validate-stored-data
Altinn appen sitt endepunkt for validering av data. Her sender vi data til Ftpb validationService og returnerer valideringsmeldinger i responsen til altinn som ValidationIssue
.
Her skal man altså få den samme informasjonen som ved prevalidering med ftpb validationService
Mapping mellom Ftpb validationService og altinn ValidationIssue
ValidationIssue | ValidationReport .ValidationMessages | Eksempel |
---|---|---|
Severity | MessageType | Error |
DataElementId | DataType | Fra appen: |
Field | XpathField |
|
Code | Reference |
|
Description | Message |
|
Source | Settes av altinn, hvilke validator som er brukt. |
|
Instans validering
Her kjøres data validering og validering om instansen er i henhold til konfigurasjonen i applicationmetadata.
Process next
Her blir instan validering kjørt automatisk. Dersom man ikke får gå videre, må man sjekke instans validering for å få se evt valideringsfeil.
Oppsummering
Prevalidering er noe man kan velge å gjøre. Hvis man vil prevalidere før man oppretter en instans, så må man bruke prevalidering direkte mot ftpb validationservice Valideringstjeneste (ValService) for nye byggsøknader og plantjenester. Når man har en instans og har lastet opp data, kan man bruke endepunkter i appen for å prevalidere.
Process next all validering av data og instans. Dersom man kaller process next og får beskjed om at instansen har valideringsfeil, så må man kalle på appen sitt valideringsendepunkt GET instans/validate
for å få vite hva som er feil.
For å komme videre til neste steg så alle valideringsfeil være rettet.