Přeskočit na hlavní obsah
Přepočet skladu - REST API

Jak vyvolat přepočet skladu přes REST API?

Petr Pech avatar
Autor: Petr Pech
Aktualizováno před více než týdnem

Způsob volání

Lze využít HTTP metodu: PUT nebo POST.

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

Jsou podporovány výstupní formáty: XML nebo JSON.

Parametry

Služba pro evidenci sklad očekává povinně parametr ucetniObdobi, aby bylo možno identifikovat časové období, za které chcete sklad přepočítat. Uvádějte kód období po vzoru code:2020.

Volitelně umožňuje použít parametr dry-run. Pomocí tohoto parametru lze zjistit, zda byl přepočet dokončen. Pokud ano, vrátí HTTP status 200. Pokud ne, vrátí HTTP status 409 s informací o tom, kdy a kým byl přepočet spuštěn.

Výsledek

Pro rozpoznání, zda byla služba vykonána úspěšně, lze kontrolovat HTTP status odpovědi nebo vlastnost success v získaném dokumentu.

V případě úspěšného vykonání služby je vracen HTTP status 200 a dokument odpovídající standardnímu formátu, viz. návratové hodnoty.

V případě neúspěchu je vracen status 4xx/5xx a zpráva o důvodu neúspěchu.

Ukázky volání

  • 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 nebo Accept: application/json)

V příkladech výše se používá filtrace.

Dostali jste odpověď na svou otázku?