Preskoči na glavno vsebino

Aktualizácia požiadaviek na výdaj - REST API

Ako spustiť cez REST API aktualizáciu požiadaviek na výdaj?

Avtor: Petr Pech

Pokiaľ je v nastavení firmy povolené generovanie požiadaviek na výdaj, možno pomocou REST API volať službu Aktualizácia skladových požiadaviek na výdaj.

Neviete, čo je požiadavka na výdaj? Nahliadnite do článku Aktualizácia požiadaviek na výdaj.


Spôsob volania

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


Parametre

Služba nemá žiadne povinné parametre. Voliteľne umožňuje použiť parameter dry-run, ktorým 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.

Úspešné volanie

V prípade úspešného vykonania služby je vracaný HTTP status 200 a dokument zodpovedajúci požadovanému formátu:

<?xml version="1.0"?>
<winstrom version="1.0">
<success>true</success>
</winstrom>
{
"winstrom": {
"@version": "1.0",
"success": "true"
}
}

Neúspešné volanie

HTTP status odpovede je 4xx alebo 5xx. Napríklad ak firma nemá povolené generovanie požiadaviek na výdaj, získame tento dokument:

<?xml version="1.0"?>
<winstrom version="1.0">
<success>false</success>
<message>Není povoleno generování požadavků na výdej.</message>
</winstrom>
{
"winstrom": {
"@version": "1.0",
"success": "false",
"message": "Není povoleno generování požadavků na výdej."
}
}


Ukážky volania

PUT  https://demo.flexibee.eu/c/demo/sklad/aktualizace-pozadavku.xml
PUT https://demo.flexibee.eu/c/demo/sklad/aktualizace-pozadavku.json
POST https://demo.flexibee.eu/c/demo/sklad/aktualizace-pozadavku.xml
POST https://demo.flexibee.eu/c/demo/sklad/aktualizace-pozadavku.json

Volať možno aj bez prípony — PUT https://demo.flexibee.eu/c/demo/sklad/aktualizace-pozadavku — potom 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?