flexideo

Požadavek register

Registrace požadavku

Tento požadavek slouží k vytvoření registrovaného požadavku.

V těle tagu jsou uvedeny požadavky, které mají být registrovány. Požadavky mohou a nemusí být zabaleny do tagu request, nebo může být uvedeno přímo jeden nebo více běžných požadavků více požadavků. Viz příklad níže. V registrovaných požadavcích lze používat parametry. Parametry se vkládají tak, že jeho název je uzavřen v hranatých závorkách [] - viz příklad níže. V názvu parametru jsou povoleny alfanumerické znaky, dále znaky ".-_#", název nesmí být delší než 8 znaků - viz: Registrované požadavky

Zvláštním případem kombinace atributů jsou případy login registrací, kdy je uživatel požadavkem zároveň vytvářen. K této situaci dojde, když se jedná o login registraci (what="l"), ale není uveden atribut login. Místo něj je poslán běžný požadavek, jako u normální registrace a ten je proveden pod uživatelem uid, nebo uživatelem, který registraci vytvořil. Z jeho výstupu je získán nově vytvořený uživatel a tímto jen odesilatel požadavku následně přihlášen. Pokud je registrace volána opětovně, uživatel je již hlášen dříve zřízeným uživatelem (nedochází k vytváření dalších uživatelů). Požadavky pro zřízení uživatelů mohou přijímat parametry stejně, jako běžné registrované požadavky. Význam stránek pro odpověď je shodný s běžnými registracemi, uživatel je na ně přesměrován v případě úspěchu (response) či neúspěchu (deny-resp).

Základní typ(y) uzlu(ů): registerReq;

syntax 
<request>
<register
type="{string}"
count="{number}"
till="{time}"
uid="{number}"
response="{string}"
what="{string}"
login="{string}"
opt-roles="{number}"
deny-resp="{string}"
/>
<{element} ... > ... </{element}>?
</request>

Atributy

type - Název registrace - Povinný atribut se zcela volitelným obsahem, slouží k pozdější identifikaci.(typ: string)

count - Maximální počet spuštění - Maximální možný počet spuštění požadavku, není-li atribut uveden nebo je roven 0, lze jej spouštět nekonečněkrát(typ: number) TYP HODNOTY: number;

till - Platné do - Datum a čas platnosti 'do' - časová hodnota konce platnosti registrace v syntaxi YYYY-MM-DD[Thh-mm-ss].(typ: time) TYP HODNOTY: time;

uid - Id uživatele požadavku - Id uživatele pod nímž požadavek poběží. Určuje id uživatele pod nímž bude registrovaný požadavek vykonán, nastavit někoho jiného než sebe muže pouze admin, není-li atribut uveden, bude požadavek vykonán pod id přihlášeného uživatele(typ: number) TYP HODNOTY: number;

response - Název stránky s odpovědí - Název stránky, která má být vrácena po vykonání registrovaného požadavku, jedná se o absolutní cestu, kde na začátku není uvedeno lomítko, v úvahu se samozřejmě berou virtuální adresáře i nice URL, za otazníkem mohou být umístěny další parametry(typ: string) TYP HODNOTY: string;

what - Druh registrace - Určuje druh registrace r - registrovaný požadavek, l - login, q - query registrovaný požadavek, výchozí je r - registrovaný požadavek.(typ: string) TYP HODNOTY: string;

login - Login registrace - Platný pouze pro login registraci (what= „1“), určuje pod jakým uživatelským účtem proběhne přihlášení.(typ: string) TYP HODNOTY: string;

opt-roles - Optimální role - popis neuveden(typ: number) TYP HODNOTY: number;

deny-resp - Název vrácené stránky v případě selhání požadavku - název stránky, která má být vrácena v případě selhání registrovaného požadavku, jedná se o absolutní cestu, kde na začátku není uvedeno lomítko, v úvahu se samozřejmě berou virtuální adresáře i nice URL, za otazníkem mohou být umístěny další parametry.(typ: string) TYP HODNOTY: string;


Potomci

Požadavek register umožňuje uvést jeden volitelný element: Uzel request požadavku


Odpověď

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

syntax 
<response>
<register
status="ok|error"
ref="{string}"
register-type="{string}"
/>
</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ě.

ref - Hexa ID registru - V atributu je vrácen hexadecimální kód - refID, které pak může být použito k provedení registrovaného požadavku.

register-type - Název registrace - Hodnota převzatá z atributu type odpovídajícího požadavku na registraci - slouží pro identifikaci v seznamu odpovědí při hromadné registraci více požadavků v jedné obálce.(typ: string)


Potomci

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

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


Další info

Viz. též příklad register.

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