Jak začít s API FlexiBee - HTTP operace (4/6)

V zásadě máme čtyři základní podporované HTTP operace umožňující práci s FlexiBee:

  1) GET (přečtení záznamu, získání dat)

  • je zohledňován výstupní formát (uvedený jako přípona URL)

  2) POST, PUT (vytvoření, aktualizace záznamu)

  • nerozlišuje se POST/PUT, význam závisí na cílové URL

  • při ukládání záznamu do dané evidence je záznam buď přidán, nebo aktualizován (podle existujícího/neexistujícího identifikátoru)

  • při operaci na detail záznamu (tedy pokud URL obsahuje identifikátor), nemusí být v těle requestu identifikátor uveden

  3) DELETE (smazání záznamu)

  • lze smazat za pomoci jejich detailového URL (URL obsahující identifikátor)

  • doporučujeme používat spíše aciton="delete"
  • 200 – OK; 404 – záznam neexistuje

  • funguje pouze nad konkrétním záznamem, tedy například https://localhost:5434/c/testovaci/faktura-vydana/480.xml
  • lze použít pouze nad aktuálním obdobím

Formát očekávaných dat je vždy shodný s formátem odpovědi.

Určení je buďto v hlavičce elementem Content-Type nebo v příponě URL:

       

Podrobnější informace o HTTP operacích naleznete v naší dokumentaci: Podporované HTTP operace

Pomohl Vám tento článek?