Preskoči na glavno vsebino

Prepočet stavu účtov - REST API

Ako pomocou API spustiť prepočet stavu účtov?

Avtor: Petr Pech

Cez REST API je možné vyvolať prepočet stavov účtov — teda rovnakú operáciu, akú v aplikácii spúšťate nad účtovnými výstupmi.


Spôsob volania

Je možné 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. Podporované sú výstupné formáty XML alebo JSON.


Parametre

Parameter

Povinnosť

Význam

ucetniObdobi

povinný

Obdobie, za ktoré chcete účty prepočítať. Uvádzajte kód obdobia podľa vzoru code:2020.

dry-run

nepovinný

Zistí, či bol prepočet dokončený. Ak áno, vráti HTTP status 200. Ak nie, vráti 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, je možné kontrolovať HTTP status odpovede alebo vlastnosť success v získanom dokumente. V prípade úspešného vykonania služby je vrátený status 200 a dokument zodpovedajúci štandardnému formátu — pozri 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:2020
PUT /c/demo/stav-uctu/prepocet.json?ucetniObdobi=code:2020

Formát je možné určiť aj hlavičkou namiesto prípony — v tom prípade pridajte Accept: application/xml alebo Accept: application/json:

PUT /c/demo/stav-uctu/prepocet?ucetniObdobi=code:2020


Súvisiace

Ste s tem dobili odgovor na svoje vprašanje?