Podporované HTTP Operace

Přečtení záznamu

Data lze přečíst pomocí metody GET. Je zohledňován výstupní formát.

Mazání záznamu

Mazat lze pouze jednotlivé záznamy a to pomocí jejich detailového URL (tj. obsahují identifikátor). Více záznamů současně lze smazat pouze použitím akcí při běžné aktualizaci (viz níže).

Pokud záznam neexistuje, je vrácen kód 404. Pokud se záznam podařilo smazat, je vrácen kód 200.

Vytvoření/aktualizace záznamu

FlexiBee nerozlišuje operace POST a PUT. Význam tedy vždy závisí na cílové adrese (URL) a na obsahu, který je zaslán. Pokud ukládáme záznamy na adresu výpisu evidence, jsou záznamy buď přidány nebo aktualizovány podle toho, zda byl nalezen identifikátor.

Pokud provedu operaci na detail záznamu, nemusí zpráva obsahovat již žádný identifikátor a je vzat identifikátor z URL.

Záznam, který modifikuji pomocí detailového URL, musí vždy existovat.

Pomocí výpisového URL mohu modifikovat současně více záznamů. Pokud mají záznamy uvedený identifikátor přidělovaný FlexiBee, musí existovat. Pokud obsahují jako identifikaci např. externí ID, budou záznamy, které nejsou ve FlexiBee dostupné, vytvořeny.

Poznámka: v případě metody POST se očekávají data ve formátu XML nebo JSON a nikoliv jako formulářová data (multipart/form-data).

Volba formátu při vytváření záznamu

Formát, v jakém jsou očekávána data a v jakém je odpověď, jsou vždy shodné a nelze je kombinovat. Vstupní formát je určen buď podle hlavičky Content-Type nebo podle přípony v URL.

Identifikátor nového záznamu

Identifikátor vytvořeného dokladu je předán několika způsoby (více viz podporované HTTP operace):

  • HTTP Hlavičkou Location: https://demo.flexibee.eu:5434/c/demo/faktura-vydana/105
  • Součást odpovědi ve formátu FlexiBee XML:
    <winstrom version="1.0">
      <success>true</success>
      <result>
        <id>105</id>
      </result>
    </winstrom>