Errorlist

A Barion wikiből

Hibalista

A hiba tömbben (Errorlist) egyszerre több hiba is érkezhet, attól függően, hogy milyen problémák történtek a kérés feldolgozása közben. A tömbben minden hiba ugyanolyan formátumú, három mező szerepel minden egyes hiba objektumban.

{
     "ErrorNumber": 2001,
     "ErrorMessage": "Validation Error: model.Recipient Value: The Recipient field is required.",
     "Details": null
}

A tömbben szereplő hibák ErrorMessage mezője csak tájékoztató jellegű, a benne lévő hibaüzenetek a fejlesztés idejére szolgálnak segítségül, nem szabad felhasználni őket az integráló alkalmazásban. Az alkalmazás logikáját a hibák kódjára építsük.

A hibák Details mezője nem minden esetben kerül kitöltésre, bizonyos hívások során ott a hibakeresést segítő információk érkezhetnek. Formátuma kötetlen, lehet benne akár egy egyszerű string akár egy összetett objektum.

Kimenet

Mező Típus Leírás Formátum / Példa
ErrorNumber integer A hiba kódja 1
ErrorMessage string A hiba szöveges leírása A felhasználói név vagy jelszó nem megfelelő!
Details JSON A hiba részletei, jelenleg nem használt n/a

Példa

{
   ErrorList:[
      {
          ErrorNumber: 2001,
          ErrorMessage: "Validation Error: UserName Value: The UserName field is required.",
          Details: null
      },
      {
          ErrorNumber: 2001,
          ErrorMessage: "Validation Error: Password Value: The Password field is required.",
          Details: null
      },
      {
          ErrorNumber: 1,
          ErrorMessage: "A felhasználói név vagy jelszó nem megfelelő!",
          Details: null
      }
   ]
}