Retrieving the room types and the rate plans based on OTA_HotelRoomListRQ
Before the Hotel-Spider system can send inventories, rates and stay restrictions to an online booking system, we need to perform the room type mapping. If in addition, the online booking solution also works with rate plans, these also need to be provided.
The Hotel-Spider system will send the following request
<OTA_HotelRoomListRQ xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" Target="Production" TimeStamp="2015-11-24T16:00:00+02:00" EchoToken="123456789"> <POS> <Source> <RequestorID ID="MASTERUSERNAME" MessagePassword="MASTERPASSWORD" Type="13" /> </Source> </POS> <HotelRoomLists> <HotelRoomList HotelCode="HotelCode" /> </HotelRoomLists> </OTA_HotelRoomListRQ>
Request structure
OTA_HotelRoomListRQ
Parent: None (Root element)
Mandatory: yes
Attributes:
Name | Mandatory | Description |
---|---|---|
TimeStamp | Yes | The format should respect the ISO 8601 2015-11-16T22:23:48+00:00 |
Target | Yes | When sending updates to the staging environment "Test" must be used. When sending updates to the production environment "Production" must be used. |
Version | Yes | The default value should be "1.000" |
EchoToken | Yes | This string should be returned in the response |
Child elements: POS (when using POS authentication. See Authentication methods for more information), HotelRoomLists
HotelRoomLists
Parent: OTA_HotelRoomListRQ
Mandatory: yes
Attributes: None
Child elements: HotelRoomList
HotelRoomList
Parent: HotelRoomLists
Mandatory: yes
Attributes:
Name | Mandatory | Description |
---|---|---|
HotelCode | Yes | The ID of the hotel on the online booking system |
Child elements: None
The online booking system must respond with the following format
<OTA_HotelRoomListRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" TimeStamp="2015-11-25T14:03:12+01:00" CorrelationID="00Q5655b19087479"> <Success></Success> <HotelRoomLists> <HotelRoomList HotelName="Hotel Monopole" HotelCode="00P5519244d6895d"> <RoomStays> <RoomStay> <RoomTypes> <RoomType IsRoom="true" RoomID="00P55192452c758a"> <Occupancy MinOccupancy="1" MaxOccupancy="2" /> <RoomDescription Name="Double"/> </RoomType> </RoomTypes> <RatePlans> <RatePlan RatePlanID="00P551924532f2f7" RatePlanName="Standard"/> <RatePlan RatePlanID="00P5519245339021" RatePlanName="Non refundable"/> <RatePlan RatePlanID="00P5519245344243" RatePlanName="Hot Deal"/> </RatePlans> </RoomStay> <RoomStay> <RoomTypes> <RoomType IsRoom="true" RoomID="00P55192452dc947"> <Occupancy MinOccupancy="1" MaxOccupancy="1" /> <RoomDescription Name="Single"/> </RoomType> </RoomTypes> <RatePlans> <RatePlan RatePlanID="00P551924532f2f7" RatePlanName="Standard"/> <RatePlan RatePlanID="00P5519245339021" RatePlanName="Non refundable"/> </RatePlans> </RoomStay> </RoomStays> </HotelRoomList> </HotelRoomLists> </OTA_HotelRoomListRS>
Response structure
OTA_HotelRoomListRS
Parent: None (Root element)
Mandatory: yes
Attributes:
Name | Mandatory | Description |
---|---|---|
TimeStamp | Yes | The format should respect the ISO 8601 2015-11-16T22:23:48+00:00 |
Target | Yes | When sending updates to the staging environment "Test" must be used. When sending updates to the production environment "Production" must be used. |
Version | Yes | The default value should be "1.000" |
EchoToken | Yes | This string should be returned in the response |
Child elements: Success, HotelRoomLists
Success
Parent: OTA_HotelRoomListRS
Mandatory: yes
Attributes: None
Child elements: None
HotelRoomLists
Parent: OTA_HotelRoomListRS
Mandatory: yes
Attributes: None
Child elements: HotelRoomList
HotelRoomList
Parent: HotelRoomLists
Mandatory: yes
Attributes:
Name | Mandatory | Description |
---|---|---|
HotelCode | Yes | The ID of the hotel on the online booking system |
HotelName | Yes | The name of the hotel on the online booking system |
Child elements: RoomStays
RoomStays
Parent: HotelRoomList
Mandatory: yes
Attributes: None
Child elements: RoomStay
RoomStay
Parent: RoomStays
Mandatory: yes
Attributes: None
Child elements: RoomTypes
RoomTypes
Parent: RoomStay
Mandatory: yes
Attributes: None
Child elements: RoomType
RoomType
Parent: RoomTypes
Mandatory: yes
Attributes:
Name | Mandatory | Description |
---|---|---|
RoomTypeCode | Yes | The ID of the room type on the online booking system |
Child elements: RoomDescription, Occupancy
Occupancy
Parent: RoomType
Mandatory: yes
Attributes:
Name | Mandatory | Description |
---|---|---|
MinOccupancy | Yes | The minimum number of occupants possible for this room type |
MaxOccupancy | Yes | The maximum number of occupants possible for this room type |
Child elements: None
RoomDescription
Parent: RoomType
Mandatory: yes
Attributes:
Name | Mandatory | Description |
---|---|---|
Name | Yes | The name of the room type on the online booking system |
Child elements: None
RatePlans
Parent: RoomStay
Mandatory: yes
Attributes: None
Child elements: RatePlan
RatePlan
Parent: RatePlans
Mandatory: yes
Attributes:
Name | Mandatory | Description |
---|---|---|
RatePlanCode | Yes | The ID of the rate plan on the online booking system |
RatePlanName | Yes | The name of the rate plan on the online booking system |
Child elements: RatePlanDescription