# Webová služba RoleActivityStructureRead 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.

## Obsah

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

## Obecné informace

Rozhraní webové služby pro čtení činností.

## Seznam poskytovaných metod

Název | Popis
--- | ---
getChildRoleActivities | Vrátí seznam potomků činnosti (jen podřízené činnosti).
getRoleActivityById | Najde činnost dle daného Id.
getRootRoleActivities | Načte všechny kořenové činnosti stromu.

## Seznam struktur dat

Název | Popis
--- | ---
EosIdentifier | Reprezentuje identifikátor webového objektu slučující interní a externí ID.
EosRoleActivities | Reprezentuje wrapper pro kolekci cinnosti.
EosRoleActivity | Reprezentuje cinnost.

## Výjimky

### EosInvalidParameterException

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

### EosObjectNotFoundException

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

### 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

### getChildRoleActivities

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

#### Předpis

EosRoleActivities getChildRoleActivities (EosIdentifier parentRoleActivityId, String clientId)

#### Parametry

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

#### Výstup

EosRoleActivities - seznam potomků

#### Výjimky

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

### getRoleActivityById

Najde činnost dle daného Id.

#### Předpis

EosRoleActivity getRoleActivityById (EosIdentifier roleActivityId, String clientId)

#### Parametry

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

#### Výstup

EosRoleActivity - činnost s daným id

#### Výjimky

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

### getRootRoleActivities

Načte všechny kořenové činnosti stromu.

#### Předpis

EosRoleActivities getRootRoleActivities (String clientId)

#### Parametry

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

#### Výstup

EosRoleActivities - seznam kořenových činností

#### Výjimky

EosUnexpectedException - nastala vnitřní chyba EOSu

## Popis struktur dat

### 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.

### EosRoleActivities

Reprezentuje wrapper pro kolekci cinnosti.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
roleActivity | List<EosRoleActivity> | Ne | Kolekce cinnosti.

### EosRoleActivity

Reprezentuje cinnost.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
id | EosIdentifier | Ano | Identifikátor.
name | String (255) | Ano | Název činnosti.
parentId | EosIdentifier | Ne | Identifikátor nadřazené činnosti.