V tomto návode sa budeme venovať návratovým hodnotám. V predchádzajúcich dvoch článkoch ste sa dozvedeli, ako v ABRA Flexi vytvárať nové záznamy, v tomto článku sa dozviete, čo ABRA Flexi na túto činnosť odpovedá.
Flexi vráti štruktúru do požiadavky PUT alebo POST, ktorá informuje používateľa o zmenách.
Ak odosielate údaje na adresu XML, ABRA Flexi vráti štruktúru vo formáte XML.
<?xml version="1.0"?>
<winstrom version="1.0">
<success>true</success>
<stats>
<created>1</created>
<updated>0</updated>
<deleted>0</deleted>
<skipped>0</skipped>
<failed>0</failed>
</stats>
<results>
<result>
<id>804</id>
<ref>/c/demo/addresser/804.xml</ref>
</result>
</results>
</winstrom>Ale ak vyberieme adresu JSON, systém vráti aj návratovú hodnotu vo formáte JSON.
{
"winstrom": {
"@version": "1.0",
"success": "true",
"stats": {
"created": "1",
"updated": "0",
"deleted": "0",
"skipped": "0",
"failed": "0"
},
"results": [
{
"id": "805",
"ref": "\/c\/demo\/adresar\/805.json"
}
]
}
}Vrátené hodnoty možno spracovať a získať z nich potrebné informácie.
Vrátená hodnota obsahuje polia:
1. úspech
Možné hodnoty sú pravdivé a nepravdivé. Ak zápis prebehol úspešne, návratová hodnota je true. Ak počas zápisu nastala chyba, ABRA Flexi vráti false.
2. štatistiky
Flexi tiež vracia štatistiky obsahujúce informácie o tom, koľko objektov bolo vytvorených, aktualizovaných a odstránených. Koľko objektov bolo preskočených a koľko objektov sa nepodarilo vložiť z dôvodu nejakej chyby.
3. výsledky
Táto kolekcia obsahuje identifikátory objektov, ktoré boli vytvorené v systéme ABRA Flexi, a všetky chybové hlásenia pre každý objekt.
<?xml version="1.0"?>
<winstrom version="1.0">
<success>false</success>
<stats>
<created>0</created>
<updated>0</updated>
<deleted>0</deleted>
<skipped>0</skipped>
<failed>1</failed>
</stats>
<results>
<result>
<errors>
<error for="kod" code="INVALID"> Skratka 'CHARLIEB' je už použitá iným záznamom. [CHARLIEB] </error>
</errors>
</result>
</results>
</winstrom>Príklad chybovej návratovej hodnoty XML.
{
"winstrom": {
"@version": "1.0",
"success": "false",
"stats": {
"created": "0",
"updated": "0",
"deleted": "0",
"skipped": "0",
"failed": "1"
},
"results": [
{
"errors": [
{
"message": "Skratka 'CHARLIEB' je u\u017e pou\u017eit\u00e1 in\u00fdm z\u00e1znamom. [CHARLIEB]",
"for": "kod",
"code": "INVALID"
}
]
}
]
}
}Príklad návratovej hodnoty chyby JSON.
Vaša aplikácia tak bude okamžite vedieť, čo sa stalo v systéme ABRA Flexi. Môže skontrolovať, či boli vytvorené všetky objekty, a v prípade chyby môže používateľovi napísať chybovú správu a nechať ho opraviť údaje.