Webová služba OrgStructureRead verze 2.1.0 (Obecné webové služby) - popis rozhraní služby
Marbes Consulting s.r.o.
EOS4
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.
WS pro čtení organizační struktury v 2.1.0.
Název |
Popis |
getAllPersonContainersExtended |
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). |
getAllPersonsExtended |
Vrací seznam daného počtu osob od osoby s předaným identifikátorem (ta
mezi vrácenými již není obsažena). |
getPersonContainerExtendedInfo |
Načtení kompletních informací o osobě včetně primárního zařazení, |
getPersonContainersInOUs |
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). |
getPersonImage |
Načtení fotografie osoby. |
getPersonImageInfoEx |
Vrátí informace o fotografie osoby na základě kterých může externí systém rozhodnout, zda má
osoba přiřazen stejný nebo rozdílný obrázek než ten, který má již načtený. |
Vyjímka reprezentuje špatný vstupní parametr do web metod.
Výjimka reprezentuje stav, kdy nebyl objekt podle kriterií nalezen.
Reprezentuje neočekávanou výjimku při volání WS. Jejím zdrojem musí být vždy
jiná výjimka.
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
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 |
Ano |
identifikátor klienta, je povinný jen při předání externího id v lastPersonId |
Výstup
Výjimky
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
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 |
Ano |
identifikátor klienta, je povinný jen při předání externího id v lastPersonId |
Výstup
Výjimky
Načtení kompletních informací o osobě včetně primárního zařazení,
Předpis
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 |
responseFilter |
EosOrgStructureResponseFilter |
Ne |
response filtr |
Výstup
Výjimky
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. Seznam osob je omezen pouze na organizační jednotky, které jsou vstupním parametrem. Osoby mohou být v
libovolné hloubce pod organizační jednotkou.
Předpis
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 |
ids |
EosIds |
Ano |
seznam id organizačních jednotek v EOS, pro které se budou vracet osoby |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího id v ids |
Výstup
Výjimky
Načtení fotografie osoby.
Předpis
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 |
Výstup
EosImage - fotografie nebo null, pokud osoba žádnou nemá
Výjimky
Vrátí informace o fotografie osoby na základě kterých může externí systém rozhodnout, zda má
osoba přiřazen stejný nebo rozdílný obrázek než ten, který má již načtený.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
id osoby ke které se má fotografie přiřadit |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího id v personId |
Výstup
EosImageInfo - informace o fotografii osoby nebo null, pokud osoba žádnou nemá
Výjimky
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. |
externalRegistryId |
EosValue |
Ne |
Odkaz na externi id registru budov. |
Reprezentuje údaje o budově. Není v EOSu skutečnou entitou, proto neobsahuje
žádný identifikátor.
Jméno atributu |
Datový typ |
Povinné |
Popis |
buildingId |
String |
Ne |
Název budovy. |
floorId |
String |
Ne |
Patro budovy. |
roomId |
String |
Ne |
Místnost budovy. |
Reprezentuje typ kontaktního atributu.
Hodnota |
Popis |
PHONE |
Telefon. |
FAX |
Fax. |
EMAIL |
Email. |
WWW |
WWW. |
Reprezentuje kategorii typu kontaktního atributu.
Hodnota |
Popis |
HOME |
Domů. |
WORK |
Do práce. |
MOBILE |
Mobilní. |
BLANK |
Bez kategorie. |
Reprezentuje wrapper pro kolekci telefonů.
Jméno atributu |
Datový typ |
Povinné |
Popis |
phoneContact |
List<EosPhoneContact> |
Ne |
Kolekce telefonů(fax, mobil, ...). |
otherContact |
List<EosOtherContact> |
Ne |
Kolekce ostatních kontaktů(email, www, ...). |
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. |
Struktura obsahující seznam eos identifikátorů.
Jméno atributu |
Datový typ |
Povinné |
Popis |
eosIdentifier |
List<EosString> |
Ne |
Seznam id. |
Webový objekt pro přenos fotografie.
Jméno atributu |
Datový typ |
Povinné |
Popis |
image |
byte |
Ne |
Fotografie reprezentována polem bytů. |
Webový objekt pro přenos informací o fotografie.
Jméno atributu |
Datový typ |
Povinné |
Popis |
imageHeight |
int |
Ne |
Výška obrázku v pixelech. |
imageWidth |
int |
Ne |
Šířka obrázku v pixelech. |
imageSize |
Long |
Ne |
Valikost obrázku v bytech. |
imageChecksum |
String |
Ne |
Kontrolní součet. |
Třída reprezentující filter odpovědi WS.
Ná základě atributů třídy jsou plněny a vraceny doplňující informace k entitám a osobám.
Jméno atributu |
Datový typ |
Povinné |
Popis |
fillUserFields |
boolean |
Ne |
Příznak zda plnit uživatelská pole. |
userFieldCode |
List<EosString> |
Ne |
Seznam identifikátorů uživatelských polí, kterou mohou být vráceny. |
fillBuildingInfo |
boolean |
Ne |
Příznak zda vracet budovy. |
fillContacts |
boolean |
Ne |
Příznak zda vracet kontakty. |
fillOnlyPublicableContacts |
boolean |
Ne |
Příznak zda vracet pouze veřejné kontakty. |
contactEosIdentifier |
List<EosString> |
Ne |
Seznam kontaktů, které mohou být vráceny. |
Reprezentuje telefoní kontakt.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
EosIdentifier |
Ano |
Identifikátor. |
description |
String (512) |
Ne |
Popis telefonu. |
contactType |
EosContactType |
Ne |
Typ kontaktu. |
contactTypeCategory |
EosContactTypeCategory |
Ne |
Kategorie typu kontaktu. |
contact |
EosIdentifier |
Ne |
Id atributu kontaktu. |
primary |
boolean |
Ne |
Určuje zda je kontakt primární. |
publicable |
boolean |
Ne |
Určuje zda je kontakt veřejný. |
value |
String (80) |
Ne |
Linka. |
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. |
personalNumber |
String (255) |
Ne |
Osobní číslo. |
Kontejner sloužící pro vrácení osoby společně s jejím primárním zařazením.
Kontejner sloužící pro vrácení rozšířené osoby společně s jejím primárním zařazením.
Kontejner sloužící pro vrácení rozšířené osoby společně s jejím primárním zařazením.
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. |
Reprezentuje wrapper pro kontejnery rozšíených osob, obsahující samotnou osobu a její
primární zařazení, pokud ho daná osoba má.
Reprezentuje osobu s rozšířením.
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. |
personalNumber |
String (255) |
Ne |
Osobní číslo. |
disabled |
Boolean |
Ne |
Je osoba povolená? |
signature |
String (8) |
Ne |
Iniciály. |
publicable |
Boolean |
Ano |
Zobrazovat na intenetu. |
domain |
String (255) |
Ne |
Doména v EOS, pod kterou uživatel spadá a pro kterou je dané uživatelské jméno unikátní.
V tuto chvíli není v EOS implementováno a hodnota není vracena, po implementaci v EOS bude hodnota povinná a bude
vyplněná. |
Reprezentuje doplňující informace o zařazení osoby, tedy uživatelská pole,
telefony a informace o umístění. U umístění je přidáno rozšíření o identifikátory.
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. |
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. Dále obsahuje informace o typu organizační 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. |
roleTypeCode |
String (32) |
Ano |
Kód typu organizační role. |
Reprezentuje wrapper pro kolekci rozšířených osob.
Jméno atributu |
Datový typ |
Povinné |
Popis |
personExtended |
List<EosPersonExtended> |
Ne |
Kolekce osob. |
Reprezentuje telefoní kontakt.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
EosIdentifier |
Ano |
Identifikátor. |
description |
String (512) |
Ne |
Popis telefonu. |
contactType |
EosContactType |
Ne |
Typ kontaktu. |
contactTypeCategory |
EosContactTypeCategory |
Ne |
Kategorie typu kontaktu. |
contact |
EosIdentifier |
Ne |
Id atributu kontaktu. |
primary |
boolean |
Ne |
Určuje zda je kontakt primární. |
publicable |
boolean |
Ne |
Určuje zda je kontakt veřejný. |
prefix |
String (80) |
Ne |
Předvolba. |
number |
String (80) |
Ano |
Telefonní číslo. |
extension |
String (80) |
Ne |
Linka. |
Třída reprezentující stringovou hodnotu.
Třída slouží k opravě bugu v cxo.
Jméno atributu |
Datový typ |
Povinné |
Popis |
value |
String (1024) |
Ne |
Hodnota. |
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. |
Reprezentuje kolekci uživatelských polí.
Jméno atributu |
Datový typ |
Povinné |
Popis |
userField |
List<EosUserField> |
Ne |
Kolekce uživatelských polí. |
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. |