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

Požadavek register-list

Účel a dopady​

Vrátí seznam registrovaných požadavků (viz register), volitelně filtrovaný podle typu, ref, druhu registrace a stavu smazání. Požadavek nic nemění, jen čte.

Dostupnost, kontext, oprávnění apod.​

  • r_admin bez uvedení uid vidí registrace všech uživatelů; ostatní vidí vždy jen vlastní.
  • Uvedení cizího uid bez r_admin je zamítnuto.

XML požadavek (syntax + popis)​

  <request>
   <register-list
    type="{string}"
    uid="{number}"
    ref="{string}"
    what="{string}"
    full="{bool}"
    deleted="{bool}"
    />
  </request>

Parametry a pravidla (atributy, potomci)​

  • type - Filtr podle názvu registrace - podporuje DB wildcard znaky (_, %). (typ: string; nepovinný)
  • uid - Filtr podle ID uživatele - viz oprávnění výše. (typ: number; nepovinný; výchozí: vlastní ID, u r_admin bez filtru všichni uživatelé)
  • ref - Filtr podle hexadecimálního ref - primární klíč, vrátí nanejvýš jeden záznam. (typ: string; nepovinný) – dosavadní dokumentace chybně uváděla typ time.
  • what - Filtr podle druhu registrace (r|l|q) - v dosavadní dokumentaci zcela chyběl. (typ: string; nepovinný)
  • full - Vrátit i uložený předpis požadavku. (typ: bool; nepovinný; výchozí: false)
  • deleted - Zahrnutí smazaných registrací. (typ: bool; nepovinný) – tři stavy: neuveden = jen nesmazané; "true" = smazané i nesmazané; cokoli jiného (vč. "false") = jen smazané. Přesná filtrace jednotlivých řádků je součástí databázové procedury.

Požadavek nemá žádné potomky.

Příklady požadavku​

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

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

K mazání registrací nedochází okamžitě – výmaz je jen „úklid“; do doby úklidu se smazaná registrace může stále objevit jako nesmazaná (výsledek count/till tím není dotčen).

XML odpověď (syntax + popis)​

  <response>
   <register-list
    status="ok|error"
    detail="{string}"
    >
    <register ... /> *
   </register-list>
  </response>

Uzel register​

Dosavadní dokumentace popisovala jen ref/parameters/deleted. Skutečný tvar odpovědi je mnohem bohatší:

  <register
   ref="{string}"
   what="{string}"
   uid="{number}"
   type="{string}"
   created="{datetime}"
   count="{number}"
   till="{datetime}"
   login="{number}"
   parameters="{string}"
   response="{string}"
   deny-resp="{string}"
   opt-roles="{string}"
   deleted="{datetime}"
   impersonate="{number}"
   redirect-resp="{bool}"
   redirect-deny="{bool}"
   >
   {předpis požadavku, jen je-li full="true"}
  </register>
  • ref - Hexadecimální ref registrace, použitelný pro perform-register/register-del. (typ: string)
  • what - Druh registrace (r|l|q). (typ: string) – v dosavadní dokumentaci chyběl.
  • uid - ID uživatele, pod nímž registrace běží. (typ: number) – v dosavadní dokumentaci chyběl.
  • type - Název registrace zadaný při vytvoření. (typ: string) – v dosavadní dokumentaci chyběl.
  • created - Datum a čas vytvoření registrace. (typ: datetime) – v dosavadní dokumentaci chyběl.
  • count - Zbývající/maximální počet spuštění. (typ: number; přítomen jen je-li nastaven)
  • till - Platnost do. (typ: datetime; přítomen jen je-li nastaven)
  • login - ID uživatele pro přihlášení u login registrace. (typ: number; přítomen jen u what="l" s nastaveným login) – v dosavadní dokumentaci chyběl.
  • parameters - Čárkami oddělený seznam parametrů registrovaného požadavku. (typ: string; přítomen jen je-li nastaven)
  • response - Cesta stránky pro úspěšnou odpověď. (typ: string; přítomen jen je-li nastavena) – v dosavadní dokumentaci chyběl.
  • deny-resp - Cesta stránky pro neúspěšnou odpověď. (typ: string; přítomen jen je-li nastavena) – v dosavadní dokumentaci chyběl.
  • opt-roles - Uložená volitelná role. (typ: string; přítomen jen je-li nastavena) – v dosavadní dokumentaci chyběl.
  • deleted - Datum a čas smazání - přítomen jen u smazaných registrací; neuveden = registrace je platná. (typ: datetime; nepovinný) – dosavadní dokumentace uváděla typ boolean, ve skutečnosti nese datum a čas.
  • impersonate - ID uživatele, který registraci vytvořil v zastoupení (impersonace). (typ: number; přítomen jen je-li relevantní) – v dosavadní dokumentaci chyběl.
  • redirect-resp, redirect-deny - Odraz stejnojmenných atributů požadavku register. (typ: bool) – v dosavadní dokumentaci chyběly.

Je-li požadavek zadán s full="true", element register navíc obsahuje jako text uložený předpis registrovaného požadavku; jinak je sebeuzavírající.

Příklady odpovědi​

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

Chyby a reakce​

  • status="error" detail="Nespravne zadany parametr uid" – neplatná hodnota uid.
  • Nedostatečné oprávnění (cizí uid) má status="error" detail="Nemate patricna opravneni".
  • status="error" detail="Pri provadeni pozadavku doslo k chybe" – selhání na úrovni čtení seznamu; tato větev není sebeuzavírající a může nést vnořené error.

Související požadavky​