Preskoči na glavno vsebino

Prepočet skladu - REST API

Ako vyvolať prepočet skladu cez REST API?

Avtor: Petr Pech

Prepočet skladu zaisťuje kontrolu a prepočítanie skladových stavov a cien za zvolené účtovné obdobie. Cez REST API ho možno vyvolať rovnako ako v aplikácii.


Spôsob volania

Služba je dostupná metódami PUT a POST na adrese /c/{firma}/sklad/prepocet, kde {firma} je databázový identifikátor firmy. Podporovanými výstupnými formátmi sú XML a JSON.


Parametre

  • ucetniObdobi — povinný parameter, ktorým sa identifikuje obdobie, za ktoré chcete sklad prepočítať. Uvádza sa ako identifikátor v tvare code:2024.

  • dry-run — voliteľný parameter, ktorým je možné 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, 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ý HTTP status 200 a dokument zodpovedajúci štandardnému formátu, pozri návratové hodnoty:

{
"winstrom": {
"@version": "1.0",
"success": "true"
}
}

V prípade neúspechu je vrátený status 4xx alebo 5xx a správa o dôvode neúspechu.


Ukážky volania

PUT https://demo.flexibee.eu/c/demo/sklad/prepocet.xml?ucetniObdobi=code:2024
PUT https://demo.flexibee.eu/c/demo/sklad/prepocet.json?ucetniObdobi=code:2024
PUT https://demo.flexibee.eu/c/demo/sklad/prepocet?ucetniObdobi=code:2024

Pri poslednom volaní bez prípony sa formát určí hlavičkou Accept: application/xml, prípadne Accept: application/json.


Súvisiace

Ste s tem dobili odgovor na svoje vprašanje?