Validere

Operasjoner for å validere skjemasett

Validering utføres med VALIDATE på message

Følgende request validerer en melding sitt skjemasett.

Validering av meldinger er kun mulig for skjemasett som er under utfylling.

Når valideringen er utført returneres HTTP 200 med en body som inneholder resultatet av valideringen.

Header

GET https://www.altinn.no/api/{who}/messages/{messageid}/validate HTTP/1.1
Content-Type: application/hal+json
ApiKey: myKey

For vellykket validering uten feil vil Success være satt til true og ValidationWarnings vil inneholde en liste over alle advarsler skjemaene gir.

Body

{
    "Success": true,
    "ValidationErrors": [],
    "ValidationWarnings": [
        {
            "FieldName": "KontaktpersonEPost",
            "ErrorMessage": "Har du e-postadresse som du kan kontaktes på?",
            "FieldXPath": "/Skjema/Skattyterinfo/Kontakt/KontaktpersonEPost"
        },
        {
            "FieldName": "KontaktpersonTelefon",
            "ErrorMessage": "Har du et telefonnummer som du kan kontaktes på?",
            "FieldXPath": "/Skjema/Skattyterinfo/Kontakt/KontaktpersonEPost"
        }
    ]
}

For feilende validering vil Success være satt til false og ValidationWarnings/ValidationErrors vil inneholde en liste over alle advarsler/feilmeldinger skjemaene gir.

Body

{
    "Success": false,
    "ValidationErrors": [
        {
            "FieldName": "KlageSpesifisering",
            "ErrorMessage": "Klagen skal alltid begrunnes..",
            "FieldXPath": "/Skjema/klage/spesifisering/KlageSpesifisering"
        },
        {
            "FieldName": "Samtykke_Skatt",
            "ErrorMessage": "Du må krysse av for et av alternativene",
            "FieldXPath": "/Skjema/Skattyterinfo/Kontakt/Samtykke_Skatt"
        },
        {
            "FieldName": "KlageUtloptKlagefristBegrunnelse",
            "ErrorMessage": "Du må forklare hvorfor klagen blir levert etter fristen.",
            "FieldXPath": "/Skjema/Skattyterinfo/klagefrist/KlageUtloptKlagefristBegrunnelse"
        }
    ],
    "ValidationWarnings": [
        {
            "FieldName": "KontaktpersonEPost",
            "ErrorMessage": "Har du e-postadresse som du kan kontaktes på?",
            "FieldXPath": "/Skjema/Skattyterinfo/Kontakt/KontaktpersonEPost"
        },
        {
            "FieldName": "KontaktpersonTelefon",
            "ErrorMessage": "Har du et telefonnummer som du kan kontaktes på?",
            "FieldXPath": "/Skjema/Skattyterinfo/Kontakt/KontaktpersonEPost"
        }
    ]
}