Validerings API

Validerings APIet foreligger i to versjoner:

Versjon 1

URL	https://test-admbygg.dibk.no/api/validate/form https://admbygg.dibk.no/api/validate/form
Type	POST
Autentisering	NA
Request objekt	Data finnes her: Tjenesteoppsett TT02 og Tjenesteoppsett PROD "AttachmentTypesAndForms" er en liste av underskjema og vedlegg definert av FormName eller AttachmentTypeName fra Altinn metadata. Listen skal ikke inneholde skjematypen som blir validert. I tilfeller der man validerer et underskjema skal typen til hovedskjemaet ligge listen.	Eksempel
Swagger testing	https://test-admbygg.dibk.no/swagger/ui/index#!/FormValidation/FormValidation_ValidateForm
Response

Versjon 2

Denne versjonen utvider AttachmentTypesAndForms objektet og utfører flere valideringer på dette

URL	https://test-admbygg.dibk.no/api/validatev2/form https://admbygg.dibk.no/api/validatev2/form
Type	POST
Autentisering	NA
Request objekt	Data finnes her: Tjenesteoppsett TT02 og Tjenesteoppsett PROD "AttachmentTypesAndForms" er en liste av et objekt med feltene Name/Filename/FileSize. Om man definerer et hovedskjema eller underskjema lar man filename og filesize stå tomt (se eksempel nedenfor). Som på versjon 1 av validerings API er vedlegg, underskjema og hovedskjema definert av FormName eller AttachmentTypeName fra Altinn metadata.	Eksempel
Swagger testing	https://test-admbygg.dibk.no/swagger/ui/index#!/FormValidation/FormValidation_ValidateV2Form
Response

Eksempel: Test med Swagger

Vi validerer en innsending av en nabovarsel distribusjon av denne typen:

Nabovarsel	Service Code: 4655, ServiceEditionCode: 4
	https://tt02.altinn.no/api/metadata/formtask/4655/4 (metadata)
Nabovarsel hovedskjema	DataFormatId: 6303, DataFormatVersion: 44820)
	https://tt02.altinn.no/api/metadata/formtask/4655/4/forms/6303/44820/xsd
Vedlegg ("AttachmentTypeName", binære vedlegg) Tillatte format: pdf, jpeg, jpg, tif, tiff, png 30MB max per vedlegg Det kan bare være ett Folgebrev.	Situasjonsplan Annet TegningNyFasade TegningNyPlan TegningNyttSnitt Folgebrev	RedegjoerelseEstetikk TegningNyPlan Dispensasjonssoeknad TegningEksisterendeSnitt TegningEksisterendeFasade
	pdf, jpeg, jpg, tif, tiff, png
	Antall: 0 til 99, 30MB max

Eksemplet vårt skal sendes inn med følgende vedlegg:

Situasjonsplan
TegningNyttSnitt
Folgebrev
Folgebrev (vi sender inn to følgebrev)

/api/validate/form

Request objektet blir satt opp med

datamodell IDer for nabovarsel XMLen,
XML data for skjemaet
- her er den linearisert uten linjeskift og all anførselstegn i filen er escaped (version=\"1.0\" )
en liste av vedleggene

Resultat:

Vi har her fått en feil fordi vi mangler vedlegget "TegningNyFasade"

/api/validatev2/form

Versjon 2 av validerings APIet tar med mer data om vedleggene:

Filename vil sjekke om filtypen er tillatt, FileSize er i MB (mega bytes) og sjekker om vedlegget er innenfor tillatt størrelse.

Vi legger til vedlegget "TegningNyFasade" og setter vedleggene opp slik

Valideringsobjekter ser da slik ut:

Ved innsending av denne får vi disse feilene:

Her får vi valideringsfeil på:

Vedlegg må være ihht metadata for skjema. Filstørrelse for fil situasjonsplan.pdf er ikke gyldig.
Vedlegg må være ihht metadata for skjema. Filtype for fil tegningNyttSnitt.doc er ikke gyldig.
Vedlegg må være ihht metadata for skjema. Vedleggstype Folgebrev har for mange filer.

Eksempel med rammesøknad, undersjema - v1 og v2

Metadata

Eksempel på rett måte å bruke validerings-API ved innsending av hovedskjema og underskjema.
I eksempelet bruker vi Rammesøknad som hovedskjema og gjennomføringsplan som underskjema.

Validering hovedskjema

Her sjekkes følgende:

Skjema - Gyldig xml
Påkrevd vedlegg og underskjema følger med

Eksempel Rammesøknad

V1

V2

Validering av underskjema

Fordi innholdet - XML’en - i underskjema ikke blir validert sammen med hovedskjema, må den valideres i en egen hovedinnsending. Eksempel gjennomføringsplan valideres på samme måte som hovedskjema.

Underskjema skal alltid ha et saksnummer når det blir sendt inn som en egen innsending i Ftb.

Når vi prevaliderer et underskjema tilknyttet for eksempel rammesøknad, som er første steg, har vi ikke fått et saksnummer fra kommunen. Vi må derfor legge ved hovedskjema som en del av AttachmentTypesAndForms,for å kunne validere riktig at dette er et underskjema.

Man vil ikke få feil dersom hovedskjema ligger i listen ved innsending, men saksnummer må være med.

Her sjekkes følgende

Skjema - Gyldig xml
Påkrevd vedlegg og underskjema følger med
Finnes det et saksnummer
- Hvis nei => finnes det et hovedskjema i listen.

Eksempel Gjennomføringsplan

V1

V2