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

## 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í informací o aplikacích.

## Seznam poskytovaných metod

Název | Popis
--- | ---
getApplicationEos3XmlById | Načte XML předpis aplikace ve formátu EOS3.
getApplicationXmlById | Načte XML předpis aplikace ve formátu EOS4.
getDependApplication | Vrátí návaznou aplikaci s daným kódem.
getDependApplicationByEosIdentifier | Vrátí návaznou aplikaci s daným kódem.
getDependApplicationByOrganization | Vrátí návaznou aplikaci s daným kódem.
getPersonLoaderApplications | Načte seznam aplikací, které se mají zobrazit v EOS loaderu.
getPersonLoaderApplicationsWithEnvironments | Načte seznam aplikací s prostředími, které se mají zobrazit v EOS loaderu.
getPersonPrimaryOrgRoleAssignmentLoaderApplications | Načte seznam aplikací na primárním zařazení osoby do organizační role, které se mají zobrazit v EOS loaderu.

## Seznam struktur dat

Název | Popis
--- | ---
EosApplication | Reprezentuje aplikaci.
EosApplicationWithEnvironments |
EosApplications | Reprezentuje wrapper pro kolekci aplikací.
EosApplicationsWithEnvironments | Reprezentuje wrapper pro kolekci aplikací s prostředími.
EosDatabaseType | Výčet typů databázových serverů.
EosDbConnection | Reprezentuje databázové připojení.
EosEnvironment |
EosIdentifier | Reprezentuje identifikátor webového objektu slučující interní a externí ID.

## Výjimky

### EosIllegalStateException

Výjimka reprezentuje chybný stav v datech EOSu.

### EosInvalidParameterException

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

### EosNoPrimaryAssignmentException

Vyjímka reprezentuje stav, kdy neexistuje primarni zarazeni osoby.

### EosObjectNotFoundException

Výjimka reprezentuje stav, kdy nebyl objekt podle kriterií nalezen.

### EosOrgStructureException

Vyjímka reprezentuje stav, kdy došlo k problému při práci s organizační strukturou.

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

### getApplicationEos3XmlById

Načte XML předpis aplikace ve formátu EOS3.

#### Předpis

String getApplicationEos3XmlById (EosIdentifier appId, String clientId)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
appId | EosIdentifier | Ano | id aplikace
clientId | String | Ano | identifikátor klienta, je povinný jen při předání externího id v appId

#### Výstup

String - XML předpis aplikace ve formátu EOS3

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - při předání neplatného identifikátoru
EosUnexpectedException - nastala vnitřní chyba EOSu

### getApplicationXmlById

Načte XML předpis aplikace ve formátu EOS4.

#### Předpis

String getApplicationXmlById (EosIdentifier appId, String clientId)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
appId | EosIdentifier | Ano | id aplikace
clientId | String | Ano | identifikátor klienta, je povinný jen při předání externího id v appId

#### Výstup

String - XML předpis aplikace ve formátu EOS4

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - při předání neplatného identifikátoru
EosUnexpectedException - nastala vnitřní chyba EOSu

### getDependApplication

Vrátí návaznou aplikaci s daným kódem.

#### Předpis

EosApplication getDependApplication (EosIdentifier appId, String dependAppCode, String clientId)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
appId | EosIdentifier | Ano | id aplikace
dependAppCode | String | Ano | kód návazné aplikace
clientId | String | Ano | identifikátor klienta, je povinný jen při předání externího id v appId

#### Výstup

EosApplication - návazná aplikace

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - při předání neplatného identifikátoru
EosIllegalStateException - návazná aplikace není ve všech prostředích jako je aplikace s id appId
EosUnexpectedException - nastala vnitřní chyba EOSu

### getDependApplicationByEosIdentifier

Vrátí návaznou aplikaci s daným kódem.

#### Předpis

EosApplication getDependApplicationByEosIdentifier (String appId, String dependAppCode, String clientId)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
appId | String | Ano | id aplikace
dependAppCode | String | Ano | kód návazné aplikace
clientId | String | Ano | identifikátor klienta, je povinný jen při předání externího id v appId

#### Výstup

EosApplication - návazná aplikace

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - při předání neplatného identifikátoru
EosIllegalStateException - návazná aplikace není ve všech prostředích jako je aplikace s id appId
EosUnexpectedException - nastala vnitřní chyba EOSu

### getDependApplicationByOrganization

Vrátí návaznou aplikaci s daným kódem.

#### Předpis

EosApplication getDependApplicationByOrganization (EosIdentifier appId, String dependAppCode, String organizationCode, String clientId)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
appId | EosIdentifier | Ano | id aplikace
dependAppCode | String | Ano | kód návazné aplikace
organizationCode | String | Ano | kód organizace ve které je uživatel pro kterého zjišťujeme návaznou aplikaci, nepovinné
clientId | String | Ano | identifikátor klienta, je povinný jen při předání externího id v appId

#### Výstup

EosApplication - návazná aplikace

#### Výjimky

EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - při předání neplatného identifikátoru
EosIllegalStateException - návazná aplikace není ve všech prostředích jako je aplikace s id appId
EosUnexpectedException - nastala vnitřní chyba EOSu

### getPersonLoaderApplications

Načte seznam aplikací, které se mají zobrazit v EOS loaderu.

#### Předpis

EosApplications getPersonLoaderApplications (String personId)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
personId | String | Ano | eos identifikátor osoby

#### Výstup

EosApplications - kolekce aplikací, která se má zobrazit v EOS loaderu pokud nebyla žádná nalezena, vrací prázdnou kolekci

#### Výjimky

EosOrgStructureException - při nalezení nekonzistencí v organizační struktuře
EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - při předání neplatného identifikátoru
EosUnexpectedException - nastala vnitřní chyba EOSu

### getPersonLoaderApplicationsWithEnvironments

Načte seznam aplikací s prostředími, které se mají zobrazit v EOS loaderu.

#### Předpis

EosApplicationsWithEnvironments getPersonLoaderApplicationsWithEnvironments (String personId)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
personId | String | Ano | eos identifikátor osoby

#### Výstup

EosApplicationsWithEnvironments - kolekce aplikací, která se má zobrazit v EOS loaderu pokud nebyla žádná nalezena, vrací prázdnou kolekci

#### Výjimky

EosOrgStructureException - při nalezení nekonzistencí v organizační struktuře
EosObjectNotFoundException - objekt nebyl nalezen
EosInvalidParameterException - při předání neplatného identifikátoru
EosUnexpectedException - nastala vnitřní chyba EOSu

### getPersonPrimaryOrgRoleAssignmentLoaderApplications

Načte seznam aplikací na primárním zařazení osoby do organizační role, které se mají zobrazit v EOS loaderu.

#### Předpis

EosApplications getPersonPrimaryOrgRoleAssignmentLoaderApplications (String personId)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
personId | String | Ano | eos identifikátor osoby

#### Výstup

EosApplications - kolekce aplikací, která se má zobrazit v EOS loaderu pokud nebyla žádná nalezena, vrací prázdnou kolekci

#### Výjimky

EosObjectNotFoundException - object nebyl nalezen
EosNoPrimaryAssignmentException - neexistuje primární zařazení
EosOrgStructureException - při nalezení nekonzistencí v organizační struktuře
EosUnexpectedException - nastala vnitřní chyba EOSu

## Popis struktur dat

### EosApplication

Reprezentuje aplikaci. Slouží pro přenos jen "nevirtuálních aplikací".

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
id | EosIdentifier | Ano | Identifikátor.
MAX_IMAGE_SIZE | int | Ne | Maximální velikost dat, přenášených jako ikony. Odpovídá maximální velikosti dat DO Image.
name | String (255) | Ano | Jméno aplikace.
parameters | String (256) | Ne | Parametry příkazové řádky.
author | String (127) | Ano | Autor aplikace.
description | String (1024) | Ne | Popis aplikace.
path | String (255) | Ne | Cesta k aplikaci. Kde je fyzicky spustitelný soubor na síti - v případě webové URL.
icon | String (2147483647) | Ne | Kde je uložena na disku nebo v síti ikona aplikace.
appServerName | String (256) | Ne | Jméno aplikačního serveru.
testing | Boolean | Ne | Je aplikace v testovacím režimu?
appCode | String (100) | Ano | Kód aplikace. Zkratka subsystému (RB, ROB...).
serverUrl | String (500) | Ne | URL aplikačního serveru pro webové služby.
version | String (50) | Ne | Verze aplikace.
dbConnection | EosDbConnection | Ne | Databáze přiřazená aplikaci.
guid | String | Ne | GUID aplikaci.

### EosApplicationWithEnvironments

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
id | EosIdentifier | Ano | Identifikátor.
MAX_IMAGE_SIZE | int | Ne | Maximální velikost dat, přenášených jako ikony. Odpovídá maximální velikosti dat DO Image.
name | String (255) | Ano | Jméno aplikace.
parameters | String (256) | Ne | Parametry příkazové řádky.
author | String (127) | Ano | Autor aplikace.
description | String (1024) | Ne | Popis aplikace.
path | String (255) | Ne | Cesta k aplikaci. Kde je fyzicky spustitelný soubor na síti - v případě webové URL.
icon | String (2147483647) | Ne | Kde je uložena na disku nebo v síti ikona aplikace.
appServerName | String (256) | Ne | Jméno aplikačního serveru.
testing | Boolean | Ne | Je aplikace v testovacím režimu?
appCode | String (100) | Ano | Kód aplikace. Zkratka subsystému (RB, ROB...).
serverUrl | String (500) | Ne | URL aplikačního serveru pro webové služby.
version | String (50) | Ne | Verze aplikace.
dbConnection | EosDbConnection | Ne | Databáze přiřazená aplikaci.
guid | String | Ne | GUID aplikaci.
environments | List<EosEnvironment> | Ano |
entryUrl | String (1000) | Ne | Vstupní adresa pro spuštění klienta nebo stažení exe souboru.

### EosApplications

Reprezentuje wrapper pro kolekci aplikací.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
application | List<EosApplication> | Ne | Kolekce aplikací.

### EosApplicationsWithEnvironments

Reprezentuje wrapper pro kolekci aplikací s prostředími.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
applicationWithEnvironment | List<EosApplicationWithEnvironments> | Ne | Kolekce aplikací.

### EosDatabaseType

Výčet typů databázových serverů.

Hodnota | Popis
--- | ---
ORACLE | Oracle DB server.
MSSQL | Microsoft SQL server.
POSTGRESQL | PostgreSQL server.

### EosDbConnection

Reprezentuje databázové připojení.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
id | EosIdentifier | Ano | Identifikátor.
name | String (127) | Ano | Název databáze.
dbType | EosDatabaseType | Ano | Typ databázového serveru.
username | String (255) | Ano | Přihlašovací jméno do databáze.
password | String (255) | Ne | Heslo do databáze. Jen pro účel zápisu. Při čtení je vždy nevyplněné.
connectionString | String (1024) | Ano | JDBC connection string.

### EosEnvironment

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
id | String (255) | Ne | Id prostředí.
name | String (255) | Ano | Název prostředí.
description | String (1024) | Ne | Popis prostředí.
code | String (100) | Ano | Kód prostředí.
testing | Boolean | Ano | Příznak jestli je prostředí testovací, nebo produktivní.

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