Požadavek save-settings
Uložení blokových xml dat nastavení.
<request>
<save-settings
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}"
delete="{boolean}"
>
<{element} ... > ... </{element}>!
</save-settings>
</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)
delete - Výmaz xml - Hodnota true znamená požadavek na výmaz daného XML s nastaveními z databáze.(typ: boolean) TYP HODNOTY: boolean;
Potomci
Požadavek save-settings umožňuje uvést právě jeden povinný element: XML nastavení - Ukládaný uzel s xml nastaveními. Nejčastěji uzel table-file.
Odpověď
Struktura odpovědi na požadavek save-settings vrácená v obálce response:
<response>
<element
type="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}"
descr="{string}"
/>
</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)
descr - Popis zamčení - Detailnější vysvětlení k zámku položky.(typ: string) TYP HODNOTY: string;
Potomci
Odpověď element neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty.
Výraz pro identifikaci chyb v odpovědi serveru: save-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ů.