Skip to main content

Požadavek admin-unlock

Administrátorské otevření zámku

Nástroj pro administrátorské odemčení obecného zámku general-lock.

  <request>
   <admin-unlock
    id="{number}"
    doc-type="{string}"
    lock="true|false|test"
    timeout="{number}"
    />
  </request>

Atributy​

  • id - Číslo zámku - Celočíselný identifikátor zámku.(typ: number) TYP HODNOTY: number;

  • doc-type - Typový název - Nepovinný řetězcový identifikátor zámku, například název dokumentového typu.(typ: string) TYP HODNOTY: string;

  • lock - Typ operace - Specifikace toho, co má být se zámkem provedeno.(typ: string) TYP HODNOTY: string; Možnosti obsahu: » true ~ Zamknout zámek » false ~ Odemknout zámek » test ~ Jen vrátit aktuální stav

  • timeout - Délka trvání - Atribut nastavuje čas v sekundách, po který se má zámek držet, hodnota 0 znamená nekonečno a je také výchozí hodnotou(typ: number) TYP HODNOTY: number;

Potomci​

Požadavek admin-unlock neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty.

Odpověď​

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

  <response>
   <admin-unlock
    id="{number}"
    doc-type="{string}"
    status="ok|fail|none"
    userid="{number}"
    lock="{string}"
    untiltime="{string}"
    untildate="{string}"
    descr="{string}"
    />
  </response>

Atributy​

  • id - Číslo zámku - Celočíselný identifikátor zámku. Přeneseno z požadavku.(typ: number) TYP HODNOTY: number;

  • doc-type - Typový název - Nepovinný řetězcový identifikátor zámku, například název dokumentového typu. Přeneseno z požadavku.(typ: string) TYP HODNOTY: string;

  • status - Klíčový atribut, který určuje úspěšnost požadavku.(typ: string) TYP HODNOTY: string; Možnosti obsahu: » ok ~ Změna se provedla » fail ~ Změna se nezdařila » none ~ Změna nebyla požadována (test)

  • userid - Číslo autora zámku - Vrací id uživatele, který zamknutí provedl v případě test požadavku, jinak v odpovědi tento atribut vůbec není.(typ: number) TYP HODNOTY: number;

  • lock - Vrací tu hodnotu na níž se mělo zamčení změnit – tedy hodnotu z požadavku. Pokud je »status« odpovědi »ok«, pak je to zároveň i stav zámku.(typ: string) TYP HODNOTY: string;

  • untiltime - Je uveden pouze v případě, že je položka zamčena a na zámek byl nastaven timeout. Pak uvádí čas ve formátu 'h:mm:ss', kdy dojde k expiraci zámku.(typ: string) TYP HODNOTY: string;

  • untildate - Je uveden pouze v případě, že je položka zamčena a na zámek byl nastaven timeout. Pak uvádí datum ve formátu 'yyyy-[m]m-[d]d', kdy dojde k expiraci zámku.(typ: string) TYP HODNOTY: string;

  • descr - Obsahuje popisek chyby nebo průběžné info o aktualizaci timeoutu apod. Nevznikla-li chyba nebo nedošlo k aktualizaci zámku, není »descr« v odpovědi zahrnut.(typ: string) TYP HODNOTY: string;

Potomci​

Odpověď admin-unlock 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: admin-unlock[@type='error'] (odkaz na popis detailu: @descr).

Další info​

Princip obecného zámku viz. požadavek general-lock.