Spôsob volania
Možno využiť HTTP metódu: PUT alebo POST.
Služba je dostupná na adrese: /c/{firma}/stav-uctu/prepocet, kde {firma} je databázový identifikátor firmy.
Sú podporované výstupné formáty: XML alebo JSON.
Parametre
Služba vyžaduje povinný parameter ucetniObdobi, aby bolo možné identifikovať časové obdobie, za ktoré chcete účty prepočítať. Uvádzajte kód obdobia podľa vzoru code:2020.
Voliteľne umožňuje použiť parameter dry-run. Pomocou tohto parametra možno zistiť, či bol prepočet dokončený. Ak áno, vráti HTTP status 200. Ak nie, vráti HTTP status 409 s informáciou o tom, kedy a kým bol prepočet spustený.
Výsledok
Na rozpoznanie, či bola služba vykonaná úspešne, možno skontrolovať HTTP status odpovede alebo vlastnosť success v získanom dokumente.
V prípade úspešného vykonania služby je vrátený HTTP status 200 a dokument zodpovedajúci štandardnému formátu, viď návratové hodnoty.
V prípade neúspechu je vrátený status 4xx/5xx a správa o dôvode neúspechu.
Ukážky volania
PUT /c/demo/stav-uctu/prepocet.xml?ucetniObdobi=code:2020PUT /c/demo/stav-uctu/prepocet.json?ucetniObdobi=code:2020PUT /c/demo/stav-uctu/prepocet?ucetniObdobi=code:2020
(s hlavičkouAccept: application/xmlaleboAccept: application/json)
