Realizácia podujatí

Vykonávanie akcií v rozhraní REST API

Ota Rádl avatar
Written by Ota Rádl
Updated over a week ago

Pri importe môžete namiesto vytvorenia alebo zmeny záznamu vykonať inú činnosť, napríklad vymazanie alebo zrušenie dokumentu. Na tento účel sa používa atribút action:

<?xml version="1.0"?>
<winstrom version="1.0">
  <invoice-issue action="delete">
    <id>123</id>
    <id>uid:123456</id>
  </invoice-issue>
</winstrom>

Akcia

Popis

Odstrániť
(delete)

Záznam sa vymaže.

Zrušiť
(cancellation)

Záznam sa zruší. Môže sa použiť len na dokumenty.

Záznamy sa pri vykonávaní akcií inak nemenia, preto nemá zmysel uvádzať iné prvky ako id. Záznamy musia zároveň už existovať, napr. nie je možné vytvoriť novú vymazanú faktúru.

Akcie na položkách

Akcie možno vyvolať aj na položkách dokumentu. Len nie priamo, ale rovnako ako pri aktualizácii je potrebné podať žiadosť prostredníctvom kolekcie položiek na príslušnom doklade.

Príklad na odstránenie položky s ID rovnajúcim sa 456 vo formáte XML a JSON:

<?xml version="1.0"?>
null
Did this answer your question?