Dolores - Komunikačný protokol

Verzie

Dátum	Verzia	Popis	Autor
01.10.06	01.01.00	Založenie tejto dokumentácie	Juraj Pacolt
17.01.07	01.01.13	Doplnenie dokumentácie	Juraj Pacolt
30.01.07	01.02.13	Doplnenie dokumentácie	Juraj Pacolt
15.03.07	01.03.13	Doplnenie dokumentácie	Juraj Pacolt
31.05.07	01.04.13	Doplnenie dokumentácie	Juraj Pacolt
07.06.07	01.05.13	Doplnenie dokumentácie	Juraj Pacolt
29.01.08	01.06.13	Doplnenie dokumentácie	Juraj Pacolt
07.12.09	01.07.13	Nová špecifikácia, doplnenie dok.	Juraj Pacolt
06.06.10	01.08.13	Úpravy	Vladimír Prokeš
08.10.12	01.02.00	Doplnenie – Next1 a Next2	Vladimír Prokeš
25.10.12	02.01.13	Zmeny Next2	Vladimír Prokeš
25.10.12	02.02.13	Drobná oprava	Vladimír Prokeš
11.02.13	02.03.13	Doplnenie check2 a booking3 + štruktúry.	Juraj Pacolt
05.03.13	02.04.13	Doplnenie metódy „getServicePackages“ a prislúchajúcich štruktúr.	Juraj Pacolt
07.03.13	02.05.13	Doplnenie metódy „booking4“ a štruktúr.	Juraj Pacolt
14.03.13	02.06.13	Zmena „booking4“ - štruktúry.	Juraj Pacolt
18.03.13	02.07.13	Doplnenie „booking5“ + „check3“ + príslušné číselníky + štruktúry.	Juraj Pacolt
21.03.13	02.08.13	Zmena oslovenia hosťa.	Juraj Pacolt
03.05.13	02.09.13	Doplnenie „booking6“ a „getAgeCategories“	Jozef Kvasničák
12.07.13	10.15.02	Rozšírenie BookingGuestRequest pre „booking6“	Jozef Kvasničák

Štruktúry parametrov

Vysvetlenie:

• string(26) - predstavuje string s dĺžkou 26 znakov

• string() - string so zatiaľ nezistenou dĺžkou

• Booking2RequestAccommodations[] - hranaté zátvorky predstavujú pole

• dateTime, int - polia bez definovanej dlzky

Advertising

Štruktúra náboru.

• id int – ID záznamu, ktoré je potrebné používať v rámci prepojenia
• name string() – názov náboru
• description string() – popis náboru

Country

Štruktúra záznamu štátu z číselníka štátov.

• codeOfState string() – medzinárodný kód štátu
• currencyCode string() – medzinárodný kód meny
• nameOfState string() – názov štátu
• visa boolean – sú vyžadované víza

HotelInfo

Štruktúra obsahuje základné informácie o ubytovacom zariadení.

• addressOfCompany string() – adresa spoločnosti
• cityOfCompany string() – mesto/obec spoločnosti
• company string() – názov spoločnosti
• emailAddress string() – emailový kontakt
• faxNumber string() – číslo faxu
• hotelName string() – názov ubytovacieho zariadenia
• telephoneNumber string() – telefónne číslo
• weblink string() – linka na webovú stránku

PaymentType

Štruktúra obsahuje všetky informácie o type izby.

• id int – ID spôsobu (typu) platby
• code string() – kód spôsobu (typu) platby
• name string() – názov spôsobu (typu) platby
• fiscal boolean – či je spôsob (typ) platby vedený v systéme Horec ako fiskálny
• enabled boolean – či je spôsob (typ) platby povolený v systéme Horec

RoomType

Štruktúra obsahuje všetky informácie o type izby.

• codeOfRoomType string() – kód typu izby
• nameOfRoomType string() – názov typu izby
• numberOfAdditionalBeds int – počet prístelkou na izbe
• numberOfAllBeds int – počet všetkých lôžok na izbe
• numberOfBeds int – počet postelí
• roomType string() – typ izby
• roomTypeNumber int – číslo typu izby

Category

Štruktúra záznamu z číselníka kategórií.

• code string() – kód kategórie
• name string() – názov kategórie

MarketingCategory

Štruktúra záznamu z číselníka marketingových kategórií.

• code string() – kód marketingovej kategórie
• name string() – názov marketingovej kategórie
• typeCode string() – kód typu marketingovej kategórie
• typeName string() – názov typu marketingovej kategórie

AgeCategory

Štruktúra slúži na zadanie vekovej hladiny hosťa v rámci štruktúry BookingGuestRequest.

• code string() – kód vekovej hladiny
• name string() – názov vekovej hladiny
• ageFrom string() – vekové rozpätie v rokoch - od
• ageTo string() – vekové rozpätie v rokoch - do

Service

Štruktúra obsahuje informácie o službe z číselníka služieb.

• id int – unikátne ID záznamu v danom systéme Horec, každý systém Horec má svoje služby
• name string() – názov služby
• code string() – kód služby
• price decimal – cena služby s DPH
• vat decimal – percento DPH
• afterMidnight boolean – odporúčanie, či má byť služba poskytovaná po polnoci
• rasterName string() – názov rastru ... skupinové členenie

ServicePackage

Štruktúra definuje balík služieb.

• name string() – Názov balíka služieb.
• code string() – Kód balíka služieb.
• lengthOfValidity int – Dĺžka platnosti balíka služieb.
• priceOfAll decimal – Cena za celú dĺžku platnosti balíka.
• services Service2[] – Jednotlivé služby v balíku.

Service2

Štruktúra definuje objekt, ktorý obsahuje údaje o službe v rámci balíkov služieb.

• name string() – Názov služby.
• code string() – Kód služby.
• numberOfServices int – Počet služieb za dĺžku platnosti balíka.
• unitPrice decimal – Jednotková cena služby.

BookingRequest

Štruktúra objednávky určená pre metódu booking.

• accommodationTime string() – očakávaný čas príchodu hosťa (povinný 24 hodinový formát HH:MM)
• apendix string() – doplňujúce požiadavky, prípadne poznámka k objednávke
• bookingRequestAccommodations BookingRequestAccommodations[] - pole výberu ubytovania objednávky
• city string() – mesto kontaktnej adresy
• codeOfState string() – medzinárodný kód štátu (povinný upper case)
• company string() – názov spoločnosti z ktorej hosť pochádza
• email string() – emailový kontakt
• fax string() – faxové číslo
• name string() – meno hosťa
• paymentType string() – typ platby (HO, KR, SE, FA, VA)
• postalCode string() – poštové smerovacie číslo
• street string() - ulica
• surname string() - priezvisko
• telephone string() – telefónne číslo

BookingRequestAccommodations

Štruktúra predstavuje počet objednaných izieb za typ izby.

• numberOfRooms int – počet izieb v rámci zvoleného typu
• roomType string() – typ izby podľa číselníka

BookingResponse

Štruktúra nesie návratové hodnoty odpovede metódu booking.

• bookingId int – identifikačné číslo objednávky
• evidenceNumberOfBooking string() – evidenčné číslo objednávky
• variableSymbol int – variabilný symbol vygenerovaný objednávke

Booking2Request

Štruktúra požiadavky určená pre booking metódu 2, taktiež ju využíva booking metóda 3.

• accommodationTime string() – očakávaný čas príchodu, očakáva sa 24 hodinový formát HH:MM
• apendix string() – doplnujúci text objednávky, môže byť napr. využitý na špeciálne požiadavky hostí
• bookingRequestAccommodations Booking2RequestAccommodations[] – pole výberu ubytovania objednávky
• city string() – mesto adresy
• codeOfState string() – medzinárodný kód štátu (povinný upper case) adresy
• company string() – spoločnosť, pokiaľ hosť prichádza z nejakej
• dateFrom dateTime – dátum od kedy chce byť hosť ubytovaný
• dateTo dateTime – dátum posledného dňa pobytu
• email string() – emailový kontakt
• fax string() – faxový kontakt
• idAdvertising int – prepojenie na číselník náborov (nie je povinné)
• name string() – meno hosťa
• paymentType string() – typ platby (HO – hotovosť, KR – kreditná karta, SE – šek, FA – faktúra, VA – valuty)
• postalCode string() – poštové smerovacie číslo
• recordBookingType string() – určuje typ zápisu objednávky (‘T’ – bude sa zapisovať na typ izby, ‘R’ – systém bude automaticky voliť izby na zápis objednávky)
• street string() – ulica kontaktnej adresy
• surname string() - priezvisko
• telephone string() – telefónny kontakt

Booking2RequestAccommodations

Štruktúra zastrešuje výber objednaných kapacít. FlexiRate ceny v rámci danej štruktúry niesu povinné. Tzn. pokiaľ sa nepoužijú resp. nastavia sa na NULL (nil) automaticky sa bude brať do úvahy v rámci rezervácie buď zvolený cenový profil, alebo pokiaľ nie je určený ani ten, tak sa použije defaultne nastavený systémom Horec.

• numberOfRooms int – výber počtu izieb
• roomType string() – typ izby, podľa číselníka typov izieb
• rooms Booking2RequestRoom[] – pole voľby postelí za jednotlivé izby
• flexiRatePrices FlexiRatePrice[] – FlexiRate ceny za daný výber typu izby

Booking2RequestRoom

Štruktúra výberu zápisu postelí na izbu.

• customNumberOfAllBeds int – voliteľný počet izieb (platí iba pre typ zápisu 3)
• bedsBookingType int – typ zápisu postelí na izbu (1 – systém automaticky zapíše plnú kapacitu postelí aj prístelok, 2 – systém automaticky zapíše plný počet postelí ale bez prístelok, 3 – systém akceptuje zvolený počet klientom podľa parametru)

Booking3Response

Štruktúra nesie návratové hodnoty odpovede pre metódu booking3.

• bookingId int – identifikačné číslo objednávky
• evidenceNumberOfBooking string() – evidenčné číslo objednávky
• variableSymbol int – variabilný symbol vygenerovaný objednávke
• reservationNumber int – rezervačné číslo vygenerované pre objednávku

FlexiRatePrice

Štruktúra zastrešuje údaje FlexiRate ceny.

• date dateTime – dátum za ktorý je zadaná cena platná
• price decimal – cena
• bedPrices FlexiRatePricePerBed[] – ceny za lôžka

FlexiRatePricePerBed

Štruktúra zastrešuje údaje ceny za lôžko.

• bedCode string() – kód lôžka pochádzajúci so systému Horec
• price decimal – cena za dané lôžko

Booking4Request

Štruktúra požiadavky určená pre booking metódu 4.

• accommodationTime string() – očakávaný čas príchodu, očakáva sa 24 hodinový formát HH:MM
• apendix string() – doplnujúci text objednávky, môže byť napr. využitý na špeciálne požiadavky hostí
• bookingRequestAccommodations Booking2RequestAccommodations[] – pole výberu ubytovania objednávky
• city string() – mesto adresy
• codeOfState string() – medzinárodný kód štátu (povinný upper case) adresy
• company 'string() – spoločnosť, pokiaľ hosť prichádza z nejakej
• dateFrom dateTime – dátum od kedy chce byť hosť ubytovaný
• dateTo dateTime – dátum posledného dňa pobytu
• email string() – emailový kontakt
• fax string() – faxový kontakt
• idAdvertising int – prepojenie na číselník náborov (nie je povinné)
• name string() – meno hosťa
• paymentType string() – typ platby (HO – hotovosť, KR – kreditná karta, SE – šek, FA – faktúra, VA – valuty)
• postalCode string() – poštové smerovacie číslo
• recordBookingType string() – určuje typ zápisu objednávky (‘T’ – bude sa zapisovať na typ izby, ‘R’ – systém bude automaticky voliť izby na zápis objednávky
• street string() – ulica kontaktnej adresy
• surname string() - priezvisko
• telephone string() – telefónny kontakt
• servicePackageCodes string[] – zoznam kódov balíkov služieb
• priceProfileId int – Identifikačné číslo cenového profilu pochádzajúce zo systému Horec. Tu platí podmienka, pokiaľ je cenový profil vyplnený, ceny FlexiRate budú ignorované. Pokiaľ nie je vyplnený cenový profil a ani FlexiRate ceny, potom systém Horec uplatní pre rezerváciu default cenový profil.

Booking5Request

Štruktúra požiadavky na vytvorenie rezervácie určenej pre metódu booking5.

• accommodationTime string() – očakávaný čas príchodu, očakáva sa 24 hodinový formát HH:MM
• apendix string() – doplňujúci text objednávky, môže byť napr. využitý na špeciálne požiadavky hostí
• bookingRequestAccommodations Booking2RequestAccommodations[] – pole výberu ubytovania objednávky
• city string(26) – mesto adresy
• codeOfState string(3) – medzinárodný kód štátu (povinný upper case) adresy
• company string() – spoločnosť, pokiaľ hosť prichádza z nejakej
• dateFrom dateTime – dátum od kedy chce byť hosť ubytovaný
• dateTo dateTime – dátum posledného dňa pobytu
• email string(40) – emailový kontakt
• fax string() – faxový kontakt
• name string(16) – meno hosťa
• paymentType string(2) – typ platby (HO – hotovosť, KR – kreditná karta, SE – šek, FA – faktúra, VA – valuty)
• postalCode string(5) – poštové smerovacie číslo
• recordBookingType string() – určuje typ zápisu objednávky (T – bude sa zapisovať na typ izby, R – systém bude automaticky voliť izby na zápis objednávky
• street string(26) – ulica kontaktnej adresy
• surname string(26) - priezvisko
• telephone string(26) – telefónny kontakt
• servicePackageCodes string[] – zoznam kódov balíkov služieb
• priceProfileId int – Identifikačné číslo cenového profilu pochádzajúce zo systému Horec. Tu platí podmienka, pokiaľ je cenový profil vyplnený, ceny FlexiRate budú ignorované. Pokiaľ nie je vyplnený cenový profil a ani FlexiRate ceny, potom systém Horec uplatní pre rezerváciu default cenový profil nastavený vo webrez.propeties súbore.
• salutationCode string() – kód oslovenia hosťa, pochádza z číselníka zo systému Horec, identifikuje oslovenie hosťa
• categoryCode string() – kód kategórie
• marketingCategories MarketingCategoryRequest[] – marketingové kategórie

Booking6Request

Štruktúra požiadavky na vytvorenie rezervácie určenej pre metódu booking6.

• accommodationTime string() – očakávaný čas príchodu, očakáva sa 24 hodinový formát HH:MM. V Horci sa ukladá ako date.
• groupAppendix string() – doplňujúci text skupinovej objednávky, môže byť napr. využitý na špeciálne požiadavky hostí, pozor má význam len pri objednávaní v režime skupinových objednávok
• bookingRooms Booking3RequestRoom[] – pole izieb objednávky; mininálne 1
• paymentType string(2) – typ platby (HO – hotovosť, KR – kreditná karta, SE – šek, FA – faktúra, VA – valuty)
• recordBookingType string() – určuje typ zápisu objednávky (T – bude sa zapisovať na typ izby, R – systém bude automaticky voliť izby na zápis objednávky)

MarketingCategoryRequest

Štruktúra slúži na použitie zadania marketingových kategórií v rámci požiadavky ubytovania v rámci štruktúry Booking5Request.

• code string() – kód marketingovej kategórie
• typeCode string() – kód typu marketingovej kategórie

Booking3RequestRoom

Štruktúra objednanej izby – lôžka, hostia, ceny.

• bedsBookingType int – typ zápisu lôžok na izbu (1 – systém automaticky zapíše plnú kapacitu postelí aj prístelok, 2 – systém automaticky zapíše plný počet postelí ale bez prístelok, 3 – systém akceptuje zvolený počet klientom podľa parametru)
• customNumberOfAllBeds int – voliteľný počet lôžok (platí iba pre typ zápisu 3)
• roomType string() – kód typu izby, podľa číselníka typov izieb
• bookingGuests BookingGuestRequest[] – zoznam hostí na danej izbe, ktorým chceme určiť špeciálne parametre; prvý hosť v poli je default hosť pre izbu; v tomto poli musí byť mininálne 1 hosť a maximálne počet objednaných lôžok na izbe
• flexiRatePrices FlexiRatePrice[] – FlexiRate ceny za danú izbu

BookingGuestRequest

Štruktúra objednaného hosťa pre metódu booking6.

• ageCategoryCode string() – kód vekovej hladiny; podľa číselníka
• appendix string() – doplňujúci text objednaného hosťa, môže byť napr. využitý na špeciálne požiadavky hostí
• categoryCode string() – kód kategórie hosťa, podľa číselníka
• city string() – mesto adresy
• codeOfState string() – medzinárodný kód štátu (povinný upper case) adresy
• company string() – spoločnosť, pokiaľ hosť prichádza z nejakej
• email string() – emailový kontakt
• fax string() – faxový kontakt
• marketingCategories MarketingCategoryRequest[] – marketingové kategórie hosťa
• name string() – krstné meno hosťa
• postalCode string() – poštové smerovacie číslo
• priceProfileId int – Identifikačné číslo cenového profilu pochádzajúce zo systému Horec. Tu platí podmienka, pokiaľ je cenový profil vyplnený, ceny FlexiRate budú ignorované. Pokiaľ nie je vyplnený cenový profil a ani FlexiRate ceny, potom systém Horec uplatní pre rezerváciu default cenový profil.
• salutationCode string() – kód oslovenia hosťa, pochádza z číselníka zo systému Horec, identifikuje oslovenie hosťa
• servicePackageCodes BookingService[] – zoznam kódov balíkov služieb
• services string[] – zoznam objednávaných služieb pre hosťa aj s ich parametrami
• street string() – ulica kontaktnej adresy
• surname string() – priezvisko hosťa, povinné
• telephone string() – telefónny kontakt

BookingService

Štruktúra obsahuje informácie o službe, ktorá je objednávaná ku objednávke v systéme Horec. Ak má objednávka viac hostí, tak každú takúto službu pre každého hosťa zduplikuje.

• id int – unikátne ID záznamu v danom systéme Horec, každý systém Horec má svoje služby
• dateFrom date – dátum – pobytový deň - od kedy má byť služba poskytovaná
• dateTo date – dátum – pobytový deň - do kedy má byť služba poskytovaná včítane (pobytový deň je od obeda do obeda na sledujúceho dňa)
• isPaid boolean – či má byť služba platená – a/n
• afterMidnight boolean – či má byť služba poskytovaná po polnoci

BookingStatusResponse

Štruktura je odpoveďou na metódu bookingStatus.

• bookingRooms BookingRoom[] – pole izieb objednávky
• paymentAccepted boolean – hovorí o tom, či bola platba akceptovaná systémom Horec
• variableSymbol int – variabilný symbol objednávky

BookingRoom

Štruktúra popisuje stav izby objednávky.

• floor int – poschodie izby, pokiaľ je zvolená nejaká konkrétna
• nameOfRoomType string() – názov typu izby
• roomNumber string() – číslo izby
• roomType string() – typ izby
• status int – stav izby v rámci objednávky (1 - potvrdená, 2 – čakajúca na potvrdenie, 3 – zrušená)

CheckFounds

Štruktúra obsahuje informácie o dostupnosti konkrétneho typu izby.

• freeRooms int – počet voľných izieb daného typu podľa parametrov metódy „check“
• nameOfRoomType string() – názov typu izby
• numberOfAdditionalBeds int – počet prístelkou na izbe
• numberOfBeds int – počet postelí na izbe
• roomType string() – typ izby

FreeRoomTyp

Štruktúra obsahuje informácie koľko voľných izieb za daný typ izby je dostupných v daný deň.

• roomType string() – kód typu izby.
• numberOfFree int – počet voľných izieb za daný typ izby.
• date dateTime – dátum, za ktorý sa daný počet voľných izieb berie do úvahy.

Metody komunikacie

Metóda „test“

string test (string msg)

Táto metóda slúžy na základné pretestovanie funkčnosti komunikácie. Zasielaným vstupným parametrom je reťazec, ktorý je v návratovej hodnote reverzovaný.

Parametre:

• msg – textový reťazez

metóda getAdvertisings

Advertisings[] getAdvertisings()

Metóda vracia číselník náborov, ktorého hodnoty je možné použiť v rámci metódy booking alebo booking2. Číselník náborov, resp. jeho hodnoty slúžia na kategorizáciu hostí v rámci bookingu.

Metóda getCountries

Country[] getCountries()

Country[] getCountries(string requiredLang, string defaultLang)

Vracia zoznam dostupných štátov resp. číselník štátov. Táto metóda sa môže použiť v dvoch tvaroch. Prvý tvar je bez použitia parametrov. V druhom tvare môžeme využiť dva povinné parametre. Pričom prvý určuje jazyk v ktorom požadujeme vrátiť číselník štátov, druhy určuje jazyk v ktorom sa vráti číselník pokiaľ nie je podporovaný požadovaný jazyk v prvom parametri. Pokiaľ obidva parametre obsahujú nepodporovaný jazyk, návratový číselník bude v nastavenom predvolenom jazyku aplikačného servera systému Horec.

Kódy jazykov sa berú podľa medzinárodnej ISO normy: http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt

Parametre:

• requiredLang – kód jazyka, ktorý požadujeme ako prioritný
• defaultLang – kód jazyka, pokiaľ requiredLang nie je podporovaný

Metóda getHotelInfo

HotelInfo getHotelInfo()

Táto metóda protokolu komunikačného interface-u v návratových hodnotách vracia základné informácie o hotely, resp. ubytovacom zariadení.

Metóda getRoomTypes

RoomType[] getRoomTypes()

Vracia číselník dostupných typov izieb na hotely.

Metóda check

CheckFound[] check(dateTime dtDateFrom, dateTime dtDateTo, int persons, int reservationType)

CheckFound[] check(string dateFrom, string dateTo, int persons, int reservationType)

CheckFound[] check(string dateFrom, string dateTo, string dateFormat, int persons, int reservationType)

Metóda check na základe vstupných parametrov zisťuje a vracia v návratovom poli zoznam voľných typov izieb na zadané obdobie. Zároveň zahŕňa vo vstupných parametroch typ rezervácie (skupinová, jedna izba) a celkový počet prichodiacich hostí. Metódu je možné použiť v troch variáciách.

Pri metóde check v ktorej parametroch sa neuvádza formát dátumov a jednotlivé dátumy sú typu string sa tieto musia povinne uvádzať vo formáte yyyy-MM-dd, príklad 2009-12-07, čo je siedmi december 2009.

Parametre:

• dtDateFrom – dátum od ktorého vrátane má systém hľadať voľné kapacity
• dtDateTo – dátum do ktorého vrátane má systém hľadať voľné kapacity
• dateFrom – dátum od ktorého vrátane má systém hľadať voľné kapacity
• dateTo – dátum do ktorého vrátane má systém hľadať voľné kapacity
• dateFormat – formát dátumu, ktorý je použitý v rámci parametrov dateFrom a dateTo
• persons – celkový počet osôb v objednávke
• reservationType – typ vyhľadávania rezervácie

Možnosti dátumových formátov:
Znak	Popis	Čo predstavuje	Príklad
G	Letopočet	Text	AD
y	Rok	Rok	1996; 96
M	Mesiac v roku	Mesiac	July; Jul; 07
w	Týždeň v roku	Číslo	27
W	Týždeň v rámci mesiaca	Číslo	2
D	Deň v roku	Číslo	189
d	Deň v rámci mesiaca	Číslo	10
F	Deň v týždni v rámci mesiaca	Číslo	2
E	Deň v týždni	Text	Tuesday; Tue
a	Prepínač AM / PM	Text	PM
H	Hodiny rámci dňa (0-23)	Číslo	0
k	Hodiny rámci dňa (1-24)	Číslo	24
K	Hodiny rámci dňa (0-11)	Číslo	0
h	Hodiny rámci dňa (1-12)	Číslo	12
m	Minúty v rámci hodiny	Číslo	30
s	Sekundy v rámci minúty	Číslo	55
S	Milisekundy	Číslo	978
z	Časové pásmo	Hlavné časové pásmo	Pacific Standard Time; PST; GMT-08:00
Z	Časové pásmo	Časové pásmo podľa RFC 822	0800

Typ vyhľadávania rezervácie:

• 1 – neskupinová objednávka
• 2 – skupinová objednávka

Metóda check2

FreeRoomType[] check2(dateTime dtDateFrom, dateTime dtDateTo, string roomType)

FreeRoomType[] check2(string dateFrom, string dateTo, string roomType)

FreeRoomType[] check2(string dateFrom, string dateTo, string dateFormat, string roomType)

Metóda check2 na základe vstupných parametrov zisťuje a vracia v návratovom poli zoznam voľných typov izieb s počtom voľných izieb za každý typ izby zvlášť za dané obdobie. Pričom v algoritme, ktorý vyhľadáva voľné kapacity sa za obsadené izby počítajú len izby s pobytmi a potvrdenými objednávkami.

Pri metóde check2 v ktorej parametroch sa neuvádza formát dátumov a jednotlivé dátumy sú typu string sa tieto musia povinne uvádzať vo formáte yyyy-MM-dd, príklad 2009-12-07, čo je siedmi december 2009.

Čo sa týka použitia vlastného formátu dátumov pri metóde check2 je tak isto ako pri jej prvej variante možné použiť možnosti formátovania podľa uvedenej tabuľky pri metóde check.

Parametre:

• dtDateFrom – dátum od ktorého vrátane má systém hľadať voľné kapacity
• dtDateTo – dátum do ktorého vrátane má systém hľadať voľné kapacity
• dateFrom – dátum od ktorého vrátane má systém hľadať voľné kapacity
• dateTo – dátum do ktorého vrátane má systém hľadať voľné kapacity
• dateFormat – formát dátumu, ktorý je použitý v rámci parametrov dateFrom a dateTo
• roomType – kód typu izby

Metóda check3

FreeRoomType[] check3(dateTime dtDateFrom, dateTime dtDateTo, string roomType, int coefficientType)

FreeRoomType[] check3(string dateFrom, string dateTo, string roomType, int coefficientType)

FreeRoomType[] check3(string dateFrom, string dateTo, string dateFormat, string roomType, int coefficientType)

Metóda „check3“ na základe vstupných parametrov zisťuje a vracia v návratovom poli zoznam voľných typov izieb s počtom voľných izieb za každý typ izby zvlášť za dané obdobie. Pričom v algoritme, ktorý vyhľadáva voľné kapacity sa voľná kapacita vypočítava nasledujúcim vzorcom:

Tento vzorec platí pokiaľ nie je uvedený typ koeficientu (je NULL):

VKRT = CMVK – NRT – ORT – PZORT

Ak je uvedený typ koeficientu, výpočet voľných kapacít bude prebiehať následovne:

VKRT = (ZK * (CMVK – NRT – ORT – PZORT)) – PNORT – NO – KO

VKRT – voľná kapacita za zadaný typ izby CMVK – maximálna celková možná voľná kapacita za daný typ izby ZK – zvolený typ koeficientu, resp. hodnota zvoleného koeficientu NRT – neaktívne izby za daný typ ORT – obsadené izby za daný typ PZORT – potvrdené a zaplatené objednávky za daný typ izby PNORT – potvrdené a nezaplatené objednávky za daný typ izby NO – nepotvrdené objednávky KO – objednávky v kontrakte

Pri metóde „check3“ v ktorej parametroch sa neuvádza formát dátumov a jednotlivé dátumy sú typu string sa tieto musia povinne uvádzať vo formáte yyyy-MM-dd, príklad 2009-12-07, čo je siedmi december 2009.

Čo sa týka použitia vlastného formátu dátumov pri metóde „check3“ je tak isto ako pri jej prvej variante možné použiť možnosti formátovania podľa uvedenej tabuľky pri metóde „check“.

Parametre:

dtDateFrom – dátum od ktorého vrátane má systém hľadať voľné kapacity dtDateTo – dátum do ktorého vrátane má systém hľadať voľné kapacity dateFrom – dátum od ktorého vrátane má systém hľadať voľné kapacity dateTo – dátum do ktorého vrátane má systém hľadať voľné kapacity dateFormat – formát dátumu, ktorý je použitý v rámci parametrov dateFrom a dateTo roomType – kód typu izby coefficientType – Typ koeficientu, ktorý sa bude uplatňovať pri výpočte voľných kapacít v Horci, jeho hodnoty možu byť 1 alebo 2. V prípade pokiaľ sa uvedie 1 bude sa pri výpočte uplatňovať prvý koeficient, v pripade 2 druhý. Tiež tento koeficient nemusí byť uvedený resp. bude NULL.

Metóda booking

BookingResponse booking (BookingRequest bookingRequest, string dateFrom, string dateTo)

BookingResponse booking (BookingRequest bookingRequest, string dateFrom, string dateTo, string dateFormat)

BookingResponse booking (BookingRequest bookingRequest, dateTime dtDateFrom, dateTime dtDateTo)

Táto metóda prevádza ostrú rezerváciu na hotely. V rámci rezervácie sa na aplikačnom jadre hotela prevádza zápis rezervácie priamo do systému hotela, zároveň podľa nastavení sa posiela informačný e-mail o rezervácii na hotel alebo aj objednávateľovi rezervácie.

Parametre:

• bookingRequest – štruktúra obsahujúca informácie o objednávke
• dateFrom – dátum od ktorého vrátane má systém hľadať voľné kapacity
• dateTo – dátum do ktorého vrátane má systém hľadať voľné kapacity
• dateFormat – formát dátumu, ktorý je použitý v rámci parametrov dateFrom a dateTo
• dtDateFrom – dátum od ktorého vrátane má systém hľadať voľné kapacity
• dtDateTo – dátum do ktorého vrátane má systém hľadať voľné kapacity

Možnosti dátumových formátov je možné pozrieť pri popise metódy check.

Pri metóde booking v ktorej parametroch sa neuvádza formát dátumov a jednotlivé dátumy sú typu string sa tieto musia povinne uvádzať vo formáte yyyy-MM-dd, príklad 2009-12-07, čo je siedmy december 2009.

Metóda booking2

BookingResponse booking2(Booking2Request booking2Request, string dateFrom, string dateTo)

BookingResponse booking2(Booking2Request booking2Request, string dateFrom, string dateTo, string dateFormat)

BookingResponse booking2(Booking2Request booking2Request, dateTime dtDateFrom, dateTime dtDateTo)

Aby bola zachovaná spätná kompatibilita s prevedením rezervácie nebola modifikovaná pôvodná metóda bookingu ale bol vytvorený jej klon, ktorý pôvodnú funkčnosť rozširuje. Takže aj táto metóda, ako jej predchodca má za úlohu zapísať do systému Horec objednávku podľa zadaných parametrov, s tým rozdielom, že funkčnosť je ešte rozšírená o možnosť rozpísať jednotlivé počty osôb na určité typy izieb a rozniesť ich po jednotlivých izbách daného typu, zároveň je možnosť previesť zápis nie len na typ izby, ale systém svojim algoritmom vyberie konkrétnu izbu pre objednávku, čím sa odbúrava potvrdenie objednávky na typ tým, že recepcia musí tuto objednávku ďalej presunúť na konkrétnu izbu.

Parametre:

• booking2Request – štruktúra obsahujúca informácie o objednávke
• dateFrom – dátum od ktorého vrátane má systém hľadať voľné kapacity
• dateTo – dátum do ktorého vrátane má systém hľadať voľné kapacity
• dateFormat – formát dátumu, ktorý je použitý v rámci parametrov dateFrom a dateTo
• dtDateFrom – dátum od ktorého vrátane má systém hľadať voľné kapacity
• dtDateTo – dátum do ktorého vrátane má systém hľadať voľné kapacity

Možnosti dátumových formátov je možné pozrieť pri popise metódy check.

Pri metóde „booking2“ v ktorej parametroch sa neuvádza formát dátumov a jednotlivé dátumy sú typu string sa tieto musia povinne uvádzať vo formáte yyyy-MM-dd, príklad 2009-12-07, čo je siedmy december 2009.

Metóda booking3

Booking3Response booking3(Booking2Request booking2Request, string dateFrom, string dateTo)

Booking3Response booking3(Booking2Request booking2Request, string dateFrom, string dateTo, string dateFormat)

Booking3Response booking3(Booking2Request booking2Request, dateTime dtDateFrom, dateTime dtDateTo)

Metóda a jej vstupné parametre sa plne zhodujú s metódou booking2.

Rozdiel je len vo výstupnom parametri, ktorý sa nahrádza novou štruktúrou Booking3Response, v ktorej je pridaný parameter „rezervačné číslo objednávky“.

Metóda booking4

Booking3Response booking4(Booking4Request booking4Request, string dateFrom, string dateTo)

Booking3Response booking4(Booking4Request booking4Request, string dateFrom, string dateTo, string dateFormat)

Booking3Response booking4(Booking4Request booking4Request, dateTime dtDateFrom, dateTime dtDateTo)

Aby bola zachovaná spätná kompatibilita s prevedením rezervácie nebola modifikovaná pôvodná metóda bookingu ale bol vytvorený jej klon, ktorý pôvodnú funkčnosť rozširuje. Metóda booking4 rozširuje pôvodnú funkčnosť metódy booking3. Takže aj táto metóda, ako jej predchodca má za úlohu zapísať do systému Horec objednávku podľa zadaných parametrov, s tým rozdielom, že funkčnosť je ešte rozšírená o možnosť uvedenia balíkov služieb v rámci danej objednávky a zároveň o možnosť uvedenia FlexiRate cien a taktiež pribudla možnosť zvoliť si cenový profil pre danú objednávku (rezerváciu). Podmienky použitia FlexiRate cien a kombinácie ich položiek je možné nájsť v popise jednotlivých štruktúr.

Parametre:

• booking4Request – štruktúra obsahujúca informácie o objednávke
• dateFrom – dátum od ktorého vrátane má systém hľadať voľné kapacity
• dateTo – dátum do ktorého vrátane má systém hľadať voľné kapacity
• dateFormat – formát dátumu, ktorý je použitý v rámci parametrov dateFrom a dateTo
• dtDateFrom – dátum od ktorého vrátane má systém hľadať voľné kapacity
• dtDateTo – dátum do ktorého vrátane má systém hľadať voľné kapacity

Možnosti dátumových formátov je možné pozrieť pri popise metódy „check“.

Pri metóde „booking4“ ako aj pri ostatných metódach bookingu kde sa v parametroch neuvádza formát dátumov a jednotlivé dátumy sú typu string sa tieto musia povinne uvádzať vo formáte yyyy-MM-dd, príklad 2009-12-07, čo je siedmiydecember 2009. Pokiaľ si prajete používať vlastný formát tu je nutné využiť tabuľku možností formátovania dátumu, ktorá je uvedená pri metóde „check“.

Metóda booking5

Booking3Response booking5(Booking5Request booking5Request, string dateFrom, string dateTo)

Booking3Response booking5(Booking5Request booking5Request, string dateFrom, string dateTo, string dateFormat)

Booking3Response booking5(Booking5Request booking5Request, dateTime dtDateFrom, dateTime dtDateTo)

Aby bola zachovaná spätná kompatibilita s prevedením rezervácie nebola modifikovaná pôvodná metóda bookingu ale bol vytvorený jej klon, ktorý pôvodnú funkčnosť rozširuje. Metóda booking5 rozširuje pôvodnú funkčnosť metódy booking4. Takže aj táto metóda, ako jej predchodca má za úlohu zapísať do systému Horec objednávku podľa zadaných parametrov, s tým rozdielom, že funkčnosť je ešte rozšírená o možnosť zadania oslovenia hosťa, priradenia kategórie pripadne priradenia marketingových kategórií. Keďže marketingové kategórie plne nahrádzajú pôvodnú funkčnosť náborov, tieto je možné uplatňovať priamo cez ne, takže oproti metóde booking4 bola možnosť zadania idAdvertising zrušená. Metóda na získanie číselníka získania náborov, ktorá je popísaná v kapitole Chyba: Zdroj odkazu nenájdený bude ponechaná v API kvôli spätnej kompatibilite.

Parametre:

• booking5Request – štruktúra obsahujúca informácie o objednávke
• dateFrom – dátum od ktorého vrátane má systém hľadať voľné kapacity
• dateTo – dátum do ktorého vrátane má systém hľadať voľné kapacity
• dateFormat – formát dátumu, ktorý je použitý v rámci parametrov dateFrom a dateTo
• dtDateFrom – dátum od ktorého vrátane má systém hľadať voľné kapacity
• dtDateTo – dátum do ktorého vrátane má systém hľadať voľné kapacity

Možnosti dátumových formátov je možné pozrieť pri popise metódy check.

Pri metóde „booking5“ ako aj pri ostatných metódach bookingu kde sa v parametroch neuvádza formát dátumov a jednotlivé dátumy sú typu string sa tieto musia povinne uvádzať vo formáte yyyy-MM-dd, príklad 2009-12-07, čo je siedmy december 2009. Pokiaľ si prajete používať vlastný formát tu je nutné využiť tabuľku možností formátovania dátumu, ktorá je uvedená pri metóde check.

Metóda „booking6“

Booking3Response booking6(Booking6Request booking6Request, string dateFrom, string dateTo)

Booking3Response booking6(Booking6Request booking6Request, string dateFrom, string dateTo, string dateFormat)

Booking3Response booking6(Booking6Request booking6Request, dateTime dtDateFrom, dateTime dtDateTo)

Aby bola zachovaná spätná kompatibilita s prevedením rezervácie, nebola modifikovaná pôvodná metóda bookingu, ale bol vytvorený jej klon, ktorý pôvodnú funkčnosť rozširuje. Metóda booking6 rozširuje pôvodnú funkčnosť metódy booking5. Takže aj táto metóda, ako jej predchodca má za úlohu zapísať do systému Horec objednávku podľa zadaných parametrov, s tým rozdielom, že funkčnosť je ešte rozšírená o možnosť zadania zoznamu hostí na izbu a zadania vekovej hladiny hosťa.

Parametre:

• booking6Request – štruktúra obsahujúca informácie o objednávke
• dateFrom – dátum od ktorého vrátane má systém hľadať voľné kapacity
• dateTo – dátum do ktorého vrátane má systém hľadať voľné kapacity
• dateFormat – formát dátumu, ktorý je použitý v rámci parametrov dateFrom a dateTo
• dtDateFrom – dátum od ktorého vrátane má systém hľadať voľné kapacity
• dtDateTo – dátum do ktorého vrátane má systém hľadať voľné kapacity

Možnosti dátumových formátov je možné pozrieť pri popise metódy „check“.

Pri metóde „booking6“ ako aj pri ostatných metódach bookingu kde sa v parametroch neuvádza formát dátumov a jednotlivé dátumy sú typu string sa tieto musia povinne uvádzať vo formáte yyyy-MM-dd, príklad 2009-12-07, čo je siedmi december 2009. Pokiaľ si prajete používať vlastný formát tu je nutné využiť tabuľku možností formátovania dátumu, ktorá je uvedená pri metóde „check“.

Metóda „acceptPayment“

boolean acceptPayment(int bookingId, int variableSymbol, decimal amount)

Touto metódou je systém hotelovej recepcie „Horec“ informovaný na základe zadaných parametrov o platbe, ktorá prebehla na danú rezerváciu podľa zadaných parametrov. Po tomto dotaze rezervačný systém lokalizuje danú objednávku bookingu a zaúčtuje na jej účet platbu, ktorá prebehla a bola poskytnutá tenkým klientom komunikujúcim s komunikačných interface-om webovej rezervácie.

Parametre:

• bookingId – ID rezervácie/objednávky, ktoré jej bolo pridelené
• variableSymbol – variabilný symbol objednávky
• amount – suma, ktorá má byť naťažená na účet objednávky, táto je zapísaná na účet ako záloha zaplatená typom platby SE (šekom)

Metóda acceptPayment2

boolean acceptPayment2(int bookingId, int variableSymbol, decimal amount, string notice)

Touto metódou je systém Horec informovaný na základe zadaných parametrov o platbe, ktorá prebehla na danú rezerváciu podľa zadaných parametrov. Po tomto dotaze rezervačný systém lokalizuje danú objednávku bookingu a zaúčtuje na jej účet platbu, ktorá prebehla a bola poskytnutá tenkým klientom komunikujúcim s komunikačných interface-om webovej rezervácie.

Parametre:

• bookingId – ID rezervácie/objednávky, ktoré jej bolo pridelené
• variableSymbol – variabilný symbol objednávky
• amount – suma, ktorá má byť naťažená na účet objednávky, táto je zapísaná na účet ako záloha zaplatená typom platby SE (šekom)
• notice – poznámka ku účtu do rozsahu 24 znakov

Metóda „acceptPayment3“

boolean acceptPayment3(int bookingId, int variableSymbol, decimal amount, string notice, int paymentTypeId)

Touto metódou je systém hotelovej recepcie „Horec“ informovaný na základe zadaných parametrov o platbe, ktorá prebehla na danú rezerváciu podľa zadaných parametrov. Po tomto dotaze rezervačný systém lokalizuje danú objednávku bookingu a zaúčtuje na jej účet platbu, ktorá prebehla a bola poskytnutá tenkým klientom komunikujúcim s komunikačných interface-om webovej rezervácie. Novinkou je povinnosť definovať dohodnutý typ (spôsob) platby.

Parametre:

• bookingId – ID rezervácie/objednávky, ktoré jej bolo pridelené
• variableSymbol – variabilný symbol objednávky
• amount – suma, ktorá má byť naťažená na účet objednávky, táto je zapísaná na účet ako záloha zaplatená typom platby SE (šekom)
• notice – poznámka ku účtu do rozsahu 24 znakov
• paymentTypeId – ID typu (spôsobu) platby

Poznámka: Ak sa ID platby z parametru „paymentTypeId“ nenájde v systéme Horec medzi povolenými spôsobmi platieb pre web, vyvolá táto metóda výnimku a nevykoná sa. Platba je priradená na prvého hosťa v objednávke.

Metóda „getPaymentTypeList“

PaymentType[] getPaymentTypeList()

Vracia z číselníka zoznam dostupných (povolených) spôsobov (typov) platby pre web. Poskytnuté sú iba tie spôsoby platieb, ktoré sú v systéme Horec označené ako povolené pre webovú rezerváciu. Teda nezáleží na tom, či je povolená pre pokladne Horec.

Metóda „bookingStatus“

BookingStatusResponse bookingStatus(int bookingId)

Metóda bookingStatus vracia na základe identifikačného čísla rezervácie základné informácie. Ako typ izby, názov typu izby, číslo izby pokiaľ bola pridelená konkrétna izba, číslo poschodia izby, stav objednávky, či bola akceptovaná platba za ubytovanie a variabilný symbol platby.

Parametre:

• bookingId – ID rezervácie/objednávky, ktoré jej bolo pridelené

Metóda getServiceList

Service[] getServiceList()

Metóda vracia zoznam všetkých vyhovujúcich záznamov z číselníka povolených služieb, ktorého hodnoty je možné použiť v rámci metódy „bookingServices“. Poskytované záznamy sú:

• nastavený typ služby – kladná alebo záporná
• nastavený stav služby – povolená
• len služby s nenulovými cenami
• nie balíky
• nie zľavy
• nie služby z externých systémov

Návratové hodnoty:

• Service[] - zoznam služieb z číselníka s príslušnými parametrami

Metóda bookingServices

boolean bookingServices (int bookingId, BookingService[])

Metóda zabezpečí zápis služieb ku objednávke. Ak má objednávka viac hostí, tak tieto služby pre každého hosťa zduplikuje.

Parametre:

• bookingId - ID už zaregistrovanej objednávky ak taká objednávka neexistuje je vrátená výnimka
• BookingService[] - zoznam objednávaných služieb aj s ich parametrami

Metóda arrivalBooking

boolean arrivalBooking(int bookingId)

Metóda zabezpečí overenie, či aspoň jeden hosť z objednávky nastúpil na pobyt.

Parametre:

• bookingId - ID už zaregistrovanej objednávky ak taká objednávka neexistuje je vrátená výnimka

Metóda getServicePackageList

ServicePackage2[] getServicePackageList()

Metóda vracia návratovej strane zoznam balíkov služieb, ktoré ma daný hotel povolené pre službu Dolores.

Návratové hodnoty:

• ServicePackage2[]
• zoznam balíkov služieb

Metóda getCategories

Category[] getCategories()

Metóda vracia v návratovej hodnote zoznam kategórií pre hostí.

Návratové hodnoty:

• Category[]
• zoznam kategórií hostí

Metóda getMarketingCategories

MarketingCategory[] getMarketingCategories()

Metóda poskytuje volajúcej strane v jej návratovej hodnote zoznam marketingových kategórií. Zároveň aj nahrádza pôvodnú funkčnosť metódy popísanej v kapitole 1.3.2.

Návratové hodnoty:

• MarketingCategory[]
• zoznam marketingových kategórií

Metóda getAgeCategories

AgeCategory[] getAgeCategories()

Metóda poskytuje volajúcej strane v jej návratovej hodnote zoznam vekových hladín.

Návratové hodnoty:

• AgeCategory[]
• zoznam vekových hladín