Přejít na obsah
Flexideo
Skip to main content

Požadavek remove-draft

Účel a dopady​

Trvale odstraní draft volajícího uživatele podle klíče dkey a invaliduje jeho cachovaný seznam draftů.

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.

XML požadavek (syntax + popis)​

  <request>
   <remove-draft
    dkey="{string}"
    />
  </request>

Parametry a pravidla (atributy, potomci)​

  • dkey - Klíč draftu - Klíč, pod kterým byl draft uložen požadavkem save-draft. (typ: string; nepovinný – chybí-li, předává se prázdný řetězec a výmaz s velkou pravděpodobností selže)

Požadavek nemá žádné potomky. Atribut type uváděný v dosavadní dokumentaci se při zpracování požadavku nečte.

Příklady požadavku​

(Zatím bez ověřeného příkladu.)

Zpracování a vedlejší účinky​

Server zavolá uloženou proceduru pro výmaz podle dvojice (ID přihlášeného uživatele, dkey) a při úspěchu invaliduje cache seznamu draftů daného uživatele.

XML odpověď (syntax + popis)​

  <response>
   <remove-draft
    type="ok|error"
    user="{number}"
    dkey="{string}"
    descr="{string}"
    />
  </response>

Příklady odpovědi​

(Zatím bez ověřeného příkladu.)

Chyby a reakce​

  • type="error" descr="Vymaz se nezdaril" – uložená procedura vrátila neúspěch, např. draft s daným dkey neexistuje.
  • type="error" descr="Pri provadeni doslo k chybe" – selhání na úrovni volání databáze; v této větvi navíc atribut dkey v odpovědi nemusí odpovídat požadovanému klíči, protože jej server v této konkrétní chybové větvi před výpisem nenaplňuje.

Atribut chybové odpovědi je descr.

Související požadavky​