flexideo

Obecná syntaxe požadavků

Bez ohledu na typ klienta, tedy zda se jedná o standardní webové stránky či zda se jedná o specifického klienta naprogramovaného na zakázku v určitém vývojovém prostředí, může klient pro komunikaci se serververem využívat XML obálek zmíněným způsobem.

Kmenový uzel požadavku má vždy stejný tag request:

syntax 
<request [session="nnn"] [target="memory|both"]>
<typ-pozadavku> ... obsah ... </typ-pozadavku>
</request>

Význam atributů je následující:

session - obsahuje identifikační číslo session (viz Příkazy pro práci se seancí). Ve zvláštních případech nemusí být uvedeno, zejména při prvním požadavku nebo pak při anonymních seancích, jinak je ale uvedení session povinné; číslo seance generuje server na základě požadavku na přihlášení uživatele;

target - není-li atribut uveden, pak je řádně odpovězeno, pokud má attribut hodnotu memory, pak je hodnota ulozena do paměti (viz Dočasná data) a klientovi je odpovězeno <saved-to-memory/>. Je-li hodnota both, pak je klientovi poslána odpověď a její kopie je zároveň uložena do paměti.

Odpověď má pak vždy stejný tag response:

<response [session="ok|terminated"]>
<typ-odpovedi> ... obsah ... </typ-odpovedi>
</response>

Význam atributu je následující:

session - obsahuje informaci o tom, zda byla session správně načtena (ok) nebo došlo k jejímu přerušení vlivem nečinnosti (viz Příkazy pro práci se seancí). Pokud není atribut uveden, pak se nepodařilo parsovat požadavek nebo se nezdařilo přihlášení klienta (bližší informaci naleznete mezi tagy response).

Na místo tagů typ-pozadavku se pak vkládají platné názvy skutečných požadavků. Jejich popis je předmětem této kapitoly.

Vzhledem k citlivosti XML na velikost písmen je všude ve jménech řídících tagů a atributů požadavků a odpovědí respektováno pravidlo uvádění výhradně malých znaků. V dalším XML v obsahu požadavků a odpovědí již toto pravidlo platit nemusí a může být použito i velkých znaků (zejm. v rámci práce s nastaveními - viz. podkapitola 'XML nastavení').

Pro stručnost a přehlednost v dalších ukázkách budeme tagy request a response vynechávat.

POZNÁMKA: Chybové hlášky zobrazované v příkladech jsou v českém jazyce. V praxi záleží na podpoře jazyků a jazykovém nastavení uživatele / serveru.

Architektura flexideo serveruKomunikaceObecná syntaxe požadavkůPřihlášení a odhlášení uživateleZápis více požadavků v jedné obálceNastavení plánovače úloh (validity, repeat aj.)Registrované požadavkyStatistikyVerze pro oblasti (hodnoty) intranet a comexNapojení vlastních aplikacíChybová hlášení v odpovědích