Testovací uložení (dry-run)

Když pracujete s REST API a potřebujete zkontrolovat, zda jsou všechna data v pořádku, pokud uživatel změnil nějakou hodnotu, která ovlivňuje jinou (např. typ dokladu a zaúčtování) a nebo potřebujete spočítat výslednou cenu při objednávce, můžete použít režim testovacího uložení.

Při uložení přidejte parameter ?dry-run=true. Výsledkem bude, že se záznam neuloží, ale jen se provedou validace. Navíc získáte v tagu <content /> výslednou reprezentaci záznamu tak, jak by vypadal, kdyby jste jej nyní uložili.

Ukázka výsledného XML:

<?xml version="1.0" encoding="utf-8"?>
<winstrom version="1.0">
  <success>true</success>
  <warnings>
    <warning for="firma">Nebyl určen příjemce a tak nebude doklad zaúčtován.</warning>
  <warnings>
  <result>
    <content>            
      <!-- Doklady faktur -->
      <faktura-vydana>              
        <!-- ID (celé číslo) - -->
        <id>-1</id>               
        <!-- Interní číslo (řetězec) - max. délka: 20 -->
        <kod>00000041/09</kod>                           
        <!-- Variabilní symbol (řetězec) - -->                   
        <varSym>0000004109</varSym>                              
        <!-- Vystaveno (datum) - -->                              
        <datVyst>2009-08-12+02:00</datVyst>                       
        ...
      </faktura-vydana>
    </content>
  </result>
</winstrom>

V tomto případě došlo i k přidělení čísla dokladu. Nicméně číslo bylo hned uvolněno k dalšímu použití a tak je možné, že při skutečném uložení získá dokument jiné číslo. Je zde také ukázka validačního upozornění.

Výstup je možné zpracovávat také ve formátu JSON.