# Webová služba Substitutions verze 3.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.

## Obsah

- Obecné informace
- Seznam poskytovaných metod
- Seznam struktur dat
- Výjimky
- Popis poskytovaných metod
- Popis struktur dat

## Obecné informace

Rozhraní pro webové služby zástupů.

## Seznam poskytovaných metod

Název | Popis
--- | ---
getPersonSubstitutions | Vrátí informace o tom koho daná osoba zastupuje.

## Seznam struktur dat

Název | Popis
--- | ---
EosGroupRole | Skupinová role.
EosOrgRole | Organizační role.
EosOrgRoleType | Typ organiční role.
EosPerson | Osoba.
EosSubstitutedPersonAssignment | Informace o zastupované osobě a roli v jaké je zastoupena.
EosSubstitutedPersonAssignments | Objekt obsahuje seznam zastupovaných osob a jejich zařazení.

## Výjimky

### EosInternalException

Reprezentuje neočekávanou výjimku při volání webových služeb.

### EosObjectNotFoundException

Objekt nebyl nalezen.

### EosSessionNotFoundException

Session s předaným id nebyla nalezena.

## Popis poskytovaných metod

### getPersonSubstitutions

Vrátí informace o tom koho daná osoba zastupuje.

#### Předpis

EosSubstitutedPersonAssignments getPersonSubstitutions (String sid, String personId, boolean onlyPrimAss)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
sid | String | Ne | session id
personId | String | Ano | id osoby
onlyPrimAss | boolean | Ne | příznak zda se mají vracet jen zástupy primárních zařazení

#### Výstup

EosSubstitutedPersonAssignments - informace o osobách které daná osoba zastupuje a v kterých rolích je zastupuje

#### Výjimky

EosObjectNotFoundException - osoba s daným id nebyla nalezena
EosSessionNotFoundException - session s daným id nebyla nalezena
EosInternalException - vnitřní chyba aplikace EOS4

## Popis struktur dat

### EosGroupRole

Skupinová role.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
id | String | Ne | Id entity, nepovinné pouze při vytváření entity.
name | String | Ne | Název organizační role.
orgUnitId | String | Ne | Organizační jednotka, do které role patří.
altName | String | Ne | Alternativní název organizační role.
desc | String | Ne | Popis organizační role.
publicable | Boolean | Ne | Publikovat skupinovou roli ve veřejné (internetové) verzi zobrazení?
code | String | Ne | Kód skupinové role.
sentence | Integer | Ne | Pořadí skupinové role v rámci nadřízené organizační jednotky. Pokud není potřeba, uvede se hodnota 0.

### EosOrgRole

Organizační role.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
id | String | Ne | Id entity, nepovinné pouze při vytváření entity.
name | String | Ne | Název organizační role.
orgUnitId | String | Ne | Organizační jednotka, do které role patří.
altName | String | Ne | Alternativní název organizační role.
desc | String | Ne | Popis organizační role.
publicable | Boolean | Ne | Publikovat skupinovou roli ve veřejné (internetové) verzi zobrazení?
code | String | Ne | Kód skupinové role.
sentence | Integer | Ne | Pořadí skupinové role v rámci nadřízené organizační jednotky. Pokud není potřeba, uvede se hodnota 0.
typeCode | String | Ne | Kód typu organizační role.
type | EosOrgRoleType | Ne | Typ organizační role.

### EosOrgRoleType

Typ organiční role.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
name | String | Ne | Název typu organizační role.
code | String | Ne | Kód typu organizační role.
desc | String | Ne | Popis typu organizační role.

### EosPerson

Osoba.

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í?

### EosSubstitutedPersonAssignment

Informace o zastupované osobě a roli v jaké je zastoupena. Pokud je zastoupena v organizační roli bude vyplněn field orgRole jinak bude zastoupena ve skupinové roli a bude vyplněn field groupRole. Pokud se jedná o primární zařazení bude nastaven příznak primaryAssignment na true, jinak bude false.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
person | EosPerson | Ne | Zastupovaná osoba.
orgRole | EosOrgRole | Ne | Zastupovaná organizační role osoby.
groupRole | EosGroupRole | Ne | Zastupovaná skupinová role osoby.
primaryAssignment | Boolean | Ne | Příznak zda jde o primární zařazení.

### EosSubstitutedPersonAssignments

Objekt obsahuje seznam zastupovaných osob a jejich zařazení.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
personSubstitutions | List<EosSubstitutedPersonAssignment> | Ne | Seznam zastupovaných osob a jejich zařazení.