flexideo

Požadavek perform-register

Volání registrovaného požadavku

Tento požadavek slouží k volání registrovaného požadavku. Viz kapitola Registrované požadavky.

syntax 
<request>
<perform-register
id="{number}"
>
<param ... {string}</param> ?
</perform-register>
</request>

Atributy

id - Jedinečný celočíselný identifikátor položky.(typ: number)


Potomci


Uzel param

Název parametru

Jde o uzel obsahující text TYP HODNOTY: string;

syntax 
<param
value="{string}"
>
 {string} 
</param>

Atributy

value - Hodnota parametru registrace.(typ: string) TYP HODNOTY: string;


Potomci

Uzel param neobsahuje žádné další elementy. Uzel může obsahovat prostý text.


Poznámka k request

Typy registrací

Query registrace:

Pomocí požadavku perform-register mohou být volány pouze registrace typu q (query).

Běžné (GET) registrace:

Registrace typu r (běžný register určený pro GET volání) může pomocí požadavku perform-register volat pouze člen skupiny admin. Stejně, jako u q požadavků, je mu vrácena odpověď na provedený požadavek. Toto chování slouží čistě k testovacím účelům a nemělo by být využíváno v produkčním prostředí.

Login registrace:

Požadavek perform-register rovněž podporuje spouštění registrací typu l (login). Při spustění takové registrace dojde k odhlášení stávajícího uživatele a jeho opětovnému přihlášení účtem login registrace. Stávající session uživatele je ukončena a je mu automaticky založena nová. Pod novým přihlášení jsou provedeny všechny následné požadavky v rámci aktuální skupiny a i nadále zůstane uživatel přihlášen pod novým účtem. Dojde tedy k plnému přepřihlášení stávajícího uživatele na uživatele nového. Požadavek perform-register rovněž podporuje zvláštní případ login registrací, kdy je při prvním volání uživatel nejprve vytvořen. I v těchto případech se perform-register chová obdobně, jako GET registrace. Při prvním přihlášení je nový uživatel vytvořen, následně je pouze přihlašován. Nedochází tedy k vytváření dalších uživatelů. Jedinný rozdíl v chování mezi GET voláním login registrace a voláním prostřednictvím požadavku perform-register spočívá v tom, že při volání požadavkem perform-register je uživateli automaticky založena session.

!!!Volání pomocí požadavku perform-register dodržuje pravidla platnosti registrovaných požadavků (maximální počet volání, časovou platnost). Tato pravidla jsou dodržena i při volání uživatelem ze skupiny admin (i u testovacích volání GET registrací) a nelze je nijak obejít.!!!


Odpověď

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

syntax 
<response>
<perform-register
status="ok|error"
new-user="{string}"
login="{string}"
session="{number}"
/>
</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ě.

new-user - id (pdk) nově vytvořeného uživatele, v případě vytvoření login registrací(typ: string) TYP HODNOTY: string;

login - id (pdk) nově přihlášeného uživatele, v případě změny přihlášení login registrace(typ: string) TYP HODNOTY: string;

session - Číslo nově zahájené session, v případě změny přihlášení login registrace.(typ: number) TYP HODNOTY: number;


Potomci

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

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


Poznámka k response

V případě databázové chyby, jsou v těle tagu přítomny tagy error (viz tag error) s popisem databázové chyby (chyb). V případě chyby v registrovaném požadavku, je v těle přítomna chybová odpověď na tento požadavek (bez úvodního tagu response). V případě nemožnosti přihlásit nově vytvořeného uživatele je v těle tagu odpověď na na požadavek na řízení uživatele (bez úvodního tagu response).

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