Preskoči na glavno vsebino

Prepočet skladu - REST API

Ako vyvolať prepočet skladu cez REST API?

Avtor: Petr Pech

Spôsob volania

Možno využiť HTTP metódu: PUT alebo POST.

Služba je dostupná na adrese: /c/{firma}/sklad/prepocet, kde {firma} je databázový identifikátor firmy.

Sú podporované výstupné formáty: XML alebo JSON.

Parametre

Služba pre evidenciu sklad očakáva povinne parameter ucetniObdobi, aby bolo možné identifikovať časové obdobie, za ktoré chcete sklad 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 kontrolovať 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, viz. 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/sklad/prepocet.xml?ucetniObdobi=code:2020

  • PUT /c/demo/sklad/prepocet.json?ucetniObdobi=code:2020

  • PUT /c/demo/sklad/prepocet?ucetniObdobi=code:2020 (s hlavičkou Accept: application/xml alebo Accept: application/json)

V príkladoch vyššie sa používa filtrácia.

Ste s tem dobili odgovor na svoje vprašanje?