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

Webová služba pro práci s číselníky.

## Seznam poskytovaných metod

Název | Popis
--- | ---
getBuilding | Vrátí budovu pokud patří do přihlášené organizace.
getBuildings | Načtení umístění - budov, pater a místností.
storeBuilding | Uložení / vytvoření budovy.
storeFloor | Uložení / vytvoření patra.
storeRoom | Uložení / vytvoření místnosti.

## Seznam struktur dat

Název | Popis
--- | ---
Cz.marbes.eos4.module.ws.v6.enums.wo.WOHouseNumberType | Typy domovního čísla.
EosBuilding | Budova.
EosBuildingStore | Budova.
EosBuildings | Kolekce umístění.
EosFloor | Patro.
EosFloorStore | Patro.
EosRoom |

## Výjimky

### EosInternalException

Neočekávaná výjimka při volání webových služeb.

## Popis poskytovaných metod

### getBuilding

Vrátí budovu pokud patří do přihlášené organizace.

#### Předpis

EosBuilding getBuilding (String id)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
id | String | Ano | id budovy

#### Výstup

EosBuilding - budova

#### Výjimky

EosInternalException - vniřní chyba systému

### getBuildings

Načtení umístění - budov, pater a místností.

#### Předpis

EosBuildings getBuildings (String sid)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
sid | String | Ne | session id

#### Výstup

EosBuildings - budovy buildings

#### Výjimky

EosInternalException - vniřní chyba systému

### storeBuilding

Uložení / vytvoření budovy.

#### Předpis

EosBuilding storeBuilding (EosBuildingStore building)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
building | EosBuildingStore | Ano | budova

#### Výstup

EosBuilding - uložená budova

#### Výjimky

EosInternalException - vniřní chyba systému

### storeFloor

Uložení / vytvoření patra.

#### Předpis

EosFloor storeFloor (EosFloorStore floor, String buildingId)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
floor | EosFloorStore | Ano | patro
buildingId | String | Ano |

#### Výstup

EosFloor - uložené patro

#### Výjimky

EosInternalException - vniřní chyba systému

### storeRoom

Uložení / vytvoření místnosti.

#### Předpis

EosRoom storeRoom (EosRoom room, String floorId)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
room | EosRoom | Ano | místnost
floorId | String | Ano |

#### Výstup

EosRoom - uložená místnost

#### Výjimky

EosInternalException - vniřní chyba systému

## Popis struktur dat

### Cz.marbes.eos4.module.ws.v6.enums.wo.WOHouseNumberType

Typy domovního čísla.

Hodnota | Popis
--- | ---
BLANK |
DESCRIPTIVE | Číslo popisné.
EVIDENTIAL | Číslo evidenční.
ALTERNATIVE | Číslo náhradní.

### EosBuilding

Budova.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
id | String | Ne | Identifikátor.
name | String | Ne | Název budovy.
abbrev | String | Ne | Zkratka budovy.
exchange | String | Ne | Ústředna budovy.
externRegistryId | String | Ne | Externí id budovy. Vazba do registrů.
orientationNumber | String | Ne | Orientační číslo.
zipCode | String | Ne | PSČ.
houseNumber | String | Ne | Domovní číslo.
houseNumberType | Cz.marbes.eos4.module.ws.v6.enums.wo.WOHouseNumberType | Ne | Typ domovního čísla.
orientationNumberLetter | String | Ne | Písmeno orientačního čísla.
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.
floors | List<EosFloor> | Ne | Patra.

### EosBuildingStore

Budova.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
id | String | Ne | Identifikátor.
name | String | Ne | Název budovy.
abbrev | String | Ne | Zkratka budovy.
exchange | String | Ne | Ústředna budovy.
externRegistryId | String | Ne | Externí id budovy. Vazba do registrů.
orientationNumber | String | Ne | Orientační číslo.
zipCode | String | Ne | PSČ.
houseNumber | String | Ne | Domovní číslo.
houseNumberType | Cz.marbes.eos4.module.ws.v6.enums.wo.WOHouseNumberType | Ne | Typ domovního čísla.
orientationNumberLetter | String | Ne | Písmeno orientačního čísla.
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.

### EosBuildings

Kolekce umístění.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
buildings | List<EosBuilding> | Ne | Budovy.

### EosFloor

Patro.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
id | String | Ne | Identifikátor.
name | String | Ne | Název.
rooms | List<EosRoom> | Ne | Místnosti.

### EosFloorStore

Patro.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
id | String | Ne | Identifikátor.
name | String | Ne | Název.

### EosRoom

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
id | String | Ne | Identifikátor.
number | String | Ne | Název.
capacity | Integer | Ne | Kapacita.
description | String | Ne | Popis.