V návode sa pozrieme na návratové hodnoty. V dvoch predchádzajúcich článkoch ste sa naučili zakladať nové záznamy do ABRA Flexi, tento článok prezradí, čo ABRA Flexi na túto akciu odpovedá.
Flexi na požiadavku typu PUT alebo POST vracia štruktúru, ktorá informuje používateľa o zmenách.
Pokiaľ posielate dáta 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/adresar/804.xml</ref> </result> </results></winstrom>
Pokiaľ však zvolíme adresu JSON, systém návratovú hodnotu tiež vráti 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" } ] }}Návratové hodnoty je možné spracovať a zistiť z nich potrebné informácie.
Návratová hodnota obsahuje polia:
1. success
Možné hodnoty sú true a false. V prípade, že sa zápis podaril, návratovou hodnotou je true. Pokiaľ pri zápise došlo k chybe, ABRA Flexi vracia hodnotu false.
2. stats
Flexi tiež vracia štatistiky obsahujúce informácie o tom, koľko objektov bolo vytvorených (created), zmenených (updated), zmazaných (deleted). Koľko objektov bolo preskočených (skipped) a koľko objektov sa nepodarilo vložiť kvôli nejakej chybe (failed).
3. results
Táto kolekcia obsahuje identifikátory objektov, ktoré boli v ABRA Flexi založené, a prípadné výpisy chýb pri jednotlivých objektoch.
<?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"> Zkratku 'CHARLIEB' již používá jiný záznam. [CHARLIEB] </error> </errors> </result> </results></winstrom>
Ukážka chybovej XML návratovej hodnoty.
{ "winstrom": { "@version": "1.0", "success": "false", "stats": { "created": "0", "updated": "0", "deleted": "0", "skipped": "0", "failed": "1" }, "results": [ { "errors": [ { "message": "Zkratku 'CHARLIEB' ji\u017e pou\u017e\u00edv\u00e1 jin\u00fd z\u00e1znam. [CHARLIEB]", "for": "kod", "code": "INVALID" } ] } ] }}Ukážka chybovej JSON návratovej hodnoty.
Vaša aplikácia teda hneď rozpozná, čo sa v ABRA Flexi udialo. Môže skontrolovať, či došlo k založeniu všetkých objektov, a v prípade chyby zobraziť používateľovi chybové hlásenie a umožniť mu dáta opraviť.