Webová služba Settings verze 3.0.0 (Obecné webové služby) - popis rozhraní služby

Vygenerováno z verze 4.21.0.19.0.

Podmínky omezující zveřejnění

Autorem tohoto dokumentu je společnost MARBES CONSULTING s.r.o. Dokument obsahuje informace důvěrného charakteru a ve smyslu definice autorského práva (viz § 2, odst. 1 Zákona č. 121/2000 Sb., zákon o právu autorském) je duševním vlastnictvím autora a předmětem práva autorského. Dokument smí být použit výhradně za účelem, za kterým byl poskytnut a nesmí být bez předchozího souhlasu autora citován, kopírován, vytěžován1 nebo předán třetí fyzické či právnické osobě.

© 2009 MARBES CONSULTING s.r.o.

1 Vytěžováním se podle zákona č. 121/2000 Sb. rozumí trvalý nebo dočasný přepis celého obsahu nebo jeho podstatné části na jiný podklad, a to jakýmikoli prostředky nebo jakýmkoli způsobem.


Obsah


Obecné informace

Rozhraní pro načítání nastavení pomocí webových služeb.

Vysvětlení pojmů

Stránkování

Pokud metoda vrací seznam objektů, může být výsledný vracený seznam stránkovaný. Informaci o stránkování obsahuje atribut paging, ve kterém se nachází i informace, zda server uchovává další data (existuje další stránka). Vychozí velikost jedné stránky je 500 záznamů. Objekt paging obsahuje identifikátor seznamu dat (lid) a ten je nutné předat do metody, která načte další stránku (typický název metody je getNextXxx).

Důležité upozornění

Při načítání stránkovaného seznamu nemusí vždy odpovídat počet vrácených záznamů parametru totalCount, který je uveden v objektu paging. Toto se projeví pouze v případě, že jsou během stránkovaného načítání některé vracené objekty z EOS odstraněny.

Filtrování

Některé metody podporují filtrování dat, např. načtení seznamu aplikací. Filtr se předává formou řetězce, ve kterém je zapsána podmínka. Podmínku lze použít POUZE na základní atributy vracených objektů. Podmínku nelze tedy použít na další vnořené hodnoty, např. kontakty osoby. Pro tento účel existují samostatné metody.

Možnosti filtrování

Podmínky u filtrů je možné sestavovat pouze stylem ATRIBUT OPERÁTOR HODNOTA, nelze tedy např. porovnávat dva atributy navzájem. Řetězcová hodnota se VŽDY uvádí v apostrofech (jinak bude chybně chápána jako název atributu a bude vyhozena chyba), pokud hodnota obsahuje apostrof, musí být znak zapsán jako dva apostrofy ''. U operátorů like a ilike je možné použít znak %, který nahrazuje žádný nebo libovolný počet znaků. Znak % lze používat pouze na začátku a konci hodnoty. Pokud je potřeba zapsat hodnotu null, je zapsána bez uvozovek. Datum je nutné zapsat ve formátu: dd.MM.yyyy HH:mm:ss.SSS nebo zkráceně bez času dd.MM.yyyy. Pro boolean hodnoty se uvádí hodnota 'true' nebo 1 pro true a 'false' nebo 0 pro false, textové reprezentace musí být uvedeny v apostrofech.

Podmínky jsou omezeny na počet porovnávaných hodnot. U výrazu jmeno = 'petr' and id in ('1', '2', '3') je počet podmínek 4. Maximální bezpečný počet je 1000, ale EOS toto nijak nekontroluje. Při použití vyššího počtu může, ale nemusí dotaz projít. Toto je z důvodu, že EOS do některých dotazů přidává vlastní podmínky a tudíž se může stát, že bude překročen limit DB serveru na velikost podmínky.

Operátory

Operandy

Příklad filtru

Příklad zapsání filtru na osoby, jejichž uživatelské jméno je "kolomaznik" a titul začíná na 'i': username = "kolomaznik" and degreeBefore ilike 'i%'


Seznam poskytovaných metod

Název Popis
getEmailSettings Vrací emailové nastavení aplikace EOS.
getEosSettings Vrací nastavení aplikace EOS.
getSecuritySettings Vrací nastavení zabezpečení aplikace EOS.

Seznam struktur dat

Název Popis
EosEmailSettings WO objekt obsahující informace o emailovém nastavení v EOS.
EosEosSettings WO objekt obsahující informace o nastavení v EOS.
EosSecuritySettings WO objekt obsahující informace o nastavení zabezpečení v EOS.

Výjimky

EosInternalException

Reprezentuje neočekávanou výjimku při volání webových služeb.

EosSessionNotFoundException

Session s předaným id nebyla nalezena.


Popis poskytovaných metod

getEmailSettings

Vrací emailové nastavení aplikace EOS.

Předpis

EosEmailSettings getEmailSettings (String sid)

Parametry

Parametr Typ Povinný Popis
sid String Ne session id

Výstup

EosEmailSettings - emailové nastavení

Výjimky

EosSessionNotFoundException - neexistuje session
EosInternalException - vniřní chyba

getEosSettings

Vrací nastavení aplikace EOS.

Předpis

EosEosSettings getEosSettings (String sid)

Parametry

Parametr Typ Povinný Popis
sid String Ne session id

Výstup

EosEosSettings -

Výjimky

EosSessionNotFoundException - Session s předaným id nebyla nalezena.


EosInternalException - Reprezentuje neočekávanou výjimku při volání webových služeb.


getSecuritySettings

Vrací nastavení zabezpečení aplikace EOS.

Předpis

EosSecuritySettings getSecuritySettings (String sid)

Parametry

Parametr Typ Povinný Popis
sid String Ne session id

Výstup

EosSecuritySettings - nastavení zabezpečení

Výjimky

EosSessionNotFoundException - neexistuje session
EosInternalException - vniřní chyba

Popis struktur dat

EosEmailSettings

WO objekt obsahující informace o emailovém nastavení v EOS.

Jméno atributu Datový typ Povinné Popis
protocol String Ne Protokol.
host String Ne Host.
port Integer Ne Port.
username String Ne Uživatelské jméno.
password String Ne Heslo.
defaultEncoding String Ne Implicitní kódování.
smtpAuth Boolean Ne Autektizace.
smtpStartTls Boolean Ne TLS.
mailSender String Ne Odesílatel emailu.

EosEosSettings

WO objekt obsahující informace o nastavení v EOS.

Jméno atributu Datový typ Povinné Popis
eosLoaderApplicationLogging Boolean Ne Příznak zda má EOS Loader logovat spouštění aplikací.

EosSecuritySettings

WO objekt obsahující informace o nastavení zabezpečení v EOS.

Jméno atributu Datový typ Povinné Popis
eosLoaderUserPasswordChangeCheckRequired Boolean Ne Příznak zda má EOS Loader kontrolovat požadavek na změnu hesla uživatele.