Valideringstjeneste (ValService) for nye byggsøknader og plantjenester

Det er laget en ny tjeneste (et nytt api) for validering av plantjenester og byggsøknader.
API’et kjører som en separat tjeneste, og kalles fra prosesseringstjenestene i Fellestjenester Bygg, samt at de er tilgjengelige for pre-validering av søknader for søknadsleverandører.

Bruksområder

AnSaKo prod
Søknad om Arbeidstilsynets samtykke ver.2 prod
Varsel om oppstart av reguleringsplanarbeid prod
Søknad om igangsettingstillatelse v3 test
Gjennomføringsplan v7 test
Søknad om midlertidig brukstillatelse v3 Under arbeid
Søknad om ferdigattest v3 Under arbeid

Teknisk

Miljø - angitt som `{miljø}` i videre tekst	Basis-url

Miljø - angitt som `{miljø}` i videre tekst	Basis-url
Testmiljø (tt02)	https://validering.ft-test.dibk.no
Produksjon	https://validering.ft.dibk.no

Autentisering

Det er ikke behov for autentisering mot APIet for validering.

APIet

Open API(swagger) dokumentasjon på alle API i test: https://validering.ft-test.dibk.no/swagger/index.html

Open API(swagger) dokumentasjon på alle API i test: https://validering.ft.dibk.no/swagger/index.html

Url til API for å få valideringsrapport

POST {miljø}/api/validationReport

Respons fra APIet, validationReport

Responsen fra APIet har følgende form:

{
  "errors": 0,
  "warnings": 0,
  "tiltakstyperISoeknad": [
    "string"
  ],
  "soknadtype": "string",
  "messages": [
    {
      "rule": "string",
      "reference": "string",
      "message": "string",
      "messagetype": "ERROR",
      "xpathField": "string",
      "preCondition": "string",
      "checklistReference": "string"
    }
  ],
  "rulesChecked": [
    {
      "id": "string",
      "rule": "string",
      "message": "string",
      "messagetype": "ERROR",
      "xpathField": "string",
      "preCondition": "string",
      "checklistReference": "string"
    }
  ],
  "prefillChecklist": [
    {
      "checklistReference": "string",
      "checklistQuestion": "string",
      "yesNo": true,
      "supportingDataValidationRuleId": [
        "string"
      ],
      "supportingDataXpathField": [
        "string"
      ],
      "documentation": "string"
    }
  ]
}

errors - Totalt antall rules som er validert med "messageType": "ERROR".
warnings - Totalt antall rules som er validert "messageType": "WARNING".
tiltakstyperISoeknad- Hvilke tiltakstyper søknaden gjelder for
soknadtype- Hvilken type søknad reglene gjelder for
messages- Liste over hvilke valideringsmeldinger som har utløst
- rule - Hvilken type regel
- reference - Regelens identifikator
- message - Regelens valideringstekst, en beskrivelse av hva regelen gjelder
- messagetype - Indikerer om regelen innebærer et MÅ- eller BØR-krav, ved henholdsvis ERROR/WARNING
- xpathField - Regelens xpath
- preCondition - Forutsetning for at regelen skal slå ut
- checklistReference - Referanse til hvilket sjekkpunkt som gjelder for regelen
rulesChecked - liste over alle reglene som har blitt sjekket
prefillChecklist - liste over hvilke sjekkpunkt som er preutfylt(foreløpig kun implementert for Arbeidstilsynet)

Eksempler på bruk

Igangsettingstillatelse

Url

POST {miljø}/api/validationReport

Request

AuthenticatedSubmitter - Org eller fødselsnummeret til innsender
FormData - Søknads-xml
SubForms - Eventulle underskjema
Attachments - Liste over vedlegg