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

Požadavek soap-services

Účel a dopady​

Vrátí seznam webových služeb (akcí) aktuálně načtených v paměti serveru. Požadavek nic nemění, jen čte.

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

Smí použít jen uživatel s r_admin nebo r_manage; jinak je požadavek zamítnut.

XML požadavek (syntax + popis)​

  <request>
   <soap-services/>
  </request>

Požadavek nemá žádné atributy ani potomky.

Parametry a pravidla (atributy, potomci)​

Požadavek soap-services nemá žádné atributy ani potomky.

Příklady požadavku​

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

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

Server projde interní tabulku aktuálně načtených SOAP služeb a pro každou vypíše její informační uzel service. Webové služby se do paměti načítají při jejich prvním spuštění přes SOAP bránu; k jejich uvolnění z paměti dojde při ukončení serveru nebo požadavkem unload-soap. Popis webových služeb viz webové služby flexideo.

XML odpověď (syntax + popis)​

  <response>
   <soap-services
    type="ok"
    >
    <service
     name="{string}"
     folder="{string}"
     author="{number}"
     version="{string}"
     label="{string}"
     notes="{string}"
     /> *
   </soap-services>
  </response>

Parametry a pravidla (atributy, potomci) – uzel service​

  • name - Název načtené služby - Název akce dle registru akcí, pod nímž je služba v paměti evidovaná. (typ: string; vždy přítomen)
  • folder - Podsložka akce - Název podsložky, ze které byla služba jako akce načtena. (typ: string; vždy přítomen)
  • author - Autor akce - Číslo uživatele vedeného jako autor akce v registru akcí. (typ: number; vždy přítomen)
  • version - Kód verze (buildu) - Kód sestavení načtené akce. (typ: string; přítomen jen je-li nastaven)
  • label - Štítek akce - Název akce zobrazovaný uživateli. (typ: string; přítomen jen je-li nastaven)
  • notes - Popis akce - Popis činnosti akce zobrazovaný uživateli. (typ: string; přítomen jen je-li nastaven)

Pořadí atributů v odpovědi je pevné: name, folder, author, a dále jen ty z version/label/notes, které jsou u dané služby vyplněné.

Příklady odpovědi​

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

Chyby a reakce​

  • <soap-services status="error" detail="Nemate patricna opravneni"/> – volající nemá r_admin ani r_manage.
  • Jiná chybová větev pro tento požadavek neexistuje – jde jen o čtení interní paměťové tabulky. Výraz pro identifikaci chyb v odpovědi serveru: soap-services[@status='error'].

Související požadavky​

  • unload-soap – uvolní jednu nebo všechny takto vypsané služby z paměti.