flexideo

Požadavek remove-document

Slouží k fyzickému odstranění dokumentu z obou databází

Požadavek remove-document fyzicky odstraní dokument z obou databází (aktuální i historické).

syntax 
<request>
<remove-document
test="true|only|false"
test-where="{string}"
>
<pdk-list ... /> ?
</remove-document>
</request>

Atributy

test - Indikuje testovací režim požadavku - Před každým výmazem proveden test. S touto volbou je požadavek stále transační(typ: string)

TYP HODNOTY: string;

Možnosti obsahu:

» true ~ Před výmazem proveden test. I s volbou test='true' je požadavek stále transakční.

» only ~ S touto hodnotou je proveden pouze test bez skutečného výmazu.

» false ~ Test nebude probíhat (výchozí hodnota).

test-where - Upřesnění režimu test požadavku - Určuje proti jaké databázi testovat existenci referencí. Tento atribut má smysl pouze pokud atribut test je nastaven na hodnotu only.


Potomci


Uzel pdk-list

Popis uzlu pdk-list, který je potomkem uzlu remove-document je umístěn v popisu typových uzlů.

Bližší popis viz. pdk-list.


Odpověď

Struktura odpovědi na požadavek remove-document vrácená v obálce response:

syntax 
<response>
<element
status="ok|error"
/>
</response>

Atributy

status - Obsahuje hodnoty ok nebo error

Možnosti obsahu:

» ok ~ Požadavek proveden bez chyb.

» error ~ Při provádění požadavku došlo k chybě.


Potomci

Odpověď element neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty.


Další info

V případě databázové chyby, jsou v těle tagu document přítomny tagy error (viz. tag error) s popisem chyby nebo chyb.

Požadavek get-documentPožadavek save-documentPožadavek get-pseudo-documentPožadavek save-pseudo-documentPožadavek get-historyPožadavek erase-documentPožadavek remove-documentPožadavek set-metadata