Vearaporti struktuur

Vearaport koosneb päisest ja vigade loetelust. Kõige paremini saab vearaporti struktuurist ülevaate kasutades Swaggeri dokumentatsiooni. Sealt on võimalik näha ka näidist, koos vigadega mis tekkida võivad, ning tehnilise raporti OpenAPI skeemi koos sinna kuuluvate piirangute ja andmetüüpidega.

Siin lehel leiab täiendavaid kirjeldusi raportis tagastatavates väljades oleva info osas.

Vearaporti päis

status - andmestiku töötlemise (sh valideerimise) lõpptulemus.
unique_id(nullable) - andmefaili gl-cor:uniqueID väärtus
errors - sisaldab 0..n tuvastatud viga. Vigade puudumisel tagastatakse tühi nimekiri

Vigade plokk "errors" sisaldab andmeid vaid juhul kui andmestiku valideerimise lõpptulemus status on WARNING, ERROR või SERVER_TECHNICAL_ERROR.

Vea objekt(errors)

code(nullable) - äriloogilise vea kood. Tehniliste vigade puhul tühi
level - kas tegemist on vea või hoiatusega
descriptions - Vea täpsem kirjeldus kas inglise ja eesti keeles. en(required), et(nullable). Schema vastu andmestiku kontrollimise vead on üldjuhul inglise keeles. Kõik muud järgnevates etappides tuvastatud puudused on üldjuhul kahes keeles.
entry_number(nullable) - viide andmesektsioonile, milles viga tuvastati
line_number_counter (nullable) - viide andmesektsiooni reanumbrile, milles viga tuvastati

Iga viga esitatakse eraldi. Kirjelduses descriptions viidatakse täpsemalt vea sisule

Tuleb arvestada, et ühe andmerea puhul võidakse tagastada mitu veateadet kuna tuvastatud vigu võib olla rohkem kui üks.

Võimalikud väärtused(errors objekt)

Väli	Võimalikud väärtused

Väli	Võimalikud väärtused
status	`PENDING`,`PENDING_RETRY`, `OK`, `WARNING`, `ERROR`, `SERVER_TECHNICAL_ERROR`
unique_id	Andmefaili gl-cor:uniqueID või `null`
errors[].code	`DEBIT_NOT_EQUALS_CREDIT`, `NOT_VALID_CODE`, `NOT_EXISTING_CODE`, `INCORRECT_VALUE`, `INCORRECT_PERIOD, MISSING_REQUIRED_SUBACCOUNT, NOT_ALLOWED_COMBINATION`, `null`
errors[].level	`ERROR`, `WARNING`
errors[].descriptions	Objekti attribuudid: “en” - Vea tekst, “et” - Vea tekst või `null`
errors[].entry_number	`EE0301010`, `EE0301020` või `N/A`
errors[].line_number_counter	Andmefaili rea number, kus viga esineb või `null`

Näidisvastus : Tehniline viga nt schema viga

{
  "status": "ERROR",
  "unique_id": null,
  "errors": [
    {
      "descriptions": {
        "en": "Expecting property name enclosed in double quotes: line 15 column 9 (char 505)",
        "et": null
      },
      "entry_number": "N/A",
      "level": "ERROR",
      "code": null,
      "line_number_counter": null
    }
  ]
}

Näidisvastus : äriloogilise kontrolli vead

Vea vastus sisaldab alati veakoodi"code"

{
  "status": "ERROR",
  "unique_id": "12345678-2024-09-24T13:29:42:578",
  "errors": [
    {
      "descriptions": {
        "en": "The sub_account code used (01481) was not valid during the reporting period",
        "et": "Kasutatud sub_account kood (01481) ei olnud aruandeperioodil kehtiv"
      },
      "entry_number": "EE0301010",
      "level": "WARNING",
      "code": "NOT_VALID_CODE",
      "line_number_counter": 15
    },
    {
      "descriptions": {
        "en": "The total debit and credit of the dataset are not equal",
        "et": "Andmestiku deebet kokku ja kreedit kokku ei ole võrdsed"
      },
      "entry_number": "EE0301010",
      "level": "ERROR",
      "code": "DEBIT_NOT_EQUALS_CREDIT"
    },
    {
      "descriptions": {
        "en": "No unsubmitted obligations found for entity",
        "et": "Ühingul puuduvad täitmata aruande kohustused"
      },
      "entry_number": "N/A",
      "level": "WARNING",
      "code": "INCORRECT_PERIOD"
    }
  ]
}