Webová služba CacheRights verze 1.0.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í umožňující číst oprávnění, kontakty, přiřazené aplikace z cache.
Pokud je vstupem metody seznam identifikátorů, tak maximální počet identifikátorů, které lze předat na jedno
volání je {@value #MAX_ITEM_IDS_COUNT}.
Vyjímka je vyvolána, pokud uživatel nemá přiřazenou aplikaci.
Byl předán nevalidní vstupní argument do metody webové služby.
Reprezentuje neočekávanou výjimku při volání WS. Jejím zdrojem musí být vždy
jiná výjimka.
Osoba nemá žádné primární zařazení.
Objekt nebyl nalezen.
Vrací seznam osob, které mají přiřazené dané aplikace ve všech zařazeních.
Pokud aplikace není v EOSu dle identifikátoru nalezena, pak není tento záznam do výsledků zahrnut.
Maximální počet identifikátorů, které lze předat na jedno volání je
{@value #MAX_ITEM_IDS_COUNT}.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personIds |
EosApplicationIds |
Ano |
identifikátory osob pro které hledáme přiřazené osoby |
Výstup
Výjimky
Vrací seznam osob, které mají přiřazené dané aplikace v primárních zařazeních.
Pokud aplikace není v EOSu dle identifikátoru nalezena, pak není tento záznam do výsledků zahrnut.
Maximální počet identifikátorů, které lze předat na jedno volání je
{@value #MAX_ITEM_IDS_COUNT}.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personIds |
EosApplicationIds |
Ano |
identifikátory osob pro které hledáme přiřazené osoby |
Výstup
Výjimky
Vrací seznam aplikací, které mají dano osoby přiřazeny ve všech zařazeních.
Pokud není osoba v EOSu dle identifikátoru nalezena, pak není tento záznam do výsledků zahrnut.
Maximální počet identifikátorů, které lze předat na jedno volání je
{@value #MAX_ITEM_IDS_COUNT}.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personIds |
EosPersonIds |
Ano |
identifikátory osob pro které chceme nalézt přiřazené aplikace |
Výstup
Výjimky
Vrací seznam aplikací, které mají dano osoby přiřazeny v primárních zařazeních.
Pokud není osoba v EOSu dle identifikátoru nalezena, pak není tento záznam do výsledků zahrnut.
Pokud osoba nemá primární zařazení (nebo nelze určit), pok není tento záznam do výsledků zahrnut.
Maximální počet identifikátorů, které lze předat na jedno volání je
{@value #MAX_ITEM_IDS_COUNT}.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personIds |
EosPersonIds |
Ano |
identifikátory osob pro které chceme nalézt přiřazené aplikace |
Výstup
Výjimky
Zjištění hodnoty atributů daného uživatele. Načte všechny výskyty atributů v organizačních jednotkách, rolích a
u osoby, na cestě směrem ke kořenovému uzlu, prohledá zadanou aplikaci.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
String |
Ano |
identifikátor osoby pro kterou chceme načíst hodnoty atributů |
applicationId |
String |
Ano |
identifikátor aplikace, jejíchž hodnoty atributů chceme vrátit |
Výstup
Výjimky
Zjištění hodnoty atributů daného uživatele. Načte všechny výskyty atributů v primárním zařazení osoby pro
danou aplikaci.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personId |
String |
Ano |
identifikátor osoby pro kterou chceme načíst hodnoty atributů |
applicationId |
String |
Ano |
identifikátor aplikace, jejíchž hodnoty atributů chceme vrátit |
Výstup
Výjimky
Vrací informace o kontaktech pro všechny předané osoby. Načte kontakty ze všech zařazení osoby.
Pokud osoba nebyla nalezena, není ve výsledcích takováto osoba zahrnuta.
Maximální počet identifikátorů, které lze předat na jedno volání je
{@value #MAX_ITEM_IDS_COUNT}.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personIds |
EosPersonIds |
Ano |
identifikátory osob pro které chceme zjistit kontakty |
Výstup
Výjimky
Vrací informace o kontaktech pro všechny předané osoby. Načte kontakty za primární zařazení osoby.
Pokud osoba nebyla nalezena, není ve výsledcích takováto osoba zahrnuta.
Maximální počet identifikátorů, které lze předat na jedno volání je
{@value #MAX_ITEM_IDS_COUNT}.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personIds |
EosPersonIds |
Ano |
identifikátory osob pro které chceme zjistit kontakty |
Výstup
Výjimky
Vrací informace o umístění pro všechny předané osoby. Načte umístění ze všech zařazení.
Pokud osoba nebyla nalezena, nebo nemá přiřazeno žádné umístění, není ve výsledcích takováto osoba zahrnuta.
Maximální počet identifikátorů, které lze předat na jedno volání je
{@value #MAX_ITEM_IDS_COUNT}.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personIds |
EosPersonIds |
Ano |
identifikátory osob pro které chceme zjistit umístění |
Výstup
Výjimky
Vrací informace o umístění pro všechny předané osoby. Načte umístění za primární zařazení.
Pokud osoba nebyla nalezena, nebo nemá přiřazeno žádné umístění, není ve výsledcích takováto osoba zahrnuta.
Pokud u osoby nelze určit primární zařazení, tak také nebude ve výsledcích zahrnuta.
Maximální počet identifikátorů, které lze předat na jedno volání je
{@value #MAX_ITEM_IDS_COUNT}.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personIds |
EosPersonIds |
Ano |
identifikátory osob pro které chceme zjistit umístění |
Výstup
Výjimky
Zjištění hodnoty atributů uživatelů pro aplikace. Načte všechny výskyty atributů v organizačních
jednotkách, rolích a u osoby, na cestě směrem ke kořenovému uzlu, prohledá zadané aplikace.
Ve výsledku jsou vráceny hodnoty atributů pro všechny osoby a předané aplikace.
Pokud osoba, nebo aplikace není v EOSu nalezena, pak do výsledků není tento záznam zahrnut.
Pokud osoba nemá přiřazenou danou aplikaci, pak do výsledků není tento záznam zahrnut.
Maximální počet identifikátorů, které lze předat na jedno volání je
{@value #MAX_ITEM_IDS_COUNT}.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personIds |
EosPersonIds |
Ano |
identifikátory osob pro které chceme vrátit hodnoty oprávnění |
applicationIds |
EosApplicationIds |
Ano |
identifikátory aplikací pro které chceme vrátit hodnoty oprávnění |
Výstup
Výjimky
Zjištění hodnoty atributů uživatelů pro aplikace v primárních zařazeních.
Ve výsledku jsou vráceny hodnoty atributů pro všechny osoby a předané aplikace.
Pokud osoba, nebo aplikace není v EOSu nalezena, pak do výsledků není tento záznam zahrnut.
Pokud osoba nemá přiřazenou danou aplikaci nebo nemá primární zařazení, pak do výsledků není tento záznam
zahrnut.
Maximální počet identifikátorů, které lze předat na jedno volání je
{@value #MAX_ITEM_IDS_COUNT}.
Předpis
Parametry
Parametr |
Typ |
Povinný |
Popis |
personIds |
EosPersonIds |
Ano |
identifikátory osob pro které chceme vrátit hodnoty oprávnění |
applicationIds |
EosApplicationIds |
Ano |
identifikátory aplikací pro které chceme vrátit hodnoty oprávnění |
Výstup
Výjimky
Objekt obsahuje infomrace o aplikaci.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
String |
Ne |
Identifikátor, pro range value není povinný. |
name |
String |
Ne |
Jméno aplikace. |
parameters |
String |
Ne |
Parametry příkazové řádky. |
author |
String |
Ne |
Autor aplikace. |
description |
String |
Ne |
Popis aplikace. |
formattedDescription |
String |
Ne |
Podrobný naformátovaný popis aplikace, jedná se o xhtml kód. |
path |
String |
Ne |
Cesta k aplikaci. Kde je fyzicky spustitelný soubor na síti - v případě webové URL. |
icon |
String |
Ne |
Kde je uložena na disku nebo v síti ikona aplikace. |
appServerName |
String |
Ne |
Jméno aplikačního serveru. |
appCode |
String |
Ne |
Kód aplikace. Zkratka subsystému (RB, ROB...). |
serverUrl |
String |
Ne |
URL aplikačního serveru pro webové služby. |
version |
String |
Ne |
Verze aplikace. |
Objekt obsahující seznam identifikátorů aplikací.
Jméno atributu |
Datový typ |
Povinné |
Popis |
applicationids |
List<String> |
Ne |
Seznam identifikátorů aplikací. |
Objekt obsahuje seznam osob, které jsou přiřazeny k aplikaci.
Jméno atributu |
Datový typ |
Povinné |
Popis |
applicationId |
String |
Ne |
Identifikátor aplikace ke které jsou přiřazeny osoby. |
persons |
List<EosPerson> |
Ne |
Seznam přiřazených osob k aplikaci. |
Objekt obsahuje informace, jaké osoby jsou zařazeny k aplikacím.
Jméno atributu |
Datový typ |
Povinné |
Popis |
applicationPersons |
List<EosApplicationPerson> |
Ne |
Seznam osob přiřazených k aplikacím. |
Objekt obsahuje hodnotu atributu.
Pokud je tento atribut vícesloupcový (metoda {@link #isMultiColumnAttr()} vrací true), je hodnota každého sloupce
uložena v objektu {@link WOAttributeValueRow}.
Tento objekt obsahuje pro každý řádek vícesloupcového atributu hodnotu pro každý sloupec v objektu
{@link WOSimpleAttributeValue}.
Pokud je atribut vícesloupcový a jednohodnotový (obsahuje jen jeden řádek), pak metoda
{@link #getMultiColumnRows()} vrací jen jednu položku (pokud má uživatel právo vyplněno).
Jméno atributu |
Datový typ |
Povinné |
Popis |
attributeName |
String |
Ne |
Název atributu. |
values |
List<String> |
Ne |
Seznam hodnot atributu. |
multiColumnAttr |
boolean |
Ne |
Informace, jestli je to vícesloupcový atribut, nebo není. |
multiColumnRows |
List<EosAttributeValueRow> |
Ne |
Pokud je atribut vícesloupcový, tak jsou hodnoty atributu uloženy v tomto seznamu. |
Objekt obsahuje hodnoty jednoho řádku vícesloupcového atributu.
Hodnoty jednotlivých sloupců jsou uloženy v objektu {@link WOSimpleAttributeValue}.
Seznam hodnot sloupců pro jeden řádek získáme pomocí metody {@link #getColumnValues()}.
Jméno atributu |
Datový typ |
Povinné |
Popis |
columnValues |
List<EosSimpleAttributeValue> |
Ne |
Obsahuje seznam hodnot sloupců atributu. |
Objekt obsahuje informace o budově.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
String |
Ne |
Identifikátor budovy. |
name |
String |
Ne |
Název budovy. |
externRegistryId |
String |
Ne |
Externí id budovy. Vazba do registrů. |
orNumber |
String |
Ne |
Číslo orientační. |
zipCode |
String |
Ne |
PSČ. |
houseNumber |
String |
Ne |
Číslo domovní. |
houseNumberType |
EosBuildingHouseNumberType |
Ne |
Typ čísla domovního. |
orNumberLetter |
String |
Ne |
Písmeno čísla orientačního. |
cityPart |
String |
Ne |
Městská část. |
municipalityPart |
String |
Ne |
Část obce. |
municipality |
String |
Ne |
Obec. |
district |
String |
Ne |
Okres. |
region |
String |
Ne |
Kraj. |
country |
String |
Ne |
Stát. |
mapUrl |
String |
Ne |
Odkaz do mapy. |
street |
String |
Ne |
Ulice. |
Typ čísla domovního.
Hodnota |
Popis |
BLANK |
Bez typu čísla domovního. |
DESCRIPTIVE |
Číslo popisné. |
EVIDENTIAL |
Číslo evidenční. |
ALTERNATIVE |
Číslo náhradní. |
Obsahuje informace o jednom kontaktu osoby.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
String |
Ne |
Id vlastní hodnoty kontaktu. |
contactId |
String |
Ne |
Id kontaktu (typ kontaktu, např. id kontaktu, který eviduje fax). |
value |
String |
Ne |
Hodnota kontaktu, pokud se jedná o telefonní kontakt, je zde vyplněno číslo ve formátu
- <číslo> není definována předvolba ani linka
- <číslo>-<linka> není definována předvolba
- <předvolba>-<číslo>-<linka>
a současně je vyplněna struktura phone. |
name |
String |
Ne |
Název kontaktu. |
displayName |
String |
Ne |
Zobrazený název kontaktu. |
phone |
EosPhone |
Ne |
V případě, že se jedná o telefonní kontakt, je vyplněna tato struktura. |
Objekt obsahuje informace o patře budovy.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
String |
Ne |
Identifikátor. |
name |
String |
Ne |
Název patra. |
Objekt obsahuje informace o umístění.
Jméno atributu |
Datový typ |
Povinné |
Popis |
building |
EosBuilding |
Ne |
Informace o budově. |
room |
EosRoom |
Ne |
Informace o místnosti. |
floor |
EosFloor |
Ne |
Informace o patře. |
Objekt obsahuje informace o osobě.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
String |
Ne |
Id osoby. |
degreeBefore |
String |
Ne |
Titul před jménem. |
firstname1 |
String |
Ne |
Jméno. |
firstname2 |
String |
Ne |
Druhéí jméno. |
surname1 |
String |
Ne |
Příjmení. |
surname2 |
String |
Ne |
Další příjmení. |
degreeAfter |
String |
Ne |
Titul za jménem. |
signature |
String |
Ne |
Iniciály. |
abbrev |
String |
Ne |
Zkratka. |
userName |
String |
Ne |
Uživatelské jméno. |
displayName |
String |
Ne |
Zorazované jméno. |
personalNumber |
String |
Ne |
Osobní číslo. |
entranceDate |
Date |
Ne |
Datum nástupu. |
terminationDate |
Date |
Ne |
Datum ukončení. |
email |
String |
Ne |
E-mail. |
locked |
Boolean |
Ne |
Je účet uzamčen pro přihlášení? |
disabled |
Boolean |
Ne |
Je osoba zakázaná? V případě zakázání nemá osoba žádná oprávnění ani aplikace. |
publicable |
Boolean |
Ne |
Publikovat osobu ve veřejné (internetové) verzi zobrazení? |
Objekt obsahuje ke každé osobě seznam přiřazených aplikací.
Jméno atributu |
Datový typ |
Povinné |
Popis |
personId |
String |
Ne |
Identifikátor osoby. |
applications |
List<EosApplication> |
Ne |
Seznam přiřazených aplikací. |
Objekt obsahuje přiřazené aplikace k osobám.
Jméno atributu |
Datový typ |
Povinné |
Popis |
personApplications |
List<EosPersonApplication> |
Ne |
Seznam přiřazených aplikací k osobám. |
Objekt obsahuje seznam hodnot atributu pro osobu a aplikaci za vybrané zařazení.
Jméno atributu |
Datový typ |
Povinné |
Popis |
personId |
String |
Ne |
Identifikátor osoby pro kterou jsou vráceny hodnoty atributů. |
applicationId |
String |
Ne |
Identifikátor aplikace. |
attributeValues |
List<EosAttributeValue> |
Ne |
Seznam hodnot atributů aplikace přiřazených na osobu. |
Objekt obsahuje seznam {@link WOPersonAttributeValue}.
Jméno atributu |
Datový typ |
Povinné |
Popis |
personAttributeValues |
List<EosPersonAttributeValue> |
Ne |
Seznam oprávnění za osobu a aplikaci. |
Objekt obsahuje informace o kontakctech osoby.
Jméno atributu |
Datový typ |
Povinné |
Popis |
personId |
String |
Ne |
Identifikátor osoby. |
contacts |
List<EosContact> |
Ne |
Informace o kontaktech osoby. |
Objekt obsahuje seznam {@link WOPersonContact}.
Jméno atributu |
Datový typ |
Povinné |
Popis |
personContact |
List<EosPersonContact> |
Ne |
Seznam kontaktů osob. |
Objekt obsahující seznam identifikátorů osob.
Jméno atributu |
Datový typ |
Povinné |
Popis |
personIds |
List<String> |
Ne |
Seznam identifikátorů osob. |
Objekt obsahující informace o umístění osoby.
Jméno atributu |
Datový typ |
Povinné |
Popis |
personId |
String |
Ne |
Identifikátor osoby. |
location |
EosLocation |
Ne |
Informace o umístění. |
Objekt obsahuje seznam {@link WOPersonLocation}.
Jméno atributu |
Datový typ |
Povinné |
Popis |
personLocation |
List<EosPersonLocation> |
Ne |
Seznam umístění osob. |
Objekt obsahuje informace o konatktu typu telefon.
Jméno atributu |
Datový typ |
Povinné |
Popis |
prefix |
String |
Ne |
Předvolba. |
number |
String |
Ne |
Číslo. |
line |
String |
Ne |
Linka. |
Objekt obsahuje informace o místnosti.
Jméno atributu |
Datový typ |
Povinné |
Popis |
id |
String |
Ne |
Identifikátor. |
name |
String |
Ne |
Název patra. |
capacity |
Integer |
Ne |
Kapacita místnosti. |
Objekt obsahuje seznam hodnot k danému atributu.
Tato hodnota již nemůže obsahovat jako hodnotu další atributy (narozdíl od {@link WOAttributeValue}).
Hodnoty jsou uloženy jako prostý text.
Jméno atributu |
Datový typ |
Povinné |
Popis |
attributeName |
String |
Ne |
Název atributu. |
values |
List<String> |
Ne |
Seznam hodnot atributu. |