flexideo

Požadavek register-list

Seznam registrovaných požadavků.

Tento požadavek slouží k vypsání registrovaných požadavků.

syntax 
<request>
<register-list
type="{string}"
uid="{number}"
ref="{time}"
full="{boolean}"
deleted="{boolean}"
/>
</request>

Atributy

type - Název registrace - Filtruje výsledky podle podle zadaného typu - umožňuje využívat db wildcard znaky (_%)(typ: string)

uid - Id uživatele požadavku - Id uživatele pod nímž požadavek poběží. Určuje, zda filtrovat výsledky dle id užvatele, tento atribut ma smysl pouze pro administrátora, ostatní mohou zobrazit pouze svoje registrace(typ: number) TYP HODNOTY: number;

ref - Hexa ID registru - Filtruje výsledky podle refID, refID je primární klíč, takže pokud je zadáno může být vrácen nanejvýš jeden výsledek.(typ: time) TYP HODNOTY: time;

full - Vracet i samotný požadavek - Určuje, zda vracet i registrovaný požadavek (vlastní obsah požadavku)(typ: boolean) TYP HODNOTY: boolean;

deleted - Vracet i odstraněné - Určuje, zda do výsledků zahrnout i smazané registrace, jeho syntaxe je poněkud netransparentní, proto věnujte pozornost níže.(typ: boolean) TYP HODNOTY: boolean;


Potomci

Požadavek register-list neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty.


Poznámka k request

Atributy type, uid a ref slouží k filtrování. Pokud uvedeny nejsou, tak se dle nich nefiltruje. Atribut deleted rozšiřuje

Popis nastavení atributu deleted, který určuje, zda do výsledků zahrnout i smazané registrace. Jeho syntaxe je poněkud netransparentní, proto věnujte pozornost popisu významu jeho hodnot:

true - do výsledků budou zahrnuty jak smazané, tak nesmazané registrace;

false - do výsedků budou zahrnuty pouze smazané registrace;

atribut není uveden - do výsledků budou zahrnuty pouze nesmazané registrace;

Atribut deleted umožňuje zobrazit i jen smazané registrace.

Atribut status tagu register-list má vždy hodnotu ok. Každý tag setting reprezentuje jeden požadavek seznamu. Je-li atribut full="true" pak je v těle každého tagu setting uveden registrovaný požadavek.


Odpověď

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

syntax 
<response>
<register-list
status="ok|error"
>
<register ... /> ?
</register-list>
</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


Uzel register

syntax 
<register
ref="{string}"
parameters="{string}"
deleted="{boolean}"
/>

Atributy

ref - Hexa ID registru - Hexadecimální kód - refID, slouží pro vyvolání požadavku pomocí HTTP GET.

parameters - Parametry registrace - Čárkami oddělený seznam parametrů registrovaného požadavku.(typ: string) TYP HODNOTY: string;

deleted - Odstraněný registr - Indikuje smazané registrace, obsahuje datum a čas smazání požadavku, není-li uveden registrace je platná.(typ: boolean) TYP HODNOTY: boolean;


Potomci

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

Výraz pro identifikaci chyb v odpovědi serveru: register-list[@status='error' or error] (odkaz na popis detailu: @detail).


Poznámka k response

Indikace deleted - datum a čas smazání požadavku, není-li uveden registrace je platná

K mazání registrací nedochází okamžitě, může tedy nastat situace, kdy jako nesmazaná bude ukázána registrace, která má zbývající počet použití, atribut count="0" nebo její hodnota atributu till je menší než aktuální datu a čas. Tato situace je v pořádku a nemá vliv na řádné vyhodnocování těchto atributů. Výmaz je pouze "úklidem". Opět viz Registrované požadavky.


Další info

Viz. též příklad register-list.

Požadavek registerPožadavek register-listPožadavek register-delPožadavek perform-register