Webová služba OrgStructureWrite verze 1.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.
Rozhraní webové služby pro zápis organizační struktury.
Název |
Popis |
EosBuildingInfo |
Reprezentuje údaje o budově. |
EosIdentifier |
Reprezentuje identifikátor webového objektu slučující interní a externí ID. |
EosImage |
Webový objekt pro přenos fotografie. |
EosPerson |
Reprezentuje osobu. |
EosPersonInfo |
Reprezentuje doplňující informace o zařazení osoby, tedy uživatelská pole,
telefony a informace o umístění. |
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. |
Vyjímka reprezentuje špatný vstupní parametr do web metod.
Vyjímka reprezentuje špatný vstupní parametr do web metod.
Vyjímka reprezentuje stav, kdy nebyl objekt podle kriterií nalezen.
Vyjímka reprezentuje stav, kdy došlo k problému při práci s organizační strukturou.
Reprezentuje neočekávanou výjimku při volání WS. Jejím zdrojem musí být vždy
jiná výjimka.
Odpojí osobu ze skupinové role.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
identifikátor osoby |
groupRoleId |
EosIdentifier |
Ano |
identifikátor skupinové role |
Výjimky
Odpojí osobu z organizační role.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
identifikátor osoby |
orgRoleId |
EosIdentifier |
Ano |
identifikátor organizační role |
Výjimky
Umístí osobu s daným id do skupinové role s daným id.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
identifikátor osoby. |
groupRoleId |
EosIdentifier |
Ano |
identifikátor cílové skupinové role. |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id v personId nebo groupRoleId |
Výjimky
Umístí osobu s daným id do organizační role s daným id.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
EosIdentifier |
Ano |
identifikátor osoby |
orgRoleId |
EosIdentifier |
Ano |
identifikátor cílové 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ýjimky
Uloží předanou osobu. Pokud bude uvedeno personInfo, budou aktualizovány
pole (jen ta, která budou uvedena, ostatní zůstanou nedotčena): umístění
a telefony, uživatelská pole. Pokud personInfo nebude uvedeno, nebudou se
záznamy umístění, telefon a uživatelských polí aktualizovat.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
person |
EosPerson |
Ano |
daná osoba. |
personInfo |
EosPersonInfo |
Ano |
její depolňující informace (kontakty, budovy) - nepovinné. |
clientId |
String |
Ano |
identifikátor klienta, je povinný jen při předání externího Id v personId |
Výstup
Výjimky
Uloží fotografii na osobu předanou pomocí identifikátoru.
Podporovaný formát fotografie je pouze jpg (jpeg).
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
image |
EosImage |
Ano |
obrázek reprezentovaný polem bytů |
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ý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. |
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. |
Webový objekt pro přenos fotografie.
Jméno atributu |
Datový typ |
Povinné |
Popis |
image |
byte |
Ne |
Fotografie reprezentována polem bytů. |
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. |
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. |
description |
String (512) |
Ne |
Popis telefonu. |
prefix |
String (80) |
Ne |
Předvolba. |
number |
String (80) |
Ano |
Telefonní číslo. |
extension |
String (80) |
Ne |
Linka. |
Reprezentuje wrapper pro kolekci telefonů.
Jméno atributu |
Datový typ |
Povinné |
Popis |
phone |
List<EosPhone> |
Ne |
Kolekce telefonů. |
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. |