Požadavek get-draft
Účel a dopady
Načte dříve uložený rozpracovaný obsah (draft) volajícího uživatele podle klíče dkey. Požadavek nic nemění, jen čte.
Dostupnost, kontext, oprávnění apod.
Dostupné každému přihlášenému uživateli, vždy jen pro jeho vlastní drafty – server sám dosazuje ID volajícího uživatele; atribut pro cizího uživatele neexistuje.
XML požadavek (syntax + popis)
<request>
<get-draft
dkey="{string}"
/>
</request>
Parametry a pravidla (atributy, potomci)
dkey- Klíč draftu - Klíč, pod kterým byl draft uložen požadavkemsave-draft. (typ:string; nepovinný – chybí-li, předává se prázdný řetězec a draft se s velkou pravděpodobností nenajde)
Požadavek nemá žádné potomky.
Atribut type uváděný v dosavadní dokumentaci se při zpracování požadavku get-draft nečte a na výsledek nemá vliv.
Příklady požadavku
(Zatím bez ověřeného příkladu.)
Zpracování a vedlejší účinky
- Server vyhledá draft podle dvojice (ID přihlášeného uživatele,
dkey) přes uloženou proceduru. Přesný obsah, který byl draft uložen (viz save-draft), se vrací doslovně – server jej při čtení nijak neinterpretuje ani nevaliduje.
XML odpověď (syntax + popis)
<response>
<get-draft
type="ok|error"
user="{number}"
dkey="{string}"
detail="{string}"
>
{doslovný uložený obsah draftu}
</get-draft>
</response>
Příklady odpovědi
(Zatím bez ověřeného příkladu.)
Chyby a reakce
type="error" detail="Nenalezen"– pro dvojici (uživatel,dkey) nebyl nalezen žádný draft.type="error" detail="Pri provadeni doslo k chybe"– selhání při volání databáze.
Atribut chybové odpovědi je detail.
Související požadavky
- save-draft – uložení draftu.
- remove-draft – odstranění draftu.
- get-draft-list – seznam draftů volajícího uživatele.