Webová služba OrgStructureRead verze 1.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 pro čtení organizační struktury.


Seznam poskytovaných metod

Název Popis
getAllPersonContainers Vrací seznam daného počtu osob v kontejnerech s jejich primárními zařazeními od osoby s předaným identifikátorem (ta mezi vrácenými již není obsažena).
getAllPersons Vrací seznam daného počtu osob od osoby s předaným identifikátorem (ta mezi vrácenými již není obsažena).
getChildGroupRoles Vrátí seznam potomků jednotky (podřízené role).
getChildOrgRoles Vrátí seznam potomků jednotky (podřízené role).
getChildOrgUnits Vrátí seznam potomků jednotky (jen podřízené jednotky).
getGroupRoleById Najde skupinovou roli daného id.
getGroupRolesByName Najde skupinové role daného jména.
getGroupRolesOfPerson Načte skupinové role, ve kterých daná osoba figuruje.
getOrgRoleById Najde organizační roli daného Id.
getOrgRolesByName Najde role daného jména.
getOrgRolesOfPerson Načte role, ve kterých daná osoba figuruje.
getOrgUnitById Najde organizační jednotku daného id.
getOrgUnitParentUnit Najde bezprostředně nadřízenou organizační jednotku viz wiki:EosHLCOrganization.
getOrgUnitParentUnits Vrátí seznam rodičovských jednotek seřazený od předaného potomka ke kořeni viz wiki:EosHLCOrganization.
getOrgUnitsByApplication Načte všechny organizační jednotky, které mají pod sebou v organizační struktuře osoby, které mají přiřazenou danou aplikaci.
getOrgUnitsByName Najde všechny organizační jednotky daného jména.
getOrgUnitsOfPerson Načte organizační jednotky, ve kterých daná osoba figuruje.
getPersonAssignment Načte všechna zařazení osoby do organizačních jednotek, organizačních rolí a skupinových rolí.
getPersonById Najde osobu podle daného Id.
getPersonByUserName Najde osobu daného uživatelského jména.
getPersonCount Vrací celkový počet osob v databázi.
getPersonGroupRoleAssignmentInfo Načte doplňující informace o zařazení osoby do skupinové role (jako je informace o umístění, uživatelská pole nebo telefony) včetně hodnot přiřazených na osobě.
getPersonGroupRoleOnlyAssignmentInfo Načte doplňující informace o zařazení osoby do skupinové role (jako je informace o umístění, uživatelská pole nebo telefony) vyjma hodnot přiřazených na osobě.
getPersonInfo Načte doplňující informace o osobě jako je informace o umístění, uživatelská pole nebo telefony.
getPersonOrgRoleAssignmentInfo Načte doplňující informace o zařazení osoby do organizační role (jako je informace o umístění, uživatelská pole nebo telefony) včetně hodnot přiřazených na osobě.
getPersonOrgRoleOnlyAssignmentInfo Načte doplňující informace o zařazení osoby do organizační role (jako je informace o umístění, uživatelská pole nebo telefony) vyjma hodnot přiřazených na osobě.
getPersonOrgUnitAssignmentInfo Načte doplňující informace o zařazení osoby do organizační jednotky (jako je informace o umístění, uživatelská pole nebo telefony) včetně hodnot přiřazených na osobě.
getPersonOrgUnitOnlyAssignmentInfo Načte doplňující informace o zařazení osoby do organizační jednotky (jako je informace o umístění, uživatelská pole nebo telefony) vyjma hodnot přiřazených na osobě.
getPersonsByApplication Vrací seznam daného počtu osob dané aplikace.
getPersonsByApplicationInOrgUnit Načte seznam osob, které mají přiřazenou danou aplikaci, a které jsou pod danou organizační jednotkou.
getPersonsByName Najde osoby daného jména.
getPersonsInGroupRole Vrátí seznam členů dané skupinové role.
getPersonsInOrgRole Vrátí seznam členů dané organizační role.
getPersonsInOrgUnit Vrátí seznam přímých členů dané organizační jednotky.
getRootOrgUnits Načte všechny kořenové organizační jednotky.
isOrgUnitNameUnique Zjišťuje zda má organizační jednotka unikátní jméno v rámci přímých podjednotek své rodičovské jednotky.
isOrgUnitRoot Testuje, zda je daná organizační jednotka kořenová.
isPersonUserNameUnique Zjišťuje zda je uživatelské jméno unikátní.

Seznam struktur dat

Název Popis
EosBuildingInfo Reprezentuje údaje o budově.
EosGroupRole Reprezentuje skupinovou roli.
EosGroupRoles Reprezentuje wrapper pro kolekci organizačních rolí.
EosIdentifier Reprezentuje identifikátor webového objektu slučující interní a externí ID.
EosOrgRole Reprezentuje organizační roli.
EosOrgRoles Reprezentuje wrapper pro kolekci organizačních rolí.
EosOrgUnit Reprezentuje organizační jednotku.
EosOrgUnits Reprezentuje wrapper pro kolekci organizačních jednotek.
EosPerson Reprezentuje osobu.
EosPersonAssignment Reprezentuje wrapper pro seznam zařazení osoby do organizačních jednotek, organizačních rolí a skupinových rolí.
EosPersonAssignmentInfo Reprezentuje doplňující informace o konkrétním zařazení osoby.
EosPersonContainer Kontejner sloužící pro vrácení osoby společně s jejím primárním zařazením.
EosPersonContainers Reprezentuje wrapper pro kontejnery osob, obsahující samotnou osobu a její primární zařazení, pokud ho daná osoba má.
EosPersonInfo Reprezentuje doplňující informace o zařazení osoby, tedy uživatelská pole, telefony a informace o umístění.
EosPersonPrimaryLocation Reprezentuje primární zařazení osoby.
EosPersons Reprezentuje wrapper pro kolekci osob.
EosPhone Reprezentuje telefon.
EosPhones Reprezentuje wrapper pro kolekci telefonů.
EosUserField Reprezentuje uživatelské pole.
EosUserFields Reprezentuje kolekci uživatelských polí.
EosValue Reprezentuje hodnotu string atributu, výčtového atributu a selectového atributu.

Výjimky

EosInvalidParameterException

Vyjímka reprezentuje špatný vstupní parametr do web metod.

EosObjectNotFoundException

Vyjímka reprezentuje stav, kdy nebyl objekt podle kriterií nalezen.

EosPersonNotAssignedException

Reprezentuje stav, kdy osoba není zařazená do očekávané entity (jednotková role nebo organizační jednotka).

EosUnexpectedException

Reprezentuje neočekávanou výjimku při volání WS. Jejím zdrojem musí být vždy jiná výjimka.


Popis poskytovaných metod

getAllPersonContainers

Vrací seznam daného počtu osob v kontejnerech s jejich primárními zařazeními od osoby s předaným identifikátorem (ta mezi vrácenými již není obsažena). Seznam je řazený podle klíčů neviditelných pro externí systém.

Předpis

EosPersonContainers getAllPersonContainers (EosIdentifier lastPersonId, int count, String clientId)

Parametry

Parametr Typ Povinný Popis
lastPersonId EosIdentifier Ne ID poslední vrácené osoby při minulém volání; pro první volání je očekávána hodnota null
count int Ano počet vrácených záznamů, maximum je 1000
clientId String Ne identifikátor klienta, není povinný

Výstup

EosPersonContainers - všechny nalezené osoby v kontejnerech s primárním zařazením

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getAllPersons

Vrací seznam daného počtu osob od osoby s předaným identifikátorem (ta mezi vrácenými již není obsažena). Seznam je řazený podle klíčů neviditelných pro externí systém.

Předpis

EosPersons getAllPersons (EosIdentifier lastPersonId, int count, String clientId)

Parametry

Parametr Typ Povinný Popis
lastPersonId EosIdentifier Ne ID poslední vrácené osoby při minulém volání; pro první volání je očekávána hodnota null
count int Ano počet vrácených záznamů, maximum je 1000
clientId String Ne identifikátor klienta, není povinný

Výstup

EosPersons - všechny nalezené osoby

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getChildGroupRoles

Vrátí seznam potomků jednotky (podřízené role). viz wiki:EosHLCOrganization.

Předpis

EosGroupRoles getChildGroupRoles (EosIdentifier parentUnitId, String clientId)

Parametry

Parametr Typ Povinný Popis
parentUnitId EosIdentifier Ano Id jednotky, od které se budou hledat potomci
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v parentUnitId

Výstup

EosGroupRoles - seznam skupinových rolí pod organizační jednotkou

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getChildOrgRoles

Vrátí seznam potomků jednotky (podřízené role). viz wiki:EosHLCOrganization.

Předpis

EosOrgRoles getChildOrgRoles (EosIdentifier parentUnitId, String clientId)

Parametry

Parametr Typ Povinný Popis
parentUnitId EosIdentifier Ano Id jednotky, od které se budou hledat potomci
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v parentUnitId

Výstup

EosOrgRoles - seznam organizačních rolí pod předanou jednotkou

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getChildOrgUnits

Vrátí seznam potomků jednotky (jen podřízené jednotky).

Předpis

EosOrgUnits getChildOrgUnits (EosIdentifier parentUnitId, String clientId)

Parametry

Parametr Typ Povinný Popis
parentUnitId EosIdentifier Ano Id jednotky, od které se budou hledat potomci
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v parentUnitId

Výstup

EosOrgUnits - seznam potomků

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getGroupRoleById

Najde skupinovou roli daného id.

Předpis

EosGroupRole getGroupRoleById (EosIdentifier groupRoleId, String clientId)

Parametry

Parametr Typ Povinný Popis
groupRoleId EosIdentifier Ano Id požadované skupinové role
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v groupRoleId

Výstup

EosGroupRole - skupinovou roli

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getGroupRolesByName

Najde skupinové role daného jména.

Předpis

EosGroupRoles getGroupRolesByName (String name, String clientId)

Parametry

Parametr Typ Povinný Popis
name String Ano dané jméno
clientId String Ne identifikátor klienta, není povinný

Výstup

EosGroupRoles - seznam skupinových rolí

Výjimky

EosUnexpectedException - nastala vnitřní chyba EOSu

getGroupRolesOfPerson

Načte skupinové role, ve kterých daná osoba figuruje.

Předpis

EosGroupRoles getGroupRolesOfPerson (EosIdentifier personId, String clientId)

Parametry

Parametr Typ Povinný Popis
personId EosIdentifier Ano Id dané osoby
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v personId

Výstup

EosGroupRoles - seznam skupinových rolí osoby

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getOrgRoleById

Najde organizační roli daného Id.

Předpis

EosOrgRole getOrgRoleById (EosIdentifier orgRoleId, String clientId)

Parametry

Parametr Typ Povinný Popis
orgRoleId EosIdentifier Ano Id požadované organizační role
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v orgRoleId

Výstup

EosOrgRole - organizační roli

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getOrgRolesByName

Najde role daného jména.

Předpis

EosOrgRoles getOrgRolesByName (String name, String clientId)

Parametry

Parametr Typ Povinný Popis
name String Ano dané jméno
clientId String Ne identifikátor klienta, není povinný

Výstup

EosOrgRoles - seznam rolí

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getOrgRolesOfPerson

Načte role, ve kterých daná osoba figuruje.

Předpis

EosOrgRoles getOrgRolesOfPerson (EosIdentifier personId, String clientId)

Parametry

Parametr Typ Povinný Popis
personId EosIdentifier Ano Id dané osoby
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v personId

Výstup

EosOrgRoles - seznam rolí osoby

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getOrgUnitById

Najde organizační jednotku daného id.

Předpis

EosOrgUnit getOrgUnitById (EosIdentifier unitId, String clientId)

Parametry

Parametr Typ Povinný Popis
unitId EosIdentifier Ano Id požadované organizační jednotky
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v unitId

Výstup

EosOrgUnit - organizační jednotku

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getOrgUnitParentUnit

Najde bezprostředně nadřízenou organizační jednotku viz wiki:EosHLCOrganization.

Předpis

EosOrgUnit getOrgUnitParentUnit (EosIdentifier childUnitId, String clientId)

Parametry

Parametr Typ Povinný Popis
childUnitId EosIdentifier Ano Id organizační jednotky pro kterou se hledá nadřazená organizační jednotka
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v childUnitId

Výstup

EosOrgUnit - rodičovskou org. jednotku, pokud je předaná entita kořenová, návratová hodnota definována

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getOrgUnitParentUnits

Vrátí seznam rodičovských jednotek seřazený od předaného potomka ke kořeni viz wiki:EosHLCOrganization.

Předpis

EosOrgUnits getOrgUnitParentUnits (EosIdentifier childUnitId, String clientId)

Parametry

Parametr Typ Povinný Popis
childUnitId EosIdentifier Ano Id entity od které se budou vybírat předci
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v childUnitId

Výstup

EosOrgUnits - seznam rodičovských entit

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getOrgUnitsByApplication

Načte všechny organizační jednotky, které mají pod sebou v organizační struktuře osoby, které mají přiřazenou danou aplikaci.

Předpis

EosOrgUnits getOrgUnitsByApplication (EosIdentifier appId, String clientId, Boolean fillBuildingInfo, Boolean fillUserFields, Boolean fillPhones)

Parametry

Parametr Typ Povinný Popis
appId EosIdentifier Ano Id požadované aplikace
clientId String Ano identifikátor klienta, je povinný jen při vyplnění externího Id v applicationId
fillBuildingInfo Boolean Ne parametr, zda vyplnit BuildingInfo
fillUserFields Boolean Ne parametr, zda vyplnit UserFields
fillPhones Boolean Ne parametr, zda vyplnit Phones

Výstup

EosOrgUnits - organizační jednotky, které mají danou aplikaci

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getOrgUnitsByName

Najde všechny organizační jednotky daného jména.

Předpis

EosOrgUnits getOrgUnitsByName (String name, String clientId)

Parametry

Parametr Typ Povinný Popis
name String Ano jméno požadované organizační jednotky
clientId String Ne identifikátor klienta, není povinný

Výstup

EosOrgUnits - seznam organizačních jednotek

Výjimky

EosUnexpectedException - nastala vnitřní chyba EOSu

getOrgUnitsOfPerson

Načte organizační jednotky, ve kterých daná osoba figuruje.

Předpis

EosOrgUnits getOrgUnitsOfPerson (EosIdentifier personId, String clientId)

Parametry

Parametr Typ Povinný Popis
personId EosIdentifier Ano Id dané osoby
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v personId

Výstup

EosOrgUnits - seznam organizačních jednotek osoby

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonAssignment

Načte všechna zařazení osoby do organizačních jednotek, organizačních rolí a skupinových rolí.

Předpis

EosPersonAssignment getPersonAssignment (EosIdentifier personId, String clientId)

Parametry

Parametr Typ Povinný Popis
personId EosIdentifier Ano Id dané osoby
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v personId

Výstup

EosPersonAssignment - seznam všech zařazení osoby

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonById

Najde osobu podle daného Id.

Předpis

EosPerson getPersonById (EosIdentifier personId, String clientId)

Parametry

Parametr Typ Povinný Popis
personId EosIdentifier Ano Id požadované osoby
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v personId

Výstup

EosPerson - konkrétní osoba

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonByUserName

Najde osobu daného uživatelského jména.

Předpis

EosPerson getPersonByUserName (String userName, String clientId)

Parametry

Parametr Typ Povinný Popis
userName String Ano uživatelské jméno
clientId String Ne identifikátor klienta, není povinný

Výstup

EosPerson - nalezenou osobu

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonCount

Vrací celkový počet osob v databázi.

Předpis

Integer getPersonCount ()

Parametry

Parametr Typ Povinný Popis

Výstup

Integer - celkový počet osob

Výjimky

EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonGroupRoleAssignmentInfo

Načte doplňující informace o zařazení osoby do skupinové role (jako je informace o umístění, uživatelská pole nebo telefony) včetně hodnot přiřazených na osobě.

Předpis

EosPersonAssignmentInfo getPersonGroupRoleAssignmentInfo (EosIdentifier personId, EosIdentifier groupRoleId, String clientId)

Parametry

Parametr Typ Povinný Popis
personId EosIdentifier Ano Id osoby
groupRoleId EosIdentifier Ano Id skupinové role
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v personId nebo groupRoleId

Výstup

EosPersonAssignmentInfo - informace načtené ze zařazení osoby

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosPersonNotAssignedException - v případě nezařazení osoby do skupinové role
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonGroupRoleOnlyAssignmentInfo

Načte doplňující informace o zařazení osoby do skupinové role (jako je informace o umístění, uživatelská pole nebo telefony) vyjma hodnot přiřazených na osobě.

Předpis

EosPersonAssignmentInfo getPersonGroupRoleOnlyAssignmentInfo (EosIdentifier personId, EosIdentifier groupRoleId, String clientId)

Parametry

Parametr Typ Povinný Popis
personId EosIdentifier Ano Id osoby
groupRoleId EosIdentifier Ano Id skupinové role
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v personId nebo groupRoleId

Výstup

EosPersonAssignmentInfo - informace načtené ze zařazení osoby

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosPersonNotAssignedException - v případě nezařazení osoby do skupinové role
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonInfo

Načte doplňující informace o osobě jako je informace o umístění, uživatelská pole nebo telefony. Informace jsou z osoby a všech jejích zařazení.

Předpis

EosPersonInfo getPersonInfo (EosIdentifier personId, String clientId)

Parametry

Parametr Typ Povinný Popis
personId EosIdentifier Ano Id osoby
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v personId nebo groupRoleId

Výstup

EosPersonInfo - informace načtené z osoby a všech jejích zařazení

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonOrgRoleAssignmentInfo

Načte doplňující informace o zařazení osoby do organizační role (jako je informace o umístění, uživatelská pole nebo telefony) včetně hodnot přiřazených na osobě.

Předpis

EosPersonAssignmentInfo getPersonOrgRoleAssignmentInfo (EosIdentifier personId, EosIdentifier orgRoleId, String clientId)

Parametry

Parametr Typ Povinný Popis
personId EosIdentifier Ano Id osoby
orgRoleId EosIdentifier Ano Id organizační role
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v personId nebo orgRoleId

Výstup

EosPersonAssignmentInfo - informace načtené ze zařazení osoby

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosPersonNotAssignedException - v případě nezařazení osoby do skupinové role
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonOrgRoleOnlyAssignmentInfo

Načte doplňující informace o zařazení osoby do organizační role (jako je informace o umístění, uživatelská pole nebo telefony) vyjma hodnot přiřazených na osobě.

Předpis

EosPersonAssignmentInfo getPersonOrgRoleOnlyAssignmentInfo (EosIdentifier personId, EosIdentifier orgRoleId, String clientId)

Parametry

Parametr Typ Povinný Popis
personId EosIdentifier Ano Id osoby
orgRoleId EosIdentifier Ano Id organizační role
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v personId nebo orgRoleId

Výstup

EosPersonAssignmentInfo - informace načtené ze zařazení osoby

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosPersonNotAssignedException - v případě nezařazení osoby do skupinové role
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonOrgUnitAssignmentInfo

Načte doplňující informace o zařazení osoby do organizační jednotky (jako je informace o umístění, uživatelská pole nebo telefony) včetně hodnot přiřazených na osobě.

Předpis

EosPersonAssignmentInfo getPersonOrgUnitAssignmentInfo (EosIdentifier personId, EosIdentifier unitId, String clientId)

Parametry

Parametr Typ Povinný Popis
personId EosIdentifier Ano Id osoby
unitId EosIdentifier Ano Id organizační jednotky
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v personId nebo orgUnitId

Výstup

EosPersonAssignmentInfo - informace načtené ze zařazení osoby

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosPersonNotAssignedException - v případě nezařazení osoby do skupinové role
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonOrgUnitOnlyAssignmentInfo

Načte doplňující informace o zařazení osoby do organizační jednotky (jako je informace o umístění, uživatelská pole nebo telefony) vyjma hodnot přiřazených na osobě.

Předpis

EosPersonAssignmentInfo getPersonOrgUnitOnlyAssignmentInfo (EosIdentifier personId, EosIdentifier unitId, String clientId)

Parametry

Parametr Typ Povinný Popis
personId EosIdentifier Ano Id osoby
unitId EosIdentifier Ano Id organizační jednotky
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v personId nebo orgUnitId

Výstup

EosPersonAssignmentInfo - informace načtené ze zařazení osoby

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosPersonNotAssignedException - v případě nezařazení osoby do skupinové role
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonsByApplication

Vrací seznam daného počtu osob dané aplikace.

Předpis

EosPersons getPersonsByApplication (EosIdentifier lastPersonId, int count, EosIdentifier applicationId)

Parametry

Parametr Typ Povinný Popis
lastPersonId EosIdentifier Ne ID poslední vrácené osoby při minulém volání; pro první volání je očekávána hodnota null
count int Ano počet vrácených záznamů, maximum je 1000
applicationId EosIdentifier Ano Id požadované aplikace

Výstup

EosPersons - seznam daného počtu osob dané aplikace

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonsByApplicationInOrgUnit

Načte seznam osob, které mají přiřazenou danou aplikaci, a které jsou pod danou organizační jednotkou.

Předpis

EosPersons getPersonsByApplicationInOrgUnit (EosIdentifier unitId, EosIdentifier applicationId, String clientId)

Parametry

Parametr Typ Povinný Popis
unitId EosIdentifier Ano Id organizační jednotky, pod kterou se budou hledat osoby
applicationId EosIdentifier Ano Id požadované aplikace
clientId String Ano identifikátor klienta, je povinný jen při vyplnění externího Id v unitId nebo applicationId

Výstup

EosPersons - seznam osob dané aplikace v organizační jednotce

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonsByName

Najde osoby daného jména.

Předpis

EosPersons getPersonsByName (String firstName1, String surname1, String clientId)

Parametry

Parametr Typ Povinný Popis
firstName1 String Ano křestní jméno
surname1 String Ano příjmení
clientId String Ne identifikátor klienta, není povinný

Výstup

EosPersons - seznam osob

Výjimky

EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosObjectNotFoundException - objekt nebyl nalezen
EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonsInGroupRole

Vrátí seznam členů dané skupinové role.

Předpis

EosPersons getPersonsInGroupRole (EosIdentifier groupRoleId, String clientId, EosIdentifier lastPersonId, int count)

Parametry

Parametr Typ Povinný Popis
groupRoleId EosIdentifier Ano ID role, pro kterou chceme najít členy
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v groupRoleId
lastPersonId EosIdentifier Ne ID poslední vrácené osoby při minulém volání; pro první volání je očekávána hodnota null
count int Ano počet vrácených záznamů, maximum je 1000

Výstup

EosPersons - seznam osob

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonsInOrgRole

Vrátí seznam členů dané organizační role.

Předpis

EosPersons getPersonsInOrgRole (EosIdentifier orgRoleId, String clientId)

Parametry

Parametr Typ Povinný Popis
orgRoleId EosIdentifier Ano Id role, pro kterou chceme najít členy
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v orgRoleId

Výstup

EosPersons - seznam osob

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getPersonsInOrgUnit

Vrátí seznam přímých členů dané organizační jednotky.

Předpis

EosPersons getPersonsInOrgUnit (EosIdentifier unitId, String clientId)

Parametry

Parametr Typ Povinný Popis
unitId EosIdentifier Ano Id organizační jednotky, pro kterou se budou hledat členové
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v orgUnitId

Výstup

EosPersons - seznam osob

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

getRootOrgUnits

Načte všechny kořenové organizační jednotky.

Předpis

EosOrgUnits getRootOrgUnits (String clientId)

Parametry

Parametr Typ Povinný Popis
clientId String Ne identifikátor klienta, není povinný

Výstup

EosOrgUnits - seznam kořenových organizačních jednotek

Výjimky

EosUnexpectedException - nastala vnitřní chyba EOSu

isOrgUnitNameUnique

Zjišťuje zda má organizační jednotka unikátní jméno v rámci přímých podjednotek své rodičovské jednotky. Je použitelné pouze pokud organizační jednotka s daným jménem není uložená, tzn. před vytvořením nové.

Předpis

boolean isOrgUnitNameUnique (String name, EosIdentifier parentUnitId, String clientId)

Parametry

Parametr Typ Povinný Popis
name String Ano testované jméno jednotky
parentUnitId EosIdentifier Ano daná rodičovská jednotka
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v parentUnitId

Výstup

boolean - zda má unikátní jméno

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

isOrgUnitRoot

Testuje, zda je daná organizační jednotka kořenová.

Předpis

boolean isOrgUnitRoot (EosIdentifier unitId, String clientId)

Parametry

Parametr Typ Povinný Popis
unitId EosIdentifier Ano Id testované jednotky
clientId String Ano identifikátor klienta, je povinný jen při předání externího Id v unitId

Výstup

boolean - true pokud je organizační jednotka kořenovou

Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - byl předán nevalidní vstupní parametr
EosUnexpectedException - nastala vnitřní chyba EOSu

isPersonUserNameUnique

Zjišťuje zda je uživatelské jméno unikátní. Je použitelné pouze pokud uživatel není uložen, tzn. před vytvořením nového.

Předpis

boolean isPersonUserNameUnique (String userName)

Parametry

Parametr Typ Povinný Popis
userName String Ano testované uživatelské jméno osoby

Výstup

boolean - true, pokud osoba daného jména neexistuje (mimo předaný)

Výjimky

EosUnexpectedException - nastala vnitřní chyba EOSu

Popis struktur dat

EosBuildingInfo

Reprezentuje údaje o budově. Není v EOSu skutečnou entitou, proto neobsahuje žádný identifikátor.

Jméno atributu Datový typ Povinné Popis
building EosValue Ne Název budovy.
floor EosValue Ne Patro budovy.
room EosValue Ne Místnost budovy.

EosGroupRole

Reprezentuje skupinovou roli.

Jméno atributu Datový typ Povinné Popis
id EosIdentifier Ano Identifikátor.
buildingInfo EosBuildingInfo Ne Informace o budově.
userFields EosUserFields Ne Uživatelská pole jednotlivých entit.
phones EosPhones Ne Telefony přiřazené této entitě.
name String (255) Ano Jméno organizační role.
code String (100) Ne Kód organizační role.
sentence Integer Ne Pořadí pracovní pozice v rámci nadřízené organizační jednotky.
altName String Ne Alternativní název role.
unitId EosIdentifier Ano Organizační jednotka, do které je role zařazena.

EosGroupRoles

Reprezentuje wrapper pro kolekci organizačních rolí.

Jméno atributu Datový typ Povinné Popis
groupRole List<EosGroupRole> Ne Kolekce rolí.

EosIdentifier

Reprezentuje identifikátor webového objektu slučující interní a externí ID.

Jméno atributu Datový typ Povinné Popis
externalId String (255) Ne Id entity v externím systému.
eosIdentifier String (255) Ne Unikátní identifikátor entity v EOSu (v rámci konkrétního potomka entity, tedy např. organizační role), při importu do EOSu nemá význam.

EosOrgRole

Reprezentuje organizační roli.

Jméno atributu Datový typ Povinné Popis
id EosIdentifier Ano Identifikátor.
buildingInfo EosBuildingInfo Ne Informace o budově.
userFields EosUserFields Ne Uživatelská pole jednotlivých entit.
phones EosPhones Ne Telefony přiřazené této entitě.
name String (255) Ano Jméno organizační role.
code String (100) Ne Kód organizační role.
sentence Integer Ne Pořadí pracovní pozice v rámci nadřízené organizační jednotky.
altName String Ne Alternativní název role.
unitId EosIdentifier Ano Organizační jednotka, do které je role zařazena.
superiorId EosIdentifier Ne Nadřazená organizační role.
typeCode String (32) Ne Kód typu organizační role.

EosOrgRoles

Reprezentuje wrapper pro kolekci organizačních rolí.

Jméno atributu Datový typ Povinné Popis
orgRole List<EosOrgRole> Ne Kolekce rolí.

EosOrgUnit

Reprezentuje organizační jednotku.

Jméno atributu Datový typ Povinné Popis
id EosIdentifier Ano Identifikátor.
buildingInfo EosBuildingInfo Ne Informace o budově.
userFields EosUserFields Ne Uživatelská pole jednotlivých entit.
phones EosPhones Ne Telefony přiřazené této entitě.
name String (255) Ano Jméno organizační jednotky.
code String (100) Ne Kód organizační jednotky.
parentId EosIdentifier Ne Externí id nadřízené organizační jednotky.
altName String (255) Ne Alternativní název organizační jednotky.
description String (255) Ne Popis organizační jednotky.
abbrev String (25) Ne Zkratka organizační jednotky.
typeCode String (32) Ne Kód typu organizační jednotky.
sentence Integer Ne Pořadí organizační jednotky v rámci nadřízené organizační jednotky.

EosOrgUnits

Reprezentuje wrapper pro kolekci organizačních jednotek.

Jméno atributu Datový typ Povinné Popis
units List<EosOrgUnit> Ne Kolekce organizačních jednotek.

EosPerson

Reprezentuje osobu.

Jméno atributu Datový typ Povinné Popis
id EosIdentifier Ano Identifikátor.
surname1 String (64) Ano 1. příjmení.
surname2 String (64) Ne 2. příjmení.
firstname1 String (64) Ano 1. křestní jméno.
firstname2 String (64) Ne 2. křestní jméno.
degreeBefore String (32) Ne Akademický titul před jménem.
degreeAfter String (32) Ne Akademický titul za jménem.
dateStart Date Ne Datum zavedení do evidence.
dateEnd Date Ne Datum vyřazení z evidence.
username String (255) Ne Uživatelské jméno. Není povinné kvůli tomu, že je možné jméno generovat.
abbrev String (24) Ne Zkratka.
email String (128) Ne Adresa elektronické pošty. Pokud je uvedena, je unikátní. Nevyplněná hodnota je dovolena u více uživatelů.
displayName String (255) Ne Zobrazované jméno.
disabled Boolean Ano Účet uživatele je zakázán.
locked Boolean Ano Pokud je EOS nastaven jako ověřovací autorita a uživatel se několikrát špatně přihlásí, účet se zamkne.

EosPersonAssignment

Reprezentuje wrapper pro seznam zařazení osoby do organizačních jednotek, organizačních rolí a skupinových rolí.
Jméno atributu Datový typ Povinné Popis
orgUnits EosOrgUnits Ne Seznam organizačních jednotek, do kterých je osoba zařazená.
orgRoles EosOrgRoles Ne Seznam organizačních rolí, do kterých je osoba zařazená.
groupRoles EosGroupRoles Ne Seznam skupinových rolí, do kterých je osoba zařazená.

EosPersonAssignmentInfo

Reprezentuje doplňující informace o konkrétním zařazení osoby.
Jméno atributu Datový typ Povinné Popis
id EosIdentifier Ano Identifikátor.
buildingInfo EosBuildingInfo Ne Informace o budově.
userFields EosUserFields Ne Uživatelská pole jednotlivých entit.
phones EosPhones Ne Telefony přiřazené této entitě.
degree Integer Ne Úroveň obsazení osoby do role - zastupitelnost, asistence apod.
capacity Integer Ne Odpovídá pracovní kapacitě jež daný pracovník věnuje konkrétní roli. Doporučeno, aby číslo odpovídalo procentuelnímu vyjádření.
fromDate Date Ne Datum, od kterého (včetně) je daná osoba obsazena.
toDate Date Ne Datum, do kterého (včetně) je daná osoba obsazena.

EosPersonContainer

Kontejner sloužící pro vrácení osoby společně s jejím primárním zařazením.

Jméno atributu Datový typ Povinné Popis
person EosPerson Ano Osoba.
primaryAssignment EosPersonPrimaryLocation Ne Primární zařazení osoby.

EosPersonContainers

Reprezentuje wrapper pro kontejnery osob, obsahující samotnou osobu a její primární zařazení, pokud ho daná osoba má.

Jméno atributu Datový typ Povinné Popis
personContainer List<EosPersonContainer> Ne Kolekce kontejnerů osob.

EosPersonInfo

Reprezentuje doplňující informace o zařazení osoby, tedy uživatelská pole, telefony a informace o umístění.

Jméno atributu Datový typ Povinné Popis
id EosIdentifier Ano Identifikátor.
buildingInfo EosBuildingInfo Ne Informace o budově.
userFields EosUserFields Ne Uživatelská pole jednotlivých entit.
phones EosPhones Ne Telefony přiřazené této entitě.

EosPersonPrimaryLocation

Reprezentuje primární zařazení osoby. Nese informace o roli, ve které je osoba primárně zařazena a o rganizační jednotce, ve které je tato role.

Jméno atributu Datový typ Povinné Popis
roleName String (255) Ano Jméno organizační role.
roleIdentifier EosIdentifier Ano Identifier organizační role.
orgUnitName String Ano Jméno organizační jednotky.
orgUnitIdentifier EosIdentifier Ano Identifier organizační jednotky.

EosPersons

Reprezentuje wrapper pro kolekci osob.

Jméno atributu Datový typ Povinné Popis
person List<EosPerson> Ne Kolekce osob.

EosPhone

Reprezentuje telefon.

Jméno atributu Datový typ Povinné Popis
id EosIdentifier Ano Identifikátor.
description String (512) Ne Popis telefonu.
prefix String (80) Ne Předvolba.
number String (80) Ano Telefonní číslo.
extension String (80) Ne Linka.

EosPhones

Reprezentuje wrapper pro kolekci telefonů.

Jméno atributu Datový typ Povinné Popis
phone List<EosPhone> Ne Kolekce telefonů.

EosUserField

Reprezentuje uživatelské pole.

Jméno atributu Datový typ Povinné Popis
name String (255) Ano Jméno uživatelského pole.
content String (512) Ano Hodnota uživatelského pole.
code String (255) Ano Kód uživatelského pole.

EosUserFields

Reprezentuje kolekci uživatelských polí.

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

EosValue

Reprezentuje hodnotu string atributu, výčtového atributu a selectového atributu. Dále pak hodnoty rozsahu výčtového atributu.

Jméno atributu Datový typ Povinné Popis
id EosIdentifier Ano Identifikátor.
content String (512) Ano Samotná hodnota atributu.
comment String (512) Ne Komentář hodnoty atributu.