flexideo

Požadavek save-draft

Uložení xml jako rozpracovaného.

syntax 
<request>
<save-draft
type="{string}"
dkey="{string}"
label="{string}"
type-label="{string}"
user="{number}"
>
<document-set ... /> ?
</save-draft>
</request>

Atributy

type - typ dokumentu - Typový název dokumentu definovaného v XDS.(typ: string)

dkey - klíč dokumentu - Celočíselný klíč dokumentu nebo řetězec se znakem '#' pro nové instance.(typ: string)

label - štítek - Orientační a uživatelská název (label).(typ: string)

type-label - Typový název - Syntaxe: '{type-label}|{icon}|~~~1'; Např. Smlouva|document.png|~~~1; type-label = label typu dokumentu tak, jak je zapsán v XDS;(typ: string) TYP HODNOTY: string;

user - Pdk uživatele - popis neuveden(typ: number) TYP HODNOTY: number;


Potomci


Uzel document-set

Obálka rozpracovaného dokumentu.

syntax 
<document-set>
<{element} ... > ... </{element}>*
|
<{fxd-doc-type} dkey="{key}">...</{fxd-doc-type}>
</document-set>

Atributy

Uzel document-set neobsahuje žádné atributy.


Potomci

Uzel document-set umožňuje uvést nepovinný, ale opakovatelný element: Jiné XML k odložení - Uzel, který nemusí reprezentovat flexideo dokument a draft tak může být použit i pro rozpracování jiných xml, než-li jsou flexideo dokumenty. a nebo umožňuje vložit jeden uzel flexideo dokument struktury.


Odpověď

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

syntax 
<response>
<element
type="ok|error"
user="{number}"
dkey="{string}"
detail="{string}"
/>
</response>

Atributy

type - Obsahuje hodnoty ok nebo error (možnosti obsahu: ok | error)

user - číslo uživatele - User ID pro správnou identifikaci souboru nastavení (statistiky).(typ: number)

dkey - klíč dokumentu - Celočíselný klíč dokumentu nebo řetězec se znakem '#' pro nové instance.(typ: string)

detail - Upřesnění - Bližší popis vzniklé chyby. Je k dispozici při odpovědi typu 'error'.(typ: string)


Potomci

Odpověď element neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty. Uzel nemá povolen prázdný obsah.

Výraz pro identifikaci chyb v odpovědi serveru: get-draft[@type='error'] (odkaz na popis detailu: @detail).

Požadavek sql-queryPožadavek get-draft-listPožadavek save-draftPožadavek get-draftPožadavek remove-draftPožadavek get-settingsPožadavek save-settings