OBERON Web Services

Táto referenčná príručka stručne popisuje objekty, metódy a udalosti vybraných webových služieb systému OBERON.

Webové služby umožňujú komunikáciu medzi systémom OBERON a ďalšími nadstavbovými modulmi, prípadne inými externými systémami pomocou protokolu SOAP (prípadne SOAP/JSON). Komunikácia prebieha pomocou sieťového protokolu Tcp-IP, pričom ako transportný protokol môže byť aj http alebo zabezpečené https.

Hlavnou výhodou webových služieb je nezávislosť na platforme a vývojovom jazyku, preto sa často používajú (či už v režime ako server alebo klient) na on-line komunikáciu s inými externými systémami. Táto dokumentácia obsahuje všetky metódy a triedy používaných v danej webovej službe. Implementovať a tak získať výpis daných tried webovej služby je možné použitím napr. vývojového nástroja Microsoft Visual Studio (po pridaní Service Reference), prípadne použiť z niektorých REST klient nástrojov, napr. http://www.getpostman.com/.

Ako hostiteľ webovej služby (v režime server) je využívaný program OBERON Center (napísaný vo Visual Studiu .NET), v ktorom je možné nadefinovať jednu, prípadne súčasne aj viac webových služieb. V systéme OBERON sa nachádza viac typov webových služieb:

OBERON [OBERONService]- základná služba systému OBERON (slúži aj ako server pre aplikáciu OBERON Web). Zoznam dostupných metód reprezentuje rozhranie IOBERONService.
Pokladnica OBERON [OBERONCashRegisterService] - webová služba určená pre komunikáciu s modulom Pokladnica OBERON, najčastejšie riešenie pre mobilného čašníka.
OBERON Vernostný systém (klient) - klient vernostného systému [Exa.OBERON.Shared.LoyaltyCardSystems.Drivers], ktorý obsahuje totožné štruktúry ako server [OBERONLoyaltySystemService] - z hľadiska implementácie server obsahuje popis metód, pričom štruktúry sú definované v klientovi.
Hasam EPOS [HasamEPOSService] - webová služba komunikuje s externým turniketovým a dverovým systémom (modul Hotelová recepcia).

Namespaces

Namespace	Description
Exa.OBERON.Hotel.ReservationBook	Predstavuje objekty knihy rezervácií. Obsahuje všetky údaje o rezerváciách danej izby v daný dátum, osôb na rezervovaných izbách, objednané služby, kalkuláciu cien atď.
Exa.OBERON.Services	Systém OBERON obsahuje niekoľko webových služieb (niekoľko samostatných serverov), rozdelených podľa svojho určenia a využitia, napr. IOBERONService, IOBERONCashRegisterService, IOBERONLoyaltySystemService, a ďalšie.
Exa.OBERON.Services.OBERON	Hlavná webová služba systému OBERON, ktorá slúži na množstvo rôznorodých úloh v systéme. Okrem iného slúži ako server pre webovú aplikáciu OBERON Web. Metódy, ktoré obsahuje táto webová služba popisuje rozhranie IOBERONService.
Exa.OBERON.Services.OBERONCashRegister	Webová služba systému OBERON, určená pre komunikáciu s modulom Pokladnica OBERON. Umožňuje pracovať s otvorenými účtami (stolami) - je predurčená na komunikáciu s externými aplikáciami ako mobilný čašník. Metódy, ktoré obsahuje táto webová služba popisuje rozhranie IOBERONCashRegisterService.
Exa.OBERON.Shared.LoyaltyCardSystems	Predstavuje spoločné metódy a štruktúry vernostného systému OBERON. K systému OBERON je možné pripojiť niekoľko vernostných systémov, pričom tento menný priestor obsahuje príslušné ovládače na pripojenie k nim, napr. CardBerg, OBERON vernostný systém (klient) a podobne. Táto referenčná príručka obsahuje popis štruktúr len k vernostnému systému 'OBERON Vernostný systém (klient)', teda nie ďalších vernostných systémov. Z tohoto dôvodu sú tu uvedené spoločné tzv. ENUM-s.
Exa.OBERON.Shared.LoyaltyCardSystems.Drivers	Predstavuje triedy (JSON štruktúry) vernostného systému 'OBERON vernostný systém (klient)'. Aby mohol OBERON komunikovať s externým systémom pomocou webových služieb, server musí obsahovať tieto štruktúry.