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

Seznam poskytovaných metod

Název Popis
findEoOrganizationByUserId Načtení eo organizace podle identifikátoru uživatele.
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
EosEoOrganization Reprezentuje eo_organizaci
EosOrganization Reprezentuje organizaci.
EosOrganizationRespFilter Objekt definuje, jestli se objektu organizace budou plnit uživatelská pole.
EosOrganizations Reprezentuje kolekci organizací.
EosUserField Hodnota uživatelského pole.
EosUserFields Objekt obsahuje seznam hodnot uživatelských polí.

Výjimky

EosInternalException

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

EosObjectNotFoundException

Objekt nebyl nalezen.

Popis poskytovaných metod

findEoOrganizationByUserId

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

Předpis

EosEoOrganization findEoOrganizationByUserId (String userId)

Parametry

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

Výstup

EosEoOrganization - organizace nebo null

Výjimky

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

findOrganizationByUserId

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

Předpis

EosOrganization findOrganizationByUserId (String userId, EosOrganizationRespFilter respFilter)

Parametry

Parametr Typ Povinný Popis
userId String Ano identifikátor uživatele
respFilter EosOrganizationRespFilter Ne response filtr

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, EosOrganizationRespFilter respFilter)

Parametry

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

Výstup

EosOrganization - organizace nebo null

Výjimky

EosInternalException - vnitřní chyba

getAllOrganizations

Načtení seznamu organizací.

Předpis

EosOrganizations getAllOrganizations (EosOrganizationRespFilter respFilter)

Parametry

Parametr Typ Povinný Popis
respFilter EosOrganizationRespFilter Ne response filtr

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, EosOrganizationRespFilter respFilter)

Parametry

Parametr Typ Povinný Popis
orgId String Ano identifikátor organizace
respFilter EosOrganizationRespFilter Ne response filtr

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, EosOrganizationRespFilter respFilter)

Parametry

Parametr Typ Povinný Popis
applicationId String Ano identifikátor aplikace
respFilter EosOrganizationRespFilter Ne response filtr

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

EosEoOrganization

Reprezentuje eo_organizaci
Jméno atributu Datový typ Povinné Popis
dic String Ne dic.
ico String Ne ico.
idOrganizace Integer Ne id_organizace.
idSubjekt Integer Ne ID_Subjekt.
kodOrganizace String Ne kod_organizace.
kodOrp String Ne kod_orp.
nazevOrganizace String Ne nazev_organizace.
ovm String Ne ovm.
syncId String Ne sync_id.
ojs List<Integer> Ne Relace one to many na tabulku eo_organizace_ojs.

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.
userFields EosUserFields Ne Uživatelská pole.

EosOrganizationRespFilter

Objekt definuje, jestli se objektu organizace budou plnit uživatelská pole.
Jméno atributu Datový typ Povinné Popis
allUserFields boolean Ne Mají se plnit všechna uživatelská pole? Pokud bude true, bude se plnit všechna, pokud bude false, budou se plnit pouze ta, která jsou uvedena v atributu userFieldCodes.
userFieldCodes List<String> Ne Seznam kódů uživatelských polí, která se mají plnit, je možné nastavit pouze v případě, že allUserFields má hodnotu false, jinak jsou hodnoty ignorovány.

EosOrganizations

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

EosUserField

Hodnota uživatelského pole.

Jméno atributu Datový typ Povinné Popis
name String Ne Název uživatelského pole.
code String Ne Kód uživatelského pole.
value String Ne Hodnota uživatelského pole.

EosUserFields

Objekt obsahuje seznam hodnot uživatelských polí.

Jméno atributu Datový typ Povinné Popis
userFields List<EosUserField> Ne Seznam hodnot uživatelských polí.