Preskoči na glavno vsebino

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

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

Avtor: Petr Pech

V prípade, že je v nastavení firmy povolené generovanie požiadaviek na výdaj, tak 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? Pozrite si našu dokumentáciu.

Spôsob volania

Možno využiť HTTP metódu:

PUT alebo POST

Služba je dostupná na adrese:

/c/{firma}/sklad/aktualizace-pozadavku

Sú podporované výstupné formáty:

XML alebo JSON

Parametre

Služba 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.

Úspešné volanie

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

XML

<?xml version="1.0"?><winstrom version="1.0">  <success>true</success></winstrom>

JSON

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

Neúspešné volanie

HTTP status odpovede je 4xx alebo 5xx. A napríklad v prípade, že firma nemá povolené generovanie požiadaviek na výdaj, získame výsledný dokument:

XML

<?xml version="1.0"?><winstrom version="1.0">  <success>false</success>  <message>Nen&#xED; povoleno generov&#xE1;n&#xED; po&#x17E;adavk&#x16F; na v&#xFD;dej.</message></winstrom>

JSON

{    "winstrom": {        "@version": "1.0",        "success": "false",        "message": "Nen\u00ed povoleno generov\u00e1n\u00ed po\u017eadavk\u016f na v\u00fddej."    }}

Ukážky volania

  • PUT /c/demo/sklad/aktualizace-pozadavku.xml

  • PUT /c/demo/sklad/aktualizace-pozadavku.json

  • PUT /c/demo/sklad/aktualizace-pozadavku (s hlavičkou Accept: application/xml alebo Accept: application/json)

  • POST /c/demo/sklad/aktualizace-pozadavku.xml

  • POST /c/demo/sklad/aktualizace-pozadavku.json

  • POST /c/demo/sklad/aktualizace-pozadavku (s hlavičkou Accept: application/xml alebo Accept: application/json)

Ste s tem dobili odgovor na svoje vprašanje?