VÝBĚR Z OBLASTI
Základní možnosti
Příklady požadavků
- Identifikace chyb při ukládání XML dokumentů
- Identifikace chyb při ukládání XML dokumentů
- Příklad požadavků na pseudo-dokumenty
- Ukládání pseudo dokumentů
- Evidence historie změn dokumentů
- Příklad pro rozpracované dokuementy
- Přímé SQL dotazy do databáze
- Příklady práce se soubory
- Příklad XML nastavení
- Příklad seznamu naplánovaných úloh
- Příklad naplánování úlohy
- Příklad odložení požadavku do-request
- Požadavek register
- Požadavek register-list
- Požadavek register-del
- Příklad transform
- Příklad spuštění akce
- Příklad spouštění akcí pomocí zpráv
Protokol požadavků
Akce jako služby, URIs
Instalace krok za krokem
Požadavek get-settings
Získat bloková data xml nastavení.
<request><get-settingstype="user-root|corporate-root|public-root|user-table|shared-table|corporate-table|public-table|comex.table|comex.table.header|comex.table.data|comex.table.settings"user="{number}"tb-id="{number}"lock="{boolean}"envelope="{boolean}"/></request>
Atributy
type - Typ nastavení - Název typu (oblasti) nastavení pro jeho identifikaci v databázi.(typ: string) (možnosti obsahu: user-root | corporate-root | public-root | user-table | shared-table | corporate-table | public-table | comex.table | comex.table.header | comex.table.data | comex.table.settings)
user - číslo uživatele - User ID pro správnou identifikaci souboru nastavení (statistiky).(typ: number)
tb-id - Jedinečný celočíselný identifikátor položky.(typ: number)
lock - Zámek položky - Neuvedení atributu ponechá původní polohu, hodnota true položku zamkne, false naopak zase položku odemkne, pokud je použito stejným uživatelem, který zámek nastavil.(typ: boolean)
envelope - Vracet v obálce - Při aktivaci této volby bude výsledek (obsah xml nastavení z databáze) vracen v obálce «get-settings» vč. vstupních atributů pro identifikaci odpovědi.(typ: boolean) TYP HODNOTY: boolean;
Potomci
Požadavek get-settings neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty. Uzel nemá povolen prázdný obsah.
Odpověď
Struktura odpovědi na požadavek get-settings vrácená v obálce response:
<response><get-settingstype="ok|error"setting-type="user-root|corporate-root|public-root|user-table|shared-table|corporate-table|public-table|comex.table|comex.table.header|comex.table.data|comex.table.settings"user="{number}"tb-id="{number}"lock="{boolean}"detail="{string}"><{element} ... > ... </{element}>!</get-settings></response>
Atributy
type - Obsahuje hodnoty ok nebo error (možnosti obsahu: ok | error)
setting-type - Typ nastavení - Název typu (oblasti) nastavení pro jeho identifikaci v databázi.(typ: string) (možnosti obsahu: user-root | corporate-root | public-root | user-table | shared-table | corporate-table | public-table | comex.table | comex.table.header | comex.table.data | comex.table.settings)
user - číslo uživatele - User ID pro správnou identifikaci souboru nastavení (statistiky).(typ: number)
tb-id - Jedinečný celočíselný identifikátor položky.(typ: number)
lock - Zámek položky - Neuvedení atributu ponechá původní polohu, hodnota true položku zamkne, false naopak zase položku odemkne, pokud je použito stejným uživatelem, který zámek nastavil.(typ: boolean)
detail - Upřesnění - Bližší popis vzniklé chyby. Je k dispozici při odpovědi typu 'error'.(typ: string)
Potomci
Odpověď get-settings umožňuje uvést právě jeden povinný element: XML nastavení - Navrácený uzel s xml nastaveními. Nejčastěji uzel table-file, pokud bylo na vsutpu zvoleno @envelope='true'
Informace o zámku na požadované položce settingu.
Struktura odpovědi na požadavek get-settings vrácená v obálce response:
<response><settings-locktype="user-root|corporate-root|public-root|user-table|shared-table|corporate-table|public-table|comex.table|comex.table.header|comex.table.data|comex.table.settings"tb-id="{number}"lock="{boolean}"status="ok|error"descr="{string}"/></response>
Atributy
type - Typ nastavení - Název typu (oblasti) nastavení pro jeho identifikaci v databázi.(typ: string) (možnosti obsahu: user-root | corporate-root | public-root | user-table | shared-table | corporate-table | public-table | comex.table | comex.table.header | comex.table.data | comex.table.settings)
tb-id - Jedinečný celočíselný identifikátor položky.(typ: number)
lock - Zámek položky - Neuvedení atributu ponechá původní polohu, hodnota true položku zamkne, false naopak zase položku odemkne, pokud je použito stejným uživatelem, který zámek nastavil.(typ: boolean)
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ě.
descr - Popis zamčení - Detailnější vysvětlení k zámku položky.(typ: string) TYP HODNOTY: string;
Potomci
Odpověď settings-lock neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty.
Výraz pro identifikaci chyb v odpovědi serveru: get-settings[@type='error'] (odkaz na popis detailu: @descr).
Další info
Více o práci s nastaveními viz. též princip xml nastavení a nebo příklady xml požadavků.