Webová služba Organization 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í umožňuje načítat informace o organizacích.

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
findOrganizationByUserId Načtení organizace podle identifikátoru uživatele.
findOrganizationByUserNameAndDomain Načtení organizace podle uživatelského jména a domény.
getAllOrganizations Načtení seznamu organizací.
getOrganizationById Načtení organizace podle identifikátoru organizace.
getOrganizationsConnectWithApp Vrací seznam všech organizací, ke kterým je přiřazena aplikace.

Seznam struktur dat

Název Popis
EosOrganization Reprezentuje organizaci.
EosOrganizations Reprezentuje kolekci organizací.

Výjimky

EosInternalException

Neočekávaná výjimka při volání webových služeb.

EosObjectNotFoundException

Objekt nebyl nalezen.

Popis poskytovaných metod

findOrganizationByUserId

Načtení organizace podle identifikátoru uživatele.

Předpis

EosOrganization findOrganizationByUserId (String userId)

Parametry

Parametr Typ Povinný Popis
userId String Ano identifikátor uživatele

Výstup

EosOrganization - organizace nebo null

Výjimky

EosInternalException - vnitřní chyba
EosObjectNotFoundException - pokud uživatel s daným identifikátorem nebyl nalezen

findOrganizationByUserNameAndDomain

Načtení organizace podle uživatelského jména a domény.

Předpis

EosOrganization findOrganizationByUserNameAndDomain (String userName, String domainName)

Parametry

Parametr Typ Povinný Popis
userName String Ano uživatelské jméno
domainName String Ne název domény

Výstup

EosOrganization - organizace nebo null

Výjimky

EosInternalException - vnitřní chyba

getAllOrganizations

Načtení seznamu organizací.

Předpis

EosOrganizations getAllOrganizations ()

Parametry

Parametr Typ Povinný Popis

Výstup

EosOrganizations - seznam organizací

Výjimky

EosInternalException - vniřní chyba

getOrganizationById

Načtení organizace podle identifikátoru organizace.

Předpis

EosOrganization getOrganizationById (String orgId)

Parametry

Parametr Typ Povinný Popis
orgId String Ano identifikátor organizace

Výstup

EosOrganization - organizace

Výjimky

EosInternalException - vnitřní chyba
EosObjectNotFoundException - pokud organizace s daným identifikátorem nebyl nalezen

getOrganizationsConnectWithApp

Vrací seznam všech organizací, ke kterým je přiřazena aplikace.

Předpis

EosOrganizations getOrganizationsConnectWithApp (String applicationId)

Parametry

Parametr Typ Povinný Popis
applicationId String Ano identifikátor aplikace

Výstup

EosOrganizations - seznam organizací, ke kterým je aplikace přiřazena

Výjimky

EosInternalException - vnitřní chyba systému
EosObjectNotFoundException - pokud aplikace s daným identifikátorem nebyla nalezena

Popis struktur dat

EosOrganization

Reprezentuje organizaci.
Jméno atributu Datový typ Povinné Popis
id String Ne Id prostředí.
code String Ne Kód.
name String Ne Název.
identificationNumber String Ne Identifikační číslo, pro vazbu s OVM.
domain String Ne Doména.

EosOrganizations

Reprezentuje kolekci organizací.
Jméno atributu Datový typ Povinné Popis
organizations List<EosOrganization> Ne Kolekce aplikací.