Petra2 Java API – SjStinaInformationProviderInterface.findAvailableHotelRoom
Method description
Metoden används för att söka hotellrum på en angiven ort under en angiven period.
Antal personer anges vid sökning för att man enbart ska få tillbaka bokningsbara hotellrum i svaret från Netbook. Om man bokar med barn måste man använda GivenNumberOfRooms:NetbookgivenNumberOfRooms.
Om man vill ha avstånd till närmaste järnvägsstation i svaret så skickar man in det i IncludeDistanceToTrain.
I svaret får man tillbaka en lista av bokningsbara alternativ. Sorteringen i svaret sker hos Netbook. Sorteringsordningen styrs av SortOrder.
Ett bokningsbart alternativ kan innehålla flera hotellrum. Pris returneras både per bokningsbart alternativ och per rum.
Man får även tillbaka diverse information per hotellrum i svaret. Bland annat en URL till mer info om hotellet, antal sängar per rum, om bokningen måste garanteras med kontokort.
Typisk sekvens av metoder.
For Javadoc, click here.
Input
FindAvailableHotelRoomQuery
Olika attribut kan sättas för att precisera sökningen.
- HotelCustomerID
- Kundnummer hos Netbook.
- HotelLocationId
- Orten man vill söka på. Tas ifrån uppsökt station (Location) som för vissa stationer innehåller en HotelLocationId
- HotelNamePattern
- Hotellnamn. Del av namn kan anges. Används för att söka efter ett specifikt hotell.
- GivenNumberOfGuests:NetbookGivenNumberOfGuests
- Används om man vill boka rum enbart för vuxen. Antal vuxna och antal önskade vuxna per rum anges.
- GivenNumberOfRooms:NetbookGivenNumberOfRooms
- Används om man vill boka rum för barn och vuxen. Antal rum, antal vuxna och barnens ålder skickas in. Anger man fler än ett rum blir det samma antal vuxna och barn för varje rum.
Barnens ålder läggs in i en lista och antal åldrar visar antalet barn.
- SortOrder
- Styr hur Netbook ska sortera sökresultatet. Default är blankt, då sorteras söksvaret enligt överenskommelse mellan SJ och Netbook. Man kan även sortera på:
SJPConstans.VHotelSortOrderAgreement
SJPConstans.VHotelSortOrderHotel
SJPConstans.VHotelSortOrderLocation
SJPConstans.VHotelSortOrderPrice
SJPConstans.VHotelSortOrderRandom
IncludeDistanceToTrain
Bestämmer ifall avstånd till närmaste järnvägsstation ska skicka med i sökresultatet.
- FindAvailableHotelRoomQuery
- NetbookFindAvailableRoomQuery:NetbookFindAvailableRoomQuery
- HotelGuestArrivalDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- HotelGuestDepartureDate:Date
- TimeZone:String
- Year:int
- Month:int
- Day:int
- [HotelCustomerId:Identity]
- HotelLocationId:Identity
- [HotelNamePattern:String]
- [HotelChainId:Identity]
- [HotelOfferCodeList], sekvens av:
- {GivenNumberOfGuests:NetbookGivenNumberOfGuests}
- NumberOfAdultsTotal:int
- PreferredNumberOfAdultsPerRoom:int
eller (givenNumberOfXor)
- {GivenNumberOfRooms:NetbookGivenNumberOfRooms}
- NumberOfRooms:int
- NumberOfAdultsPerRoom:int
- [ChildAgeList], sekvens av:
- Policy:NetbookPolicy
- MaxNumberOfOptionsPerHotel:int
- MaxNumberOfHotels:int
- [SortOrder:String]
- [IncludeDistanceToTrain:boolean]
Output
FindAvailableHotelRoomResult
Innehåller olika bokningsalternativ inkl. diverse information om hotellet och rummen.
- NetbookAvailableList
- Lista med olika hotell och rumsförslag (NetbookAvailable). Listan kan innehålla flera olika rum och rumstyper ifall man har sökt hotellrum för flera personer. Här presenteras även övergripande hotellinformation.
- NetbookAvailable:HotelShortInfoUrl
- En länk till en webbsida som är administrerad av Netbook med information om hotellet.
- BookableOption
- En lista med bokningsbara alternativ, kan bestå av flera olika typer av rum. Innehåller rum för samtliga personer som angavs vid sökning.
- BookableRoom
- En lista med hotellrum.
- BookableRoom:LastPossibleTimeForCancellation
- Visar sista möjliga avbokningstidpunkt, datum och tid.
- BookableRoom:GuaranteeRequired
- En flagga som talar om ifall bokningen måste garanteras med kontokort. Om flaggan är True måste kontokortsuppgifter skickas in vid bokning.
- BookableRoom:RoomTypeLockData
- Nyckel till ett rumsförslag. Används i metoden addHotelRoomLock för att lägga till ett rumsförslag till en varukorg.
- HotelRoomType:NetbookHotelRoomType
- Beskriver rumstypen.
- NetbookAgreement:NetbookAgreement
- Innehåller rummets priskategori (Agreement), erbjudandekod (HotelOfferCode) och en beskrivning av priskategorin (AgreementDescriptionText).
- FindAvailableHotelRoomResult
- NetbookFindAvailableRoomResult:NetbookFindAvailableRoomResult
- NetbookAvailableList, sekvens av:
- NetbookAvailable
- HotelId:Identity
- HotelName:String
- HotelShortInfoUrl:String
- HotelLocation:NetbookLocation
- HotelLocationId:Identity
- HotelLocationName:String
- [HotelTopLocationId:Identity]
- [HotelTopLocationName:String]
- HotelLocationCountryCode:Code
- [HotelChain:NetbookHotelChain]
- HotelChainId:Identity
- HotelChainName:String
- [DistanceToTrain:int]
- BookableOptionList, sekvens av:
- NetbookBookableOption
- TotalPrice:Money
- CurrencyCode:Code
- Amount:DecimalString
- VatIncluded:boolean
- BookableRoomList, sekvens av:
- NetbookBookableRoom
- NumberOfRooms:int
- NumberOfAdults:int
- [ChildAgeList], sekvens av:
- Price:Money
- CurrencyCode:Code
- Amount:DecimalString
- VatIncluded:boolean
- [LastPossibleTimeForCancellation:DateTime]
- TimeZone:String
- Year:int
- Month:int
- Day:int
- Hour:int
- Minute:int
- [Second:int]
- GuaranteeRequired:boolean
- [BreakfastIncluded:boolean]
- RoomTypeLockData:NetbookLockId
- HotelRoomType:NetbookHotelRoomType
- HotelRoomId:Identity
- HotelRoomName:String
- HotelRoomCategoryId:Identity
- HotelRoomClassId:Identity
- [StandardNumberOfBeds:int]
- NetbookAgreement:NetbookAgreement
- AgreementType:Code
- [AgreementId:Identity]
- [AgreementName:String]
- [HotelOfferCode:Code]
- [AgreementDescriptionText:String]
- [ClientInformation:ClientInformation]
- ClientSessionData:ClientSessionData
- SessionId:String
- [SessionLanguageCode:String]
- [OrderNumber:String]
- [CustomerRoleCode:Code]
- [OrderCreatorCustomerId:String]
- [LockId:String]
- [ClientVersion:String]
- Protocol:Protocol
- Compressed:boolean
- [Algorithm:String]
- [Encoding:String]
- [CachePolicy:String]
- [TimeInformation], sekvens av:
- [TimeInformation]
- [CloneName:String]
- Description:String
- MethodName:String
- Time:String
- LogTime:String
- [TimeInformation:TimeInformation]
- [InitialCloneName:String]
- [ExternalEventSpecification:ExternalEventSpecification]
- [OverrideTimeLogLevel:boolean]