ObeHotel InterfaceXMLv2 60 6

ObeHotel Online Booking Engine
XML Services Specifications Version v2.60.6

www.obehotel.com
ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved
Index
1.- General Description ..................................................................................................................................................... 3 2.- Access Specifications ................................................................................................................................................... 5 2.1.- Examples of the Access Request ........................................................................................................................... 6 2.2.- Request Generator. .............................................................................................................................................. 7 3.- Getters ......................................................................................................................................................................... 8 3.1.- Get languages List ................................................................................................................................................. 8 3.2.- Get countries List .................................................................................................................................................. 9 3.3.- Get provinces List................................................................................................................................................ 10 3.4.- Get cities List ....................................................................................................................................................... 11 3.5.- Get destinations List ........................................................................................................................................... 12 3.6.- Get zones List ...................................................................................................................................................... 13 3.7.- Get hotels List ..................................................................................................................................................... 14 3.8.- Get services list ................................................................................................................................................... 17 3.8.1.- Get general hotel services list.......................................................................................................................... 17 3.8.2.- Get general room services list ......................................................................................................................... 18 3.9.- Get Hotel Information......................................................................................................................................... 19 3.10.- Get availability by Destination Code................................................................................................................. 22 3.11.- Get availability Request by Hotel Code ............................................................................................................ 35 3.12.- Get availability - No Availability Messages ....................................................................................................... 44 3.13.- Make a reservation ........................................................................................................................................... 47 3.13.1.- Initial reservation ........................................................................................................................................... 47 3.13.2.- Confirm reservation ....................................................................................................................................... 53 3.13.3.- Cancel reservation. ........................................................................................................................................ 55 3.14.- Get status reservation ...................................................................................................................................... 58 3.15.- Get Reservations List ........................................................................................................................................ 61 3.16.- Upload Reservation .......................................................................................................................................... 63 3.17.- Get Inventory .................................................................................................................................................... 66 4.- Contact Details ........................................................................................................................................................... 69
Pag. 2
1.- General Description

This document contains the specifications for the XML Services of ObeHotel system. These services allow us to offer to our business to business/B2B partners, a complete process for making hotel reservations via an XML system. We have developed the most frequently used services, and we must point out that our partners do not have to develop all the available functions. We recommend that only the necessary functions required for your particular application are used. For the purpose of this document, the functions have been joined together in the following groups according to their type. Availability Requests: This group covers the requests which allow you to obtain all the information regarding availability in the hotels. The availability is provided according to the dates of the hotel stay, the number of persons, number of nights, and destination. Information Requests: The aim of these requests is to acquire various types of information about the hotel. In this group, there are requests which are necessary in order to acquire the location of the hotel, or its facilities, or also to see the different photos available for the hotel. Reservation Requests: This is a group of requests which allows our B2B partner to carry out the whole process for booking a room in a hotel. Also included within this group, are cancellation functions and status of the reservation. Please find below a diagram showing a possible combination of XML requests, all of which have the final objective of completing a reservation in a hotel.
Pag. 3
ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved As can be seen in the diagram above, between the B2B Partner and the server there is a flow of data. This process of interaction consists of the B2B partner making a call (request) to the server of the XML services of ObeHotel system. At the precise moment that the server receives the call, it consults the type of request to be dealt with. Following on from this, and according to the type of request, the server obtains the corresponding data from our database and generates a reply (response). This reply is returned in XML to the B2B Partner. Finally, the B2B Partner analyses the XML reply and obtains the data they require. Following this process of interaction, the B2B Partner has to carry out a sequence of requests in order to make a reservation. A possible combination of requests is: a. Availability Request by Destination Code: The B2B Partner carries out a general search of the hotels which have an available room in a particular destination. b. Hotel Information Request: The B2B Partner is interested in a particular hotel and makes an information request to receive more details about the hotel. c. Availability Request by Hotel Code: Once the hotel information has been acquired, the B2B Partner sees that the hotel has all the requirements they need. The Partner then proceeds to acquiring the rooms which are available for particular dates, by using the Availability Request by Hotel Code. d. Pre-Reservation Request: In the list of rooms acquired in the previous step, there are two rooms which are very well priced. The B2B Partner carries out the Pre-Reservation process for these rooms. e. Confirmation Request: The rooms are blocked off. Finally, the B2B Partner sends the confirmation request in order to complete the Reservation process. f. Cancellation Request: For whatever reason, the partner wants to cancel a previously confirmed reservation. A cancellation request needs to be sent. The cancellation policy for that hotel must be taken into account. The examples of Access Specifications shown on the next pages are in the programming language Java. However, the Partner may carry out requests in other dynamic programming languages such as PHP, ASP, Perl, In order to generate and process XML, the support of a dynamic programming language is necessary.
Pag. 4
2.- Access Specifications

The services for B2B Partners are housed in one of the servers belonging to ObeHotel system. In order to be able to access the XML interface, an identifier is needed (Agency-IdUser) .The identifier is provided to the B2B Partner by our commercial department and is only for a designated user and is non transferable. There are various ways of making calls (requests) to the server ObeHotel has opted for the GET variable. Access to the services is made through a HTTP request to a server. This request must contain the XML coding according to the format MIME application/x-www-form-urlencoded directly in a variable called xml. For the first part of the integration, the requests should be made in the development server. In this server it is possible to make all kinds of requests and reservations. None of these reservations will be real. The URL for the XML services via the development server is: Development Server = http://195.235.59.168:8080/xxx/? (the final part of this url will be provided by your technical contact) Once the B2B Partner has completed the integration and all is working correctly, Efimatica S.L will activate the account in the production server. As soon as the account has been activated, all requests made by the B2B Partner will be in a real environment and in real time. The URL for productions services is: Production Server = http://195.235.59.168:8080/xxx/? (the final part of this url will be provided by your technical contact)
Pag. 5
2.1.- Examples of the Access Request

The following lines of code contain an example of how a B2B Partner can make the HTTP call to a server. This example is in the programming language of JAVA.
private String encoding="UTF-8"; /* Send XML to server and return response in other XML */ public String XMLSend(String host, String xml){ String ret = ""; URL url = new URL(host); URLConnection urlconnection = url.openConnection(); urlconnection.setDoOutput(true); try { sendMessage(urlconnection,xml); } catch(Exception ex) { ex.printStackTrace(); } try { ret = listen(urlconnection); } catch(Exception ex) { ex.printStackTrace(); } return ret; } private void sendMessage(URLConnection urlconnection, String xml) throws Exception{ String aux = "xml="+URLEncoder.encode(xml,encoding)+"&\n"; urlconnection.getOutputStream().write(aux.getBytes()); urlconnection.getOutputStream().close(); } private String listen(URLConnection urlconnection){ String result = ""; try { BufferedReader in = new BufferedReader(new InputStreamReader(urlconnection.getInputStream(),encoding)); String inputLine; while ((inputLine = in.readLine()) != null) result = result+inputLine; in.close(); }catch(Exception exception) { exception.printStackTrace(); } return (result.toString()); }
If we presume that the work is being carried out in the development server, the call to the function XMLSend is made in the following way:
String response = XMLSend("http://195.235.59.168:8080/xxx/?",xml);
XML is a chain which contains the XML request which you wish to send to the server.
Pag. 6
2.2.- Request Generator.

Previously we explained how the B2B Partners application can connect to the server in order to be able to send and receive the XML requests. However, during the development phase, it is possible to use other ways to make XML test requests. One way, which is frequently used by programmers of JAVA+XML is the Eclipse framework. This framework is one of the best for developing JAVA applications. Also, the application is developed as part of Open Source and can be downloaded from the following URL: http://www.eclipse.org/. There is a plug-in available called Eclipse HTTP Client (http://http4e.roussev.org/) which allows XML requests to be made in different ways. In ObeHotel system we use the GET method. An easier way could be to create a HTML page with the following code, which will allow the XML to be sent to the development server.
Index.html <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <title>Interface Request Efimatica.com</title> <script language="JavaScript"> function enviar(){ document.his.action = document.his.accion.value; document.his.submit(); } </script> </head> <body> <center> <form name="his" method="post" enctype="application/x-www-form-urlencoded"> <br>Server XML: <input type="Text" name="accion" value="http://195.235.59.168:8080/xxx/?" size="50"> <input type="button" value="Send XML" onclick="enviar()"><br><br> <TEXTAREA name="xml" rows=25 style="font-size: 9px; width: 100%"></TEXTAREA> </form> </center> </body> </html>
Pag. 7
3.- Getters
3.1.- Get languages List
This request returns a list of all available languages. Example 1: The request for languages list has the following format:
OTA_LanguageListRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_LanguageListRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> </OTA_LanguageListRQ>
Tags
PrimaryLangID Agency - UserId
Description Language in which the hotel information will be received. Identifier of the agency making the request.
Values String String 2
Size
Compulsory
Yes Yes
OTA_LanguageListRS (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_LanguageListRS TimeStamp="2008-09-14T17:43:12"> <Languages> <Language Code="es" Name="Spanish"/> <Language Code="ca" Name="Catalan"/> <Language Code="en" Name="English"/> <Language Code="fr" Name="French"/> <Language Code="nl" Name="Nederlands"/> <Language Code="de" Name="Deutcsh"/> <Language Code="ru" Name="Russian"/> </Languages> </OTA_LanguageListRS>
Tags
TimeStamp Language Code Language - Name
Description Time of the response request. Identifier of language. Language Name
Values AAAA-MMDDTHH:mm:SS Integer String
Size 19
Compulsory
Yes Yes Yes
Pag. 8
3.2.- Get countries List

This request returns a list of all the countries in our database. Example 1: The request for countries list has the following format:
OTA_CountryListRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_CountryListRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> </OTA_CountryListRQ>
Tags
Size
Compulsory
Yes Yes
OTA_CountryListRS (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_CountryListRS TimeStamp="2008-09-14T17:43:12"> <Countries> <Country Code="66" Name="Spain"/> <Country Code="73" Name="France"/> </Countries> </OTA_CountryListRS>
Tags
TimeStamp Country Code Country - Name
Description Time of the response request. Identifier of the country. Country Name
Size 19
Compulsory
Yes Yes Yes
Pag. 9
3.3.- Get provinces List

This request returns a list of provinces that are part of the requested country. Example 1: The request for provinces list has the following format:
OTA_ProvinceListRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_ProvinceListRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <Countries> <Country Code="66" /> <Country Code="67" /> </Countries> </OTA_ProvinceListRQ>
Tags
PrimaryLangID Agency - UserId Country - Code
Description Language in which the hotel information will be received. Identifier of the agency making the request. Identificador de pas del cual queremos obtener el listado de provincias
Values String String Integer 2
Size
Compulsory
Yes Yes Yes
OTA_ProvinceListRS (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_ProvinceListRS TimeStamp="2008-09-14T17:43:12"> <Provinces> <Province Code="8" Name="Barcelona" IdCountry="66"/> <Province Code="17" Name="Gerona" IdCountry="66"/> <Province Code="73" Name="Pars" IdCountry="67"/> </Provinces> </OTA_ProvinceListRS>
Tags
TimeStamp Province Code Province - Name Province IdCountry
Description Time of the response request. Identifier of the province. Province Name Identifier of the country
Values AAAA-MMDDTHH:mm:SS Integer String Integer
Size 19
Compulsory
Yes Yes Yes Yes
Pag. 10
3.4.- Get cities List

This request gets all the cities that are part of a province or country. Example 1: The request for cities list has the following format:
OTA_CityListRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_CityListRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <Provinces> <Province Code="8" /> <Province Code="17" /> </Provinces> </OTA_CityListRQ>
Tags
PrimaryLangID Agency - UserId Province - Code
Description Language in which the hotel information will be received. Identifier of the agency making the request. Identity code for the province which is displayed in our hotels/destination list.
Size
Compulsory
Yes Yes Yes
OTA_CityListRS (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_CityListRS TimeStamp="2008-09-14T17:43:12"> <Cities> <City Code="872" Name="Abrera" IdProvince="8"/> <City Code="873" Name="Aguilar de Segarra" IdProvince="8"/> <City Code="2461" Name="Agullana" IdProvince="17"/> </Cities> </OTA_CityListRS>
Tags
TimeStamp City Code City - Name City IdProvince
Description Time of the response request. Identifier of the city. City Name Identifier of the province
Values AAAA-MMDDTHH:mm:SS Integer String Integer
Size 19
Compulsory
Yes Yes Yes Yes
Pag. 11
3.5.- Get destinations List

This request gets all destinations that are in a city. Example 1: The request for all destinations from one city.
OTA_DestinationListRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_DestinationListRQ PrimaryLangID="es"> <Agency UserId=" AgencyId"/> </OTA_DestinationListRQ>
Tags
Description Language in which the destination information will be received. Identifier of the agency making the request.
Size
Compulsory
Yes Yes
OTA_DestinationListRQ (Response) <?xml version="1.0" encoding="utf-8" ?> <OTA_DestinationListRS TimeStamp="2012-01-11T10:13:25"> <Destinations> <Destination Code="7" CodeByRequestCity="ds-7" Name="Costa Brava" /> <Destination Code="8" CodeByRequestCity="ds-8" Name="Costa Daurada" /> </Destinations> </OTA_DestinationListRS>
Tags
TimeStamp Destination Code Destination CodeByRequestCi ty Destination Name
Description Time of the response request. Identifier of the destination. Identifier that can be used as City Code in OTA_HotelAvail_RQ Destination name
Values AAAA-MMDDTHH:mm:SS Integer String String
Size 19
Compulsory
Yes Yes Yes Yes
Pag. 12
3.6.- Get zones List

This request gets all available zones. Example 1: The request for all zones.
OTA_ZoneListRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_ZoneListRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> </OTA_ZoneListRQ>
Tags
Description Language in which the destination information will be received. Identifier of the agency making the request.
Size
Compulsory
Yes Yes
OTA_ZoneListRQ (Response) <?xml version="1.0" encoding="utf-8" ?> <OTA_ZoneListRS TimeStamp="2012-01-11T10:13:25"> <Zones> <Zone Code="6" Name="Costa Barcelona" /> <Zone Code="4" Name="Costa Blanca" /> <Zone Code="1" Name="Costa Brava" /> <Zone Code="3" Name="Costa del Sol" /> <Zone Code="2" Name="Costa Corada" /> </Zones> </OTA_ZoneListRS>
Tags
TimeStamp Zone Code Zone Name
Description Time of the response request. Identifier of the zone. Zone name
Size 19
Compulsory
Yes Yes Yes
Pag. 13
3.7.- Get hotels List

This request gets all the hotels that are part of a city, province or country. Example 1: The request for hotels list of a country has following format:
OTA_HotelListRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelListRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <Countries> <Country Code="66" /> </Countries> </OTA_HotelListRQ>
Tags
PrimaryLangID Agency - UserId Country - Code
Description Language in which the hotel information will be received. Identifier of the agency making the request. Identity code for the country which can be found in our Hotels list
Size
Compulsory
Yes Yes Yes
OTA_HotelListRS (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelListRS TimeStamp="2008-09-14T17:43:12"> <Hotels> <Hotel Code="2" Name="Apth. Esmeraldas" Category="2" IdCity="23"/> <Hotel Code="3" Name="Apth. San Eloi" Category="2" IdCity="23"/> </Hotels> </OTA_HotelListRS>
Tags
TimeStamp Hotel Code Hotel - Name Hotel Category Hotel - IdCity
Description Time of the response request. Identifier of the hotel. Hotel name Category of the hotel Identifier of the city
Values AAAA-MMDDTHH:mm:SS Integer String Integer Integer
Size 19
Compulsory
Yes Yes Yes Yes Yes
Pag. 14
Example 2: The request for hotels list of a province has following format:
OTA_HotelListRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelListRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <Provinces> <Province Code="4" /> </Provinces> </OTA_HotelListRQ>
Tags
PrimaryLangID Agency - UserId Province - Code
Description Language in which the hotel information will be received. Identifier of the agency making the request. Identity code for the province which is displayed in our hotels/destination list.
Size
Compulsory
Yes Yes Yes
Example 3: The request for hotels list of a city has following format:
OTA_HotelListRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelListRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <Cities> <City Code="4" /> <City Code="5" /> </Cities> </OTA_HotelListRQ>
Tags
PrimaryLangID Agency - UserId City - Code
Description Language in which the hotel information will be received. Identifier of the agency making the request. Identity code for the resort which is displayed in our hotels/destination list. Pag. 15
Size
Compulsory
Yes Yes Yes
Pag. 16
3.8.- Get services list

This request returns a list of all available services of the hotel. You can get the services or hotel room.
3.8.1.- Get general hotel services list

Example 1: The request for general hotel services list has the following format:
OTA_ServiceHotelListRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_ServiceHotelListRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> </OTA_ServiceHotelListRQ>
Tags
Size
Compulsory
Yes Yes
OTA_ServiceHotelListRS (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_ServiceHotelListRS TimeStamp="2008-09-14T17:43:12"> <Services> <Service Code="54" Name="Alquiler de coches" /> <Service Code="8" Name="Alquiler DVD" /> <Service Code="46" Name="Aparcamiento exterior no vigilado" /> <Service Code="37" Name="Bar" /> <Service Code="56" Name="Bolera" /> </Services> </OTA_ServiceHotelListRS>
Tags
TimeStamp Service Code Service - Name
Description Time of the response request. Identifier of service. Service name
Size 19
Compulsory
Yes Yes Yes
Pag. 17
3.8.2.- Get general room services list

Example 2: The request for general room services list has the following format:
OTA_ServiceRoomListRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_ServiceRoomListRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> </OTA_ServiceRoomListRQ>
Tags
Size
Compulsory
Yes Yes
OTA_ServiceRoomListRS (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_ServiceRoomListRS TimeStamp="2008-09-14T17:43:12"> <Services> <Service Code="1" Name="Aire acondicionado" /> <Service Code="61" Name="Albornoz" /> <Service Code="25" Name="Balcon/Terraza" /> <Service Code="68" Name="Baño completo" /> <Service Code="23" Name="Caja fuerte" /> <Service Code="21" Name="Calefacción" /> </Services> </OTA_ServiceRoomListRS>
Tags
TimeStamp Service Code Service - Name
Description Time of the response request. Identifier of service. Service name
Size 19
Compulsory
Yes Yes Yes
Pag. 18
3.9.- Get Hotel Information

The request for hotel information is used to acquire all the details regarding the hotel. With this request we will receive information about the situation, public facilities, room facilities, and cancellation policy of the hotel and other relevant information of interest. For example, we will also receive the URL with the photos of the different services offered by the hotel.
Example 1: For this type of request, the XML must have the following format:
OTA_HotelInfoRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelInfoRQ PrimaryLangID="es" InfoType="Basic"> <Agency UserId="AgencyId"/> <BasicInfo HotelCode="8"/> </OTA_HotelInfoRQ>
Tags
PrimaryLangID Agency - UserId InfoType BasicInfo HotelCode
Description Language for receiving the hotel information. Identifier for the agency making the request. Indicates the type of hotel information. Identifier of the hotel code belonging to the hotel we want information for.
Values String String Basic =Standard Information. Integer 2
Size
Compulsory
Yes Yes Yes Yes
OTA_HotelInfoRS (Response) <OTA_HotelInfoRS TimeStamp="2009-05-28T20:26:45"> <BasicInfo HotelCode="2" HotelName="Apth. Esmeraldas" HotelCategory="2"/> <Description><p>The Aparthotel Esmeraldas is located in a residential area 10 minutes from the beach of Tossa de Mar. The 63 two to four bed apartments and the 44 two and three bed studio flats combine the advantages of a hotel with those of a private flat in a family atmosphere. The restaurant has a buffet service with traditional dishes of national and international cuisine. Internet is available in a public area. Tossa de Mar is a coastal tourist town just 40 km from Girona airport where visitors can practice all types of sports and leisure activities. Alternatively, you can go for walks and short excursions to any of the many local sites of historical and cultural interest. The Aparthotel Esmeraldas offers its guests a changing weekly entertainment's programme and special programmes for children. Our hospitality and friendly service will ensure that you have a most pleasant and enjoyable holiday.</p></Description> <CancelPenalty><p>Como mínimo 7 días antes del día de llegada. De otro modo, el hotel cargará el importe correspondiente a la primera noche.</p></CancelPenalty> <Location Address="Vilafranca del Peneds, s/n" CityName="Tossa de Mar" PostalCode="17320" Zone="Costa Brava" Country="Spain"/> <Contact Phone="+34 972 340 512" Fax="+34 972 342 442" Email="esmeraldas@obehotel.com" EmailBooking="booking.esmeraldas@obehotel.com" /> <GPS Longitude="2.933435" Latitude="41.720185"/> <URLLogo>http://demo.obehotel.com/files/hotel/esmeraldas/tour/photo_infohotel3d.jpg</UR LLogo>
Pag. 19

<URLHotelInfo>http://demo.obehotel.com /hotels/esmeraldas-tossa-demar.html</URLHotelInfo> <RatePlans> <RatePlan Name="Alojamiento y desayuno"/> <RatePlan Name="Media pensin"/> <RatePlan Name="Pensin completa"/> <RatePlan Name="Solo alojamiento"/> <RatePlan Name="Todo incluido"/> </RatePlans> <RoomTypes> <RoomType Name="Habitacion Doble"/> <RoomType Name="Habitacion triple"/> <RoomType Name="Suite Standard"/> <RoomType Name="Habitacion Quadruple"/> </RoomTypes> <Images> <ImageURL Value="http:// demo.obehotel.com/files/hotel/esmeraldas/photo_infohotel.jpg"/> <ImageURL Value="http:// demo.obehotel.com/files/hotel/esmeraldas/photo_infohotel_1.jpg"/> <ImageURL Value="http:// demo.obehotel.com/files/hotel/esmeraldas/photo_infohotel_2.jpg"/> </Images> <HotelServices/> <RoomServices/> </OTA_HotelInfoRS>
Tags
TimeStamp BasicInfo HotelCode BasicInfo HotelName BasicInfo HotelCategory Description CancelPenalty Location Address Location CityName Location PostalCode Location - Zone Location Country Contact - Phone Contact - Email Contact EmailBooking Contact - Fax GPS - Longitude GPS - Latitude URLLogo URLHotelInfo HotelService Name
Description Time of the response request. Identifier code of the hotel. Name of the hotel. Category of hotel. Detailed Description. Cancellation Policy Address of hotel. Town or Resort. Postcode. Zone. Country. Contact Telephone Number. Email of contact. Email of contact of the reservations administrator. Fax Number. Co-ordinates for location of hotel. Co-ordinates for location of hotel. URL for the main photo. URL of hotel information Name of the hotel services. Pag. 20
Values AAAA-MMDDTHH:mm:SS Integer String [1-5] Text Text String
Size 19
Compulsory
Yes Yes Yes Yes Yes Yes Yes Yes
String String String String String String Integer BigDecimal BigDecimal String String String
Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes

RoomService Name RatePlan - Name RoomTyes Name ImagesURL Value
Name of the room facilities in the hotel. Name of the board types in the hotel. Name of Room Types. URL for other hotel images and photos.
String String String String
Yes Yes Yes Yes
Take Note: In the XML, the fields marked in the table as TEXT type, will return the content via the TAG <![C_DATA[ . ]]>. The purpose of this TAG is to stop the special characters and symbols breaking the basic XML structure.
Pag. 21
3.10.- Get availability by Destination Code

The availability request by city or destination code is used to acquire all the hotels which have at least one room available according to various parameters (situation, dates, guests,). The XML you receive back only shows one room per hotel and according to the type of room requested. The room shown is of the lowest price. If you want to see all available rooms in a hotel, the Availability Request by Hotel Code would have to be used. In the download section of this manual, there is a list of all the destinations with their relevant code. The destination code is required to carry out these types of request.
Example 1.1: The XML request to acquire a list of hotels which have room available in one or several specific cities, should have the following format:
OTA_HotelAvail_RQ-ByCity (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <Guests> <Guest AdultsCount="2" ChildsCount="0"/> </Guests> <Include Packages="0" Offers="0" Promotions="0" /> <HotelSearchCriteria> <City Code="4719"/> <City Code="4555"/> </HotelSearchCriteria> </OTA_HotelAvailRQ>
Tags
PrimaryLangID Agency - UserId StayDate Start StayDate - End Guest AdultsCount Guest ChildsCount Include Packages Include Offers City - Code
Description Language in which you wish to receive the hotel information. Identifier of the agency making the request. Check in date at the hotel Check out date at the hotel Number of adults for the hotel stay Number of children for the hotel stay If you want to acquire packages linked to the rooms. Only if there are any available package. If you want to acquire packages linked to the rooms. Only if there are any available offer. Destination code where the search is being made for available rooms. Pag. 22
Values String String AAAA-MM-DD AAAA-MM-DD Integer Integer 0 = Dont show the packages 1 = Return the packages 0 = Dont show the offers 1 = Return the offers Integer 2
Size
Compulsory
Yes Yes
10 10 2 2 1 1 4
Yes Yes Yes Yes Yes Yes Yes
OTA_HotelAvail_RS-ByCity (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRS Target="Production" TimeStamp="2008-08-25T21:07:28"> <RoomStays> <RoomStay Status="AvailableForSale" NumberOfUnits="2"> <RoomType Code="2" Name="Habitacin doble"> </Description><Description> </RoomType> <RatePlan Code="AD" Name="Alojamiento y desayuno"> </Description><Description> </RatePlan> <RoomRate Amount="294.0" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="5"> <RoomType Code="9" Name="Apto. 2 dormitorios 6 pax"> </Description><Description> </RoomType> <RatePlan Code="SA" Name="Slo alojamiento"> </Description><Description> </RatePlan> <RoomRate Amount="397.32" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="250" HotelName="Apts Albatros"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="5"> <RoomType Code="10" Name="Apto. 1 dormitorio 4 pax"> </Description><Description> </RoomType> <RatePlan Code="SA" Name="Slo alojamiento"> </Description><Description> </RatePlan> <RoomRate Amount="278.11" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="251" HotelName="Apts Mariposa"/> </RoomStay> </RoomStays> </OTA_HotelAvailRS>
Tags
TimeStamp RoomStay Status
Description Time of the reply request Status of the room. By default, only available rooms will appear. Number of rooms available with the specified criteria. Room Type code. Room Type Name Complete description of the room. Pag. 23
RoomStay NumberOfUnits RoomType - Code RoomType - Name RoomType Description
Values AAAA-MMDDTHH:mm:SS AvailableForSale = Room available to book. NotAvailable = Room not available Integer Integer String Text
Size 19
Compulsory
Yes Yes
Yes Yes Yes No

RatePlan - Code RatePlan - Name RatePlan Description RoomRate Amount RoomRate CurrencyCode StayDate Start StayDate - End Guest AdultsCount Guest ChildsCount BasicInfo HotelCode BasicInfo HotelName
Board code (ej BB, Half Board etc) Name of the Board Option Description of the Board option. Total Price for the room.
Integer String Text BigDecimal 3 10 10 2 2
Yes Yes No Yes Yes Yes Yes Yes Yes Yes Yes
Coding for the currency for the quoted EUR = Euros Price. Check in date at the hotel. AAAA-MM-DD Check out date at the hotel. Number of adults Number of children Code of the hotel which has the available room. Name of the hotel which has the available room. AAAA-MM-DD Integer Integer Integer String
In the XML reply, it should be noted that the availability request has returned three rooms available in three different hotels. Example 1.2: The XML request to acquire a list of hotels which have room available in one or several specific destinations using Cities tag. To use on that way, the city code must to be prepended by ds- string in City Code tag.
OTA_HotelAvail_RQ-ByCity (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId=" AgencyId"/> <StayDate Start="2012-01-21" End="2012-01-31"/> <Guests> <Guest AdultsCount="2" ChildsCount="0"/> </Guests> <Include Packages="1" Offers="0" Promotions="0" /> <HotelSearchCriteria> <City Code="ds-7"/> <City Code="ds-8"/> </HotelSearchCriteria> </OTA_HotelAvailRQ>
OTA_HotelAvail_RS-ByCity (Response) <?xml version="1.0" encoding="utf-8" ?> <OTA_HotelAvailRS TimeStamp='2012-01-11T11:59:51'> <RoomStays> <RoomStay Status='NotAvailable'> <Restrictions> <Restriction code='1' value='0' /> </Restrictions> <Guest AdultsCount='2' ChildsCount='0' RequestRoomId='1'/> <StayDate Start='2012-01-21' End='2012-01-31'/> <BasicInfo HotelCode='6' HotelName='Hotel Calypso' HotelCategoryCode='3' /> </RoomStay> <RoomStay Status='AvailableForSale' NumberOfUnits='50'> <RoomType Code='197' Name='Habitación doble' >
Pag. 24

<Description><p>Se componen de 2 camas individuales y dos sofáscama. Todas están equipadas con las siguientes comodidades para garantizar el máximo confort durante su estancia: amplias terrazas con vista a la piscina y al mar, baño completo, teléfono, aire acondicionado, televisión, canales de televisión vía satélite, secador y posibilidad de caja fuerte opcional.</p></Description> <Image>sdfg</Image> </RoomType> <RatePlan Code='MP' Name='Media pensión' > <Description></Description> <Image></Image> </RatePlan> <RoomRate Amount='500' AmountBeforeSpecial='0' CurrencyCode='EUR' /> <Guest AdultsCount='2' ChildsCount='0' RequestRoomId='1'/> <StayDate Start='2012-01-21' End='2012-01-31'/> <BasicInfo HotelCode='15' HotelName='Bella Vista Beach Club' HotelCategoryCode='4' /> </RoomStay> <RoomStay Status='AvailableForSale' NumberOfUnits='20'> <RoomType Code='125' Name='Habitación Doble' > <Description><p>El Hotel Villasol dispone 7 habitaciones dobles confortables algunas con vistas al mar y otras a la ciudad. Todas ellas equipadas con aire acondiacionado, baño completo con welcome amenities, teléfono, televisión.<br />(Nota: 7 de estas habitaciones no tienen balcón)</p> </Description> <Image>/files/hotel/villasol/room/doble-std-518x310.jpg</Image> </RoomType> <RatePlan Code='SA' Name='Solo alojamiento' > <Description></Description> <Image></Image> </RatePlan> <RoomRate Amount='545.0' AmountBeforeSpecial='0' CurrencyCode='EUR' /> <Guest AdultsCount='2' ChildsCount='0' RequestRoomId='1'/> <StayDate Start='2012-01-21' End='2012-01-31'/> <BasicInfo HotelCode='16' HotelName='Hotel Villasol' HotelCategoryCode='3' /> </RoomStay> </RoomStays> </OTA_HotelAvailRS>
Tags
Description Time of the reply request Status of the room. By default, only available rooms will appear. Number of rooms available with the specified criteria. Room Type code. Room Type Name Complete description of the room. Board code (ej BB, Half Board etc) Name of the Board Option Description of the Board option. Total Price for the room. Pag. 25
RoomStay NumberOfUnits RoomType - Code RoomType - Name RoomType Description RatePlan - Code RatePlan - Name RatePlan Description RoomRate -
Values AAAA-MMDDTHH:mm:SS AvailableForSale = Room available to book. NotAvailable = Room not available Integer Integer String Text Integer String Text BigDecimal
Size 19
Compulsory
Yes Yes
Yes Yes Yes No Yes Yes No Yes

Amount RoomRate CurrencyCode StayDate Start StayDate - End Guest AdultsCount Guest ChildsCount BasicInfo HotelCode BasicInfo HotelName
3 10 10 2 2
Example 2: The XML request to acquire a list of hotels which have room available in one or several specific destinations, should have the following format:
OTA_HotelAvail_RS-ByDestination (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId=" AgencyId"/> <StayDate Start="2012-01-21" End="2012-01-31"/> <Guests> <Guest AdultsCount="2" ChildsCount="0"/> </Guests> <Include Packages="1" Offers="0" Promotions="0" /> <HotelSearchCriteria> <Destination Code="7"/> <Destination Code="8"/> </HotelSearchCriteria> </OTA_HotelAvailRQ>
OTA_HotelAvail_RS-ByDestination (Response) <?xml version="1.0" encoding="utf-8" ?> <OTA_HotelAvailRS TimeStamp='2012-01-11T11:59:51'> <RoomStays> <RoomStay Status='NotAvailable'> <Restrictions> <Restriction code='1' value='0' /> </Restrictions> <Guest AdultsCount='2' ChildsCount='0' RequestRoomId='1'/> <StayDate Start='2012-01-21' End='2012-01-31'/> <BasicInfo HotelCode='6' HotelName='Hotel Calypso' HotelCategoryCode='3' /> </RoomStay> <RoomStay Status='AvailableForSale' NumberOfUnits='50'> <RoomType Code='197' Name='Habitación doble' > <Description><p>Se componen de 2 camas individuales y dos sofáscama. Todas están equipadas con las siguientes comodidades para garantizar el máximo confort durante su estancia: amplias terrazas con vista a la piscina y al mar, baño completo, teléfono, aire acondicionado, televisión, canales de televisión vía satélite, secador y posibilidad de caja fuerte opcional.</p></Description> <Image>sdfg</Image> </RoomType> <RatePlan Code='MP' Name='Media pensión' >
Pag. 26

<Description></Description> <Image></Image> </RatePlan> <RoomRate Amount='500' AmountBeforeSpecial='0' CurrencyCode='EUR' /> <Guest AdultsCount='2' ChildsCount='0' RequestRoomId='1'/> <StayDate Start='2012-01-21' End='2012-01-31'/> <BasicInfo HotelCode='15' HotelName='Bella Vista Beach Club' HotelCategoryCode='4' /> </RoomStay> <RoomStay Status='AvailableForSale' NumberOfUnits='20'> <RoomType Code='125' Name='Habitación Doble' > <Description><p>El Hotel Villasol dispone 7 habitaciones dobles confortables algunas con vistas al mar y otras a la ciudad. Todas ellas equipadas con aire acondiacionado, baño completo con welcome amenities, teléfono, televisión.<br />(Nota: 7 de estas habitaciones no tienen balcón)</p> </Description> <Image>/files/hotel/villasol/room/doble-std-518x310.jpg</Image> </RoomType> <RatePlan Code='SA' Name='Solo alojamiento' > <Description></Description> <Image></Image> </RatePlan> <RoomRate Amount='545.0' AmountBeforeSpecial='0' CurrencyCode='EUR' /> <Guest AdultsCount='2' ChildsCount='0' RequestRoomId='1'/> <StayDate Start='2012-01-21' End='2012-01-31'/> <BasicInfo HotelCode='16' HotelName='Hotel Villasol' HotelCategoryCode='3' /> </RoomStay> </RoomStays> </OTA_HotelAvailRS>
Tags
Description Time of the reply request Status of the room. By default, only available rooms will appear. Number of rooms available with the specified criteria. Room Type code. Room Type Name Complete description of the room. Board code (ej BB, Half Board etc) Name of the Board Option Description of the Board option. Total Price for the room.
RoomStay NumberOfUnits RoomType - Code RoomType - Name RoomType Description RatePlan - Code RatePlan - Name RatePlan Description RoomRate Amount RoomRate CurrencyCode StayDate Start StayDate - End Guest AdultsCount Guest -
Values AAAA-MMDDTHH:mm:SS AvailableForSale = Room available to book. NotAvailable = Room not available Integer Integer String Text Integer String Text BigDecimal
Size 19
Compulsory
Yes Yes
Yes Yes Yes No Yes Yes No Yes
Coding for the currency for the quoted EUR = Euros Price. Check in date at the hotel. AAAA-MM-DD Check out date at the hotel. Number of adults Number of children Pag. 27 AAAA-MM-DD Integer Integer
3 10 10 2 2
Yes Yes Yes Yes Yes

ChildsCount BasicInfo HotelCode BasicInfo HotelName
Code of the hotel which has the available room. Name of the hotel which has the available room.
Integer String
Yes Yes
Example 3: Request which is returned for a room with a package included. For this purpose, the XML structure should be completed in the following format.
OTA_HotelAvail_RQ-ByCity (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <StayDate Start="2008-10-14" End="2008-10-21"/> </Guests> <Guest AdultsCount="2" ChildsCount="0"/> </Guests> <Include Packages="1" Offers="0" Promotions="0" /> <HotelSearchCriteria> <City Code="4719"/> </HotelSearchCriteria> </OTA_HotelAvailRQ>
Please note that a 1 has been included in the value Include - Packages
OTA_HotelAvail_RS-ByCity (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRS Target="Production" TimeStamp="2008-08-25T21:42:47"> <RoomStays> <RoomStay Status="AvailableForSale" NumberOfUnits="1"> <RoomType Code="2" Name="Habitacin doble"> <Description></Description> </RoomType> <RatePlan Code="AD" Name="Alojamiento y desayuno"> <Description></Description> </RatePlan> <Package Code="48" Name="Incluye entrada PortAventura"> <Description>Descripcin del paquete</Description> </Package> <RoomRate Amount="254.00" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-14" End="2008-10-21"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="5"> <RoomType Code="9" Name="Apto. 2 dormitorios 6 pax"> <Description></Description> </RoomType> <RatePlan Code="SA" Name="Slo alojamiento"> <Description></Description> </RatePlan> <RoomRate Amount="397.32" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-14" End="2008-10-21"/> <BasicInfo HotelCode="250" HotelName="Apts Albatros"/>
Pag. 28

</RoomStay> </RoomStays> </OTA_HotelAvailRS>
Tags
Package Code Package - Name Package Description
Description Code of the package included. Name of the package included Description of the package included.
Values Integer String Text
Size
Compulsory
Yes Yes No
The room which includes a package stands out in bold. In this example, it is an entrance to the Theme Park Port Aventura.
Example 4: Shows the XML structure for requests returned with a room with an offer included. When we say offer we mean that a discount has been applied to the final price. A discount is made when the booking matches certains specified conditions and criteria.
OTA_HotelAvail_RQ-ByCity (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <StayDate Start="2008-10-14" End="2008-10-21"/> <Guests> <Guest AdultsCount="2" ChildsCount="0"/> </Guests> <Include Packages="0" Offers="1" Promotions="0" /> <HotelSearchCriteria> <City Code="4719"/> </HotelSearchCriteria> </OTA_HotelAvailRQ>
Take note that a 1 has been included in the value Include - Offers
OTA_HotelAvail_RS-ByCity (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRS Target="Production" TimeStamp="2008-08-25T21:42:47"> <RoomStays> <RoomStay Status="AvailableForSale" NumberOfUnits="1"> <RoomType Code="2" Name="Habitacin doble"> <Description></Description> </RoomType> <RatePlan Code="AD" Name="Alojamiento y desayuno"> <Description></Description> </RatePlan> <Offer Code="49" Name="Oferta de Invierno"> <Description>Descripcin de la oferta</Description> </Offer> <RoomRate Amount="254.00" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-14" End="2008-10-21"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="5"> <RoomType Code="9" Name="Apto. 2 dormitorios 6 pax">
Pag. 29

<Description></Description> </RoomType> <RatePlan Code="SA" Name="Slo alojamiento"> <Description></Description> </RatePlan> <RoomRate Amount="397.32" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-14" End="2008-10-21"/> <BasicInfo HotelCode="250" HotelName="Apts Albatros"/> </RoomStay> </RoomStays> </OTA_HotelAvailRS>
Tags
Offer Code Offer - Name Offer Description
Description Code of the offer included Name of the offer included Description of the offer included
Values Integer String Text
Size
Compulsory
Yes Yes No
In this example, the room returned from the first hotel includes an offer which consists of a discount for a booking made during the winter period.
Example 5: Example of availability request for more than one different room type. In this case it is necessary to specify the number of people per each room. The system will only allow requests with a maximum of 3 different rooms.
OTA_HotelAvail_RQ-ByCity (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <StayDate Start="2008-10-10" End="2008-10-17"/> </Guests> <Guest AdultsCount="2" ChildsCount="0"/> <Guest AdultsCount="1" ChildsCount="1"/> </Guests> <Include Packages="1" Offers="0" Promotions="0" /> <HotelSearchCriteria> <City Code="4719"/> </HotelSearchCriteria> </OTA_HotelAvailRQ>
Please note that we have specified the number of adults and children for both rooms.
OTA_HotelAvail_RS-ByCity (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRS Target="Production" TimeStamp="2008-08-25T21:07:28"> <RoomStays> <RoomStay Status="AvailableForSale" NumberOfUnits="2"> <RoomType Code="2" Name="Habitacin doble"> </Description><Description> </RoomType> <RatePlan Code="AD" Name="Alojamiento y desayuno"> </Description><Description> </RatePlan>
Pag. 30

<RoomRate Amount="294.0" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso" HotelCategoryCode="3"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="3"> <RoomType Code="2" Name="Habitacin doble"> </Description><Description> </RoomType> <RatePlan Code="AD" Name="Alojamiento y desayuno"> </Description><Description> </RatePlan> <RoomRate Amount="250.0" CurrencyCode="EUR"/> <Guest AdultsCount="1" ChildsCount="1"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso" HotelCategoryCode="3"/> </RoomStay> </RoomStays> </OTA_HotelAvailRS>
The request has returned an XML with two rooms, one for each guest requested.
Example 6: Increased functionality: According to the requirements of the B2B Partner, it may be that all available rooms are required in one single request. This type of request must contain the attribute ShowAllRooms. By using this method, there is no need to carry out the request for availability by hotel code. However, we do not recommend that this function is used as default. This function is an XML of a greater size and is slower. Also, you could receive a lot of information which is not useful to you and so cause a transmission of useless data. Lets look at an example of this type of request.
OTA_HotelAvail_RQ-ByCity (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <StayDate Start="2008-10-10" End="2008-10-17"/> </Guests> <Guest AdultsCount="2" ChildsCount="0"/> </Guests> <Include Packages="1" Offers="0" Promotions="0" /> <HotelSearchCriteria ShowAllRooms="1"> <City Code="4719"/> </HotelSearchCriteria> </OTA_HotelAvailRQ>
Please note that the field ShowAllRooms has been added to the tag HotelSearchCriteria.
OTA_HotelAvail_RS-ByCity (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRS Target="Production" TimeStamp="2008-08-25T21:07:28"> <RoomStays> <RoomStay Status="AvailableForSale" NumberOfUnits="2"> <RoomType Code="2" Name="Habitacin doble"> </Description><Description> </RoomType>
Pag. 31

<RatePlan Code="AD" Name="Alojamiento y desayuno"> </Description><Description> </RatePlan> <RoomRate Amount="294.0" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso" HotelCategoryCode="3"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="2"> <RoomType Code="2" Name="Habitacin doble"> </Description><Description> </RoomType> <RatePlan Code="TI" Name="Todo Includo"> </Description><Description> </RatePlan> <RoomRate Amount="321.0" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso" HotelCategoryCode="3"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="5"> <RoomType Code="9" Name="Apto. 2 dormitorios 6 pax"> </Description><Description> </RoomType> <RatePlan Code="SA" Name="Slo alojamiento"> </Description><Description> </RatePlan> <RoomRate Amount="397.32" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="250" HotelName="Apts Albatros" HotelCategoryCode="3"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="5"> <RoomType Code="10" Name="Apto. 1 dormitorio 4 pax"> </Description><Description> </RoomType> <RatePlan Code="SA" Name="Slo alojamiento"> </Description><Description> </RatePlan> <RoomRate Amount="278.11" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="251" HotelName="Apts Mariposa" HotelCategoryCode="3"/> </RoomStay> </RoomStays> </OTA_HotelAvailRS>
Please note that in the XML reply, all the available rooms in all the specified destinations are included.
Example 7: The XML request to acquire a list of hotels which have room available in one or several specific zones, should have the following format:
OTA_HotelAvail_RS-ByZone(Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId=" AgencyId"/> <StayDate Start="2012-01-21" End="2012-01-31"/>
Pag. 32

<Guests> <Guest AdultsCount="2" ChildsCount="0"/> </Guests> <Include Packages="1" Offers="0" Promotions="0" /> <HotelSearchCriteria> <Zone Code="4"/> </HotelSearchCriteria> </OTA_HotelAvailRQ>
OTA_HotelAvail_RS-ByZone (Response) <?xml version="1.0" encoding="utf-8" ?> <OTA_HotelAvailRS TimeStamp='2012-02-01T09:32:02'> <RoomStays> <RoomStay Status='AvailableForSale' NumberOfUnits='15'> <RoomType Code='10' Name='Habitación Doble Med' > <Description><p>El Hotel Rio Park dispone de 408 habitaciones dobles todas ellas con baño completo, balcón, aire acondicionado y calefacción, televisión por cable, vía satélite y caja de seguridad opcional.</p> </Description> <Image>/files/hotel/riopark/room/hab-doble-518x300.jpg</Image> </RoomType> <RatePlan Code='SA' Name='Solo alojamiento' > <Description></Description> <Image></Image> </RatePlan> <RoomRate Amount='216' AmountBeforeSpecial='0' CurrencyCode='EUR' /> <Guest AdultsCount='2' ChildsCount='0' RequestRoomId='1'/> <StayDate Start='2012-02-21' End='2012-02-25'/> <BasicInfo HotelCode='8' HotelName='Hotel Rio Park' HotelCategoryCode='2' /> </RoomStay> <RoomStay Status='AvailableForSale' NumberOfUnits='5'> <RoomType Code='17' Name='Habitación Doble Med' > <Description><p>Las habitaciones del Hotel Riudor disponen de baño completo, balcón, aire acondicionado, con control individual del mismo, calefacción, televisión por cable, vía satélite con canales como Sky news, Sky sports, CNN y Eurosport, teléfono, caja de seguridad opcional, posibilidad de incluir una cuna y alquiler de nevera.</p> </Description> <Image>/files/hotel/riudor/room/hab-doble-518x300.jpg</Image> </RoomType> <RatePlan Code='SA' Name='Solo alojamiento' > <Description></Description> <Image></Image> </RatePlan> <RoomRate Amount='228' AmountBeforeSpecial='0' CurrencyCode='EUR' /> <Guest AdultsCount='2' ChildsCount='0' RequestRoomId='1'/> <StayDate Start='2012-02-21' End='2012-02-25'/> <BasicInfo HotelCode='9' HotelName='Hotel Riudor' HotelCategoryCode='3' /> </RoomStay> </RoomStays> </OTA_HotelAvailRS>
Tags
Description Time of the reply request Status of the room. By default, only available rooms will appear. Pag. 33
Values AAAA-MMDDTHH:mm:SS AvailableForSale = Room available to book.
Size 19
Compulsory
Yes Yes
ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved NotAvailable = Room not available Integer Integer String Text Integer String Text BigDecimal 3 10 10 2 2
RoomStay NumberOfUnits RoomType - Code RoomType - Name RoomType Description RatePlan - Code RatePlan - Name RatePlan Description RoomRate Amount RoomRate CurrencyCode StayDate Start StayDate - End Guest AdultsCount Guest ChildsCount BasicInfo HotelCode BasicInfo HotelName
Number of rooms available with the specified criteria. Room Type code. Room Type Name Complete description of the room. Board code (ej BB, Half Board etc) Name of the Board Option Description of the Board option. Total Price for the room.
Yes Yes Yes No Yes Yes No Yes Yes Yes Yes Yes Yes Yes Yes
Please Note: In the XML, the fields marked in the table as the TEXT type, return the contents inside the TAG <!C_DATA[ . ]]>. The purpose of this TAG is to stop the special characters and symbols breaking the basic XML structure.
Pag. 34
3.11.- Get availability Request by Hotel Code

The availability request by hotel code exists in order to be able to acquire all the available rooms in a hotel. The returned rooms are presented in price order, with the lowest price room shown first, and finishing with the room with the highest price. By default, only available rooms are returned according to guests requested. Please note that the XML request and response, are practically the same as the specifications detailed in the previous section. The only difference is the search criteria. The hotel code is necessary for this request and this is acquired via the availability request by destination code.
Example 1: An XML request to acquire a list of all the available rooms in a hotel, must have the following format:
OTA_HotelAvail_RQ-ByHotel (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <Guests> <Guest AdultsCount="2" ChildsCount="0"/> </Guests> <Include Packages="0" Offers="0" Promotions="0" /> <HotelSearchCriteria> <Hotel Code="8" /> <Hotel Code="6" /> </HotelSearchCriteria> </OTA_HotelAvailRQ>
Tags
PrimaryLangID Agency - UserId StayDate Start StayDate - End Guest AdultsCount Guest ChildsCount Include Packages Include Offers Hotel - Code
Description Language in which you wish to receive the hotel information. Identifier of Agency making the request Check in date at the hotel. Check out date at the hotel Number of adults per room Number of children per room. If you want to acquire packages linked to the rooms. Only if there are any available package. If you want to acquire offers linked to the rooms. Only if there are any available offer. Hotel code from which room Pag. 35
Values String String AAAA-MM-DD AAAA-MM-DD Integer Integer 0 = Dont show packages 1 = Show packages 0 = Dont show packages 1 = Show packages Integer 2
Size
Compulsory
Yes Yes
10 10 2 2 1 1
ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved availability is being acquired.
OTA_HotelAvail_RS-ByHotel (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRS Target="Production" TimeStamp="2008-08-25T21:10:33"> <RoomStays> <RoomStay Status="AvailableForSale" NumberOfUnits="2"> <RoomType Code="2" Name="Habitacin doble"> <Description></Description> </RoomType> <RatePlan Code="AD" Name="Alojamiento y desayuno"> <Description></Description> </RatePlan> <RoomRate Amount="294.0" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="2"> <RoomType Code="2" Name="Habitacin doble"> <Description></Description> </RoomType> <RatePlan Code="MP" Name="Media pensin"> <Description></Description> </RatePlan> <RoomRate Amount="350.0" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="2"> <RoomType Code="3" Name="Habitacin triple"> <Description></Description> </RoomType> <RatePlan Code="AD" Name="Alojamiento y desayuno"> <Description></Description> </RatePlan> <RoomRate Amount="404.25" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="1"> <RoomType Code="2" Name="Habitacin doble"> <Description></Description> </RoomType> <RatePlan Code="PC" Name="Pensin completa"> <Description></Description> </RatePlan> <RoomRate Amount="420.0" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso"/> </RoomStay> </RoomStays> </OTA_HotelAvailRS>
Tags
TimeStamp
Description Time of the response request. Pag. 36
Values AAAA-MM-
Size 19
Compulsory
Yes
ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved DDTHH:mm:SS AvailableForSale = Room available to book. NotAvailable = Room not available. Integer Integer String Text Integer String Text BigDecimal EUR = Euros AAAA-MM-DD AAAA-MM-DD Integer Integer Integer String 3 10 10 2 2
RoomStay Status
Status of the room. By default , only available rooms will appear. Number of rooms available with the specified criteria. Room code for room type. Name of Room Type. Complete description of the room. Code for Board basis. Name of Board basis. Description of Board basis. Total Price for room. Currency of Price specified. Check in date. Check out date. Number of adults. Number of children Code of hotel which has the available room. Name of the hotel which has the available room.
Yes
RoomStay NumberOfUnits RoomType - Code RoomType - Name RoomType Description RatePlan - Code RatePlan - Name RatePlan Description RoomRate Amount RoomRate CurrencyCode StayDate Start StayDate - End Guest AdultsCount Guest ChildsCount BasicInfo HotelCode BasicInfo HotelName
Yes Yes Yes No Yes Yes No Yes Yes Yes Yes Yes Yes Yes Yes
The XML response has returned a total of four available rooms.
Example 2: Request which consults rooms with packages includes, must have the following format:
OTA_HotelAvail_RQ-ByCity (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <StayDate Start="2008-10-14" End="2008-10-21"/> <Guests> <Guest AdultsCount="2" ChildsCount="0"/> </Guests> <Include Packages="1" Offers="0" Promotions="0" /> <HotelSearchCriteria> <Hotel Code="8" /> </HotelSearchCriteria> </OTA_HotelAvailRQ>
Take note that a 1 has been included in the value Include Packages
OTA_HotelAvail_RS-ByCity (Response) <?xml version="1.0" encoding="UTF-8" ?>
Pag. 37

<OTA_HotelAvailRS Target="Production" TimeStamp="2008-08-25T22:39:16"> <RoomStays> <RoomStay Status="AvailableForSale" NumberOfUnits="6"> <RoomType Code="2" Name="Habitacin doble"> <Description></Description> </RoomType> <RatePlan Code="SA" Name="Slo alojamiento"> <Description></Description> </RatePlan> <RoomRate Amount="273.0" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-14" End="2008-10-21"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="6"> <RoomType Code="2" Name="Habitacin doble"> <Description></Description> </RoomType> <RatePlan Code="SA" Name="Slo alojamiento"> <Description></Description> </RatePlan> <Package Code="48" Name="Incluye entrada PortAventura"> <Description>Descripcion del paquete</Description> </Package> <RoomRate Amount="413.00" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-14" End="2008-10-21"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="7"> <RoomType Code="2" Name="Habitacin doble"> <Description></Description> </RoomType> <RatePlan Code="PC" Name="Pensin completa"> <Description></Description> </RatePlan> <RoomRate Amount="420.0" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-14" End="2008-10-21"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="8"> <RoomType Code="2" Name="Habitacin doble"> <Description></Description> </RoomType> <RatePlan Code="AD" Name="Alojamiento y desayuno"> <Description></Description> </RatePlan> <Package Code="48" Name="Incluye entrada PortAventura"> <Description>Descripcion del paquete</Description> </Package> <RoomRate Amount="434.00" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-14" End="2008-10-21"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso"/> </RoomStay> </RoomStays> </OTA_HotelAvailRS>
Tags
Package Code Package - Name
Description Code of the package included. Name of the package included. Pag. 38
Values Integer String
Size
Compulsory
Yes Yes

Package Description
Description of the package included.
Text
No
The package included with the rooms is highlighted in bold.
Example 3: Example which shows a request which returns a room with an offer included. The offers show a discount on the final price of the room.
OTA_HotelAvail_RQ-ByCity (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <StayDate Start="2008-10-14" End="2008-10-21"/> <Guest AdultsCount="2" ChildsCount="0"/> <Include Packages="0" Offers="1" Promotions="0" /> <HotelSearchCriteria> <Hotel Code="8" /> </HotelSearchCriteria> </OTA_HotelAvailRQ>
Take note that a 1 has been included in the value Include - Offers
OTA_HotelAvail_RS-ByCity (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRS Target="Production" TimeStamp="2008-08-25T22:07:29"> <RoomStays> <RoomStay Status="AvailableForSale" NumberOfUnits="1"> <RoomType Code="2" Name="Habitacin doble"> <Description></Description> </RoomType> <RatePlan Code="AD" Name="Alojamiento y desayuno"> <Description></Description> </RatePlan> <Offer Code="49" Name="Oferta de Invierno"> <Description>Descripcin de la oferta</Description> </Offer> <RoomRate Amount="254.00" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-14" End="2008-10-21"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="1"> <RoomType Code="2" Name="Habitacin doble"> <Description/> </RoomType> <RatePlan Code="AD" Name="Alojamiento y desayuno"> <Description/> </RatePlan> <RoomRate Amount="294.0" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-14" End="2008-10-21"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="1"> <RoomType Code="2" Name="Habitacin doble"> <Description/> </RoomType>
Pag. 39

<RatePlan Code="MP" Name="Media pensin"> <Description/> </RatePlan> <Offer Code="49" Name="Oferta de Invierno"> <Description>Descripcin de la oferta</Description> </Offer> <RoomRate Amount="310.00" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-14" End="2008-10-21"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso"/> </RoomStay> </RoomStays> </OTA_HotelAvailRS>
Tags
Offer Code Offer - Name
Description Code of the offer included. Name of the offer included.
Values Integer String
Size
Compulsory
Yes Yes
Two rooms with offers included have been returned.
Example 4: Structure of an XML request which asks for three different room types.
OTA_HotelAvail_RQ-ByCity (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <StayDate Start="2008-10-10" End="2008-10-17"/> </Guests> <Guest AdultsCount="2" ChildsCount="0"/> <Guest AdultsCount="1" ChildsCount="1"/> <Guest AdultsCount="3" ChildsCount="0"/> </Guests> <Include Packages="1" Offers="0" Promotions="0"/> <HotelSearchCriteria> <Hotel Code="8" /> </HotelSearchCriteria> </OTA_HotelAvailRQ>
Please note that the number of adults and children per each room type have been specified. The maximum number of different rooms is 3.
OTA_HotelAvail_RS-ByCity (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRS Target="Production" TimeStamp="2008-08-25T21:07:28"> <RoomStays> <RoomStay Status="AvailableForSale" NumberOfUnits="2"> <RoomType Code="2" Name="Habitacin doble"> </Description><Description> </RoomType> <RatePlan Code="AD" Name="Alojamiento y desayuno"> </Description><Description> </RatePlan> <RoomRate Amount="294.0" CurrencyCode="EUR"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/>
Pag. 40

<BasicInfo HotelCode="8" HotelName="Med Playa - Hotel HotelCategoryCode="3"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="3"> <RoomType Code="2" Name="Habitacin doble"> </Description><Description> </RoomType> <RatePlan Code="AD" Name="Alojamiento y desayuno"> </Description><Description> </RatePlan> <RoomRate Amount="250.0" CurrencyCode="EUR"/> <Guest AdultsCount="1" ChildsCount="1"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel HotelCategoryCode="3"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="3"> <RoomType Code="7" Name="Habitacin triple"> </Description><Description> </RoomType> <RatePlan Code="AD" Name="Alojamiento y desayuno"> </Description><Description> </RatePlan> <RoomRate Amount="320.0" CurrencyCode="EUR"/> <Guest AdultsCount="3" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel HotelCategoryCode="3"/> </RoomStay> <RoomStay Status="AvailableForSale" NumberOfUnits="3"> <RoomType Code="7" Name="Habitacin triple"> </Description><Description> </RoomType> <RatePlan Code="TI" Name="Todo Includo"> </Description><Description> </RatePlan> <RoomRate Amount="380.0" CurrencyCode="EUR"/> <Guest AdultsCount="3" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel HotelCategoryCode="3"/> </RoomStay> </RoomStays> </OTA_HotelAvailRS> Calypso"
Calypso"
Calypso"
Calypso"
The request has returned an XML with different room types, ie all the rooms which comply with the guests specified. Example 5: Obtain the availability of a specific package, an offer or an promocod. Promocod is a discount code.
OTA_HotelAvail_RQ-ByHotel (Request) - Specific package <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <Guests> <Guest AdultsCount="2" ChildsCount="0"/> </Guests> <Include Packages="1" Offers="0" Promotions="0"> <Package Id="25"/> </Include> <HotelSearchCriteria>
Pag. 41

<Hotel Code="8" /> </HotelSearchCriteria> </OTA_HotelAvailRQ>
Tags
Package - Id
Description Identifier of package
Values Integer
Size
Compulsory
No
OTA_HotelAvail_RQ-ByHotel (Request) - Specific offer <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <Guests> <Guest AdultsCount="2" ChildsCount="0"/> </Guests> <Include Packages="0" Offers="1" Promotions="0"> <Offer Id="7"/> </Include> <HotelSearchCriteria> <Hotel Code="8" /> </HotelSearchCriteria> </OTA_HotelAvailRQ>
Tags
Offer - Id
Description Identifier of offer
Values Integer
Size
Compulsory
No
OTA_HotelAvail_RQ-ByHotel (Request) - Specific promocod <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <Guests> <Guest AdultsCount="2" ChildsCount="0"/> </Guests> <Include Packages="0" Offers="0" Promotions="1" > <Promotion Id="837"/> </Include> <HotelSearchCriteria> <Hotel Code="8" /> </HotelSearchCriteria> </OTA_HotelAvailRQ>
Tags
Promotion - Id
Description Identifier of promocod
Values Integer
Size
Compulsory
No
Promocodes are applicable to normal priced rooms as well as those with offers and packages applied. However it is not possible to reserve a package and offer for the same room.
OTA_HotelAvail_RQ-ByHotel (Request) - Specific promocod and Specific package <?xml version="1.0" encoding="UTF-8" ?>
Pag. 42

<OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <Guests> <Guest AdultsCount="2" ChildsCount="0"/> </Guests> <Include Packages="1" Offers="0" Promotions="1" > <Package Id="25"/> <Promotion Id="837"/> </Include> <HotelSearchCriteria> <Hotel Code="8" /> </HotelSearchCriteria> </OTA_HotelAvailRQ>
OTA_HotelAvail_RQ-ByHotel (Request)- Specific promocod and any offer <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <Guests> <Guest AdultsCount="2" ChildsCount="0"/> </Guests> <Include Packages="0" Offers="1" Promotions="1" > <Promotion Id="837"/> </Include> <HotelSearchCriteria> <Hotel Code="8" /> </HotelSearchCriteria> </OTA_HotelAvailRQ> OTA_HotelAvail_RQ-ByHotel (Request)- Specific promocod and specific offer <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <Guests> <Guest AdultsCount="2" ChildsCount="0"/> </Guests> <Include Packages="0" Offers="1" Promotions="1" > <Offer Id="7"/> <Promotion Id="837"/> </Include> <HotelSearchCriteria> <Hotel Code="8" /> </HotelSearchCriteria> </OTA_HotelAvailRQ>
The responses to these examples are the same as the previous examples, returning results for rooms, rooms with packages and rooms with offers. Note: In the XML, the fields marked in the table as TEXT type, return the contents via the TAG <![C_DATA[ . ]]>. The purpose of this TAG is to stop the special characters and symbols breaking the basic XML structure. Pag. 43
3.12.- Get availability - No Availability Messages

When we make a request for availability, the system checks the available rooms with regard to the critera for the parameters for check in. It may be that there is no availability because there are no available rooms or for other restrictions in place. In these situations, the system returns a restriction code which will advise the B2B partner the reason for lack of availability. List of Restriction Codes: Code 1 -There are no rooms available. Code 2 (Release) Days beforehand in which the booking can be made: x days Code 3 -Arrivals are not accepted at the hotel for the day selected. Code 4 -The booking requires a stay of a number of minimum days: x days Code 5 -Check Outs are not accepted on the day selected. Example 1: Examplel of a request with no availability. Returns an XML with the Restriction Codes:
OTA_HotelAvail_RQ-ByHotel (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <Guests> <Guest AdultsCount="2" ChildsCount="0"/> </Guests> <Include Packages="0" Offers="0" Promotions="0" /> <HotelSearchCriteria> <Hotel Code="8" /> </HotelSearchCriteria> </OTA_HotelAvailRQ>
Tags
PrimaryLangID Agency - UserId StayDate Start StayDate - End Guest AdultsCount Guest ChildsCount Include Packages Include Offers Hotel - Code
Description Language in which you wish to receive the hotel information. Identifier of Agency making the request Check in date at the hotel. Check out date at the hotel Number of adults per room Number of children per room. If you want to acquire packages linked to the rooms. Only if there are any available package. If you want to acquire offers linked to the rooms. Only if there are any available offer. Hotel code from which room availability is being acquired. Pag. 44
Values String String AAAA-MM-DD AAAA-MM-DD Integer Integer 0 = Dont show packages 1 = Show packages 0 = Dont show packages 1 = Show packages Integer 2
Size
Compulsory
Yes Yes
10 10 2 2 1 1

OTA_HotelAvail_RS-ByHotel (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRS Target="Production" TimeStamp="2008-08-25T21:10:33"> <RoomStays> <RoomStay Status="NotAvailable"> <Restrictions> <Restriction code="4" value="2"/> <Restriction code="3" value="1"/> </Restrictions> <Guest AdultsCount="2" ChildsCount="0" RequestRoomId="1"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="8" HotelName="Med Playa - Hotel Calypso" HotelCategoryCode="3"/> </RoomStay> </RoomStays> </OTA_HotelAvailRS>
Tags
Description Time of the response request. Status of the room. By default , only available rooms will appear. It is the restriction code. It is the value of the restriction code. Only use for code restriction 2 and 4. Check in date. Check out date. Number of adults. Number of children Code of hotel which has the available room. Name of the hotel which has the available room.
Restriction Code Restriction Value StayDate Start StayDate - End Guest AdultsCount Guest ChildsCount BasicInfo HotelCode BasicInfo HotelName
Values AAAA-MMDDTHH:mm:SS AvailableForSale = Room available to book. NotAvailable = Room not available. Integer Integer AAAA-MM-DD AAAA-MM-DD Integer Integer Integer String
Size 19
Compulsory
Yes Yes
1 1 10 10 2 2
Yes Yes Yes Yes Yes Yes Yes Yes
Example 2: Example of a request for 2 rooms.There is availability for one room but not for the other.
OTA_HotelAvail_RS-ByHotel (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelAvailRS TimeStamp="2010-03-03T12:27:18"> <RoomStays> <RoomStay Status="NotAvailable"> <Restrictions> <Restriction code="2" value="5"/> <Restriction code="3" value="1"/> </Restrictions> <Guest AdultsCount="2" ChildsCount="0" RequestRoomId="1"/> <StayDate Start="2010-03-03" End="2010-03-04"/> <BasicInfo HotelCode="3" HotelName="Hotel San Eloy" HotelCategoryCode="2"/> </RoomStay>
Pag. 45

<RoomStay Status="AvailableForSale" NumberOfUnits="10"> <RoomType Code="55" Name="Family room 2/3 "> <Description> <p>The Aparthotel San Eloy has 5 studios of 29 m² each with capacity for 2 or 3 people. Each unit has a kitchen – dining room with two individual beds and a sofa bed. They are equipped with a refrigerator, two hotplates and basic cooking utensils. All studios are situated on the third floor and have balconies, telephone and satellite television.</p> </Description> <Image>/files/hotel/san_eloy/tour/estudi2-518x300.jpg</Image> </RoomType> <RatePlan Code="MP" Name="Half board"> <Description></Description> <Image></Image> </RatePlan> <RoomRate Amount="10" AmountBeforeSpecial="0" CurrencyCode="EUR"/> <Guest AdultsCount="1" ChildsCount="0" RequestRoomId="2"/> <StayDate Start="2010-03-03" End="2010-03-04"/> <BasicInfo HotelCode="3" HotelName="Hotel San Eloy" HotelCategoryCode="2"/> </RoomStay> </RoomStays> </OTA_HotelAvailRS>
Example 3: Examaple of a request for 2 rooms. Neither of the 2 rooms are available.
OTA_HotelAvail_RS-ByHotel (Response) <OTA_HotelAvailRS TimeStamp="2010-03-03T12:26:22"> <RoomStays> <RoomStay Status="NotAvailable"> <Restrictions> <Restriction code="4" value="2"/> <Restriction code="3" value="1"/> </Restrictions> <Guest AdultsCount="2" ChildsCount="0" RequestRoomId="1"/> <StayDate Start="2010-03-03" End="2010-03-04"/> <BasicInfo HotelCode="3" HotelName="Hotel San Eloy" HotelCategoryCode="2"/> </RoomStay> <RoomStay Status="NotAvailable"> <Restrictions> <Restriction code="4" value="2"/> <Restriction code="2" value="6"/> </Restrictions> <Guest AdultsCount="2" ChildsCount="0" RequestRoomId="2"/> <StayDate Start="2010-03-03" End="2010-03-04"/> <BasicInfo HotelCode="3" HotelName="Hotel San Eloy" HotelCategoryCode="2"/> </RoomStay> </RoomStays> </OTA_HotelAvailRS>
Pag. 46
3.13.- Make a reservation 3.13.1.- Initial reservation

In order to carry out a reservation, two requests must be made. In the first place, it is necessary to have a pre-reservation request. This consists of sending an XML with some predetermined data which blocks or holds off the rooms you want to reserve. The second request is the reservation confirmation, which consists in sending another XML which carries out the confirmation of the pre-reserved rooms. In this section, we specify the details of the Pre-Reservation request. In order to carry out this request it is necessary to obtain a list of the rooms which you want to reserve, via the request for availability by hotel code process. A pre-reservation blocks off the rooms so that no other B2B Partner can reserve this particular room(s).However, if the Pre-Reservation is not confirmed within a period of 30 minutes, then it is automatically cancelled from the system. In order to carry out the Pre-Reservation, it is necessary to include in the XML, the client data and data of a credit card. ObeHotel system will not make a charge to this credit card, nor will we pass this information on to third parties as this is private data. We will only retain the numbers of the credit card in case of requests received from the hotel regarding the booking, or possible fraud cases.
Example 1: Example which shows the necessary format to make a reservation for one room.
OTA_HotelResRQ-Initiate (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelResRQ PrimaryLangID="es" ResStatus="Initiate"> <Agency UserId="AgencyId"/> <Client Name="Linus" Surname="Torvalds" Phone="555555555" Email="linus.torvalds@kernel.org"/> <Payment CardType="VisaCard" CardNumber="4111111111111111" ExpireDate="082008" CVC="123"> <CardHolderName>Bill Gates</CardHolderName> </Payment> <Reservations> <Reservation HotelCode="8"> <RoomType Code="2"/> <RatePlan Code="AD"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <Comment>Esto son las observaciones</Comment> </Reservation> </Reservations> </OTA_HotelResRQ>
Tags
PrimaryLangID ResStatus
Description Language for receiving the hotel information. Indicates the type of Reservation Request. Pag. 47
Values String Initiate = Pre-Reservation Request. Commit = Request for 2
Size
Compulsory
Yes Yes
ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved confirmation of reservation. String String String String String VisaCard = Visa. MasterCard = MasterCard Maestro = Maestro. America = American Exp. Discover = Discover. Others = Other cards. String MMAAAA Integer String Integer Integer Integer Integer Integer AAAA-MM-DD AAAA-MM-DD Text 10 10 2 2
Agency - UserId Client - Name Client Surname Client - Phone Client - Email Payment CardType
Identifier for the agency making the request. Name of the lead name of booking. Surname of the lead name of booking. Telephone number of lead name of booking. Email address of the lead name of booking. Type of payment card being used.
Yes Yes Yes Yes Yes Yes
Payment CardNumber Payment ExpirateDate Payment - CVC CardHolderName RoomType - Code RatePlan - Code Guest AdultsCount Guest ChildsCount Reservation HotelCode StayDate Start StayDate - End Comments
Number on the payment card. Expiry date of the payment card. The three digits on the back of card next to signature. Name of the cardholder. Code for room type which you want to reserve. Code for the board basis which you want to reserve. Number of adults. Number of children. Code of the hotel which you want to reserve. Check in date at the hotel. Check out date at the hotel. Any comments you want to include.
16 6 3-4
Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
OTA_HotelResRS-Initiate (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelResRS TimeStamp="2008-08-25T21:15:03" Target="Production"> <UniqueID Value="2632954"/> <Reservation Success="1"/> <RoomStays> <RoomStay Status="1"> <RoomType Code="2"/> <RatePlan Code="AD"/> <RoomRate Amount="294.0"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-10" End="2008-10-17"/> <BasicInfo HotelCode="8"/> </RoomStay> </RoomStays> <TotalReservation Amount="294.0" CurrencyCode="EUR"/>
Pag. 48

</OTA_HotelResRS>
Tags
TimeStamp UniqueID Value Reservation Success
Description Time of the response request. Identifier for the Reservation. This is a unique reference number which identifies that particular reservation. Returns the status of the rooms.
Values AAAA-MMDDTHH:mm:SS String 0 = The Pre-Reservation has not been carried out correctly. 1 = The process for a PreReservation of all the rooms has been carried out correctly. 0 = Error in pre-reserving the room. 1 = Pre-Reservation of the room is correct. Integer Integer Integer Integer Integer AAAA-MM-DD AAAA-MM-DD BigDecimal EUR = Euros
Size 19
Compulsory
Yes Yes
Yes
RoomStay Status
Information field which shows us that the room has been booked. Code for the room. Code for the board basis. Price of the room. Number of adults. Number of children. Hotel Code Check in date at the hotel. Check out date at the hotel. Total Price for the reservation. This is the total of the price for each room requested. Currency used to show the total Price.
Yes
RoomType - Code RatePlan - Code RoomRate Amount Guest AdultsCount Guest ChildsCount BasicInfo HotelCode StayDate Start StayDate - End TotalReservatio n - Amount TotalReservatio n CurrencyCode
Yes Yes 2 2 Yes Yes Yes 10 10 Yes Yes Yes Yes
Example 2: It is possible to book more than one room. In order to this, you only have to add the rooms which you want to book inside the structure reservations. Please take a detailed note of the format of the following request: Note: Although the system supports up to 10 rooms per reservation, we recommend that no more than 4 rooms are requested at the same time. Note: We recommend that all the rooms belonging to the same reservation, are made for the same hotel.
OTA_HotelResRQ-Initiate (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelResRQ PrimaryLangID="es" ResStatus="Initiate"> <Agency UserId="AgencyId"/>
Pag. 49

<Client Name="Linus" Surname="Torvalds" Phone="555555555" Email="linus.torvals@kernel.org"/> <Payment CardType="VisaCard" CardNumber="4111111111111111" ExpireDate="092008" CVC="123"> <CardHolderName>Bill Gates</CardHolderName> </Payment> <Reservations> <Reservation HotelCode="8"> <RoomType Code="2"/> <RatePlan Code="AD"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-06" End="2008-10-07"/> <Comment>es una prueba</Comment> </Reservation> <Reservation HotelCode="8"> <RoomType Code="2"/> <RatePlan Code="AD"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-06" End="2008-10-07"/> <Comment>es una prueba</Comment> </Reservation> </Reservations> </OTA_HotelResRQ>
OTA_HotelResRS-Initiate (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelResRS TimeStamp="2008-09-06T11:46:36" Target="Production"> <UniqueID Value="2775786"/> <Reservation State="preBook" Success="true"/> <RoomStays> <RoomStay Status="preBook"> <RoomType Code="2"/> <RatePlan Code="AD"/> <RoomRate Amount="42.0"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-06" End="2008-10-07"/> <BasicInfo HotelCode="8"/> </RoomStay> <RoomStay Status="preBook"> <RoomType Code="2"/> <RatePlan Code="AD"/> <RoomRate Amount="42.0"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-06" End="2008-10-07"/> <BasicInfo HotelCode="8"/> </RoomStay> </RoomStays> <TotalReservation Amount="84.0" CurrencyCode="EUR"/> </OTA_HotelResRS>
In this example, two double rooms with bed and breakfast for 2 adults have been pre-reserved. The total Price for the reservation is 84 euros.
Example 3: Below is an example of how to make a reservation for a room which includes a package. The methodology is very simple, and consists of specifying all the fields which have been received in the availability request, including the package code. Pag. 50
ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved This format is the same for offers.
OTA_HotelResRQ-Initiate (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelResRQ PrimaryLangID="es" ResStatus="Initiate"> <Agency UserId="AgencyId"/> <Client Name="Linus" Surname="Torvalds" Phone="555555555" Email="linus.torvalds@kernel.org"/> <Payment CardType="VisaCard" CardNumber="4111111111111111" ExpireDate="082008" CVC="123"> <CardHolderName>Bill Gates</CardHolderName> </Payment> <Reservations> <Reservation HotelCode="8"> <RoomType Code="2"/> <RatePlan Code="SA"/> <Package Code="48"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-14" End="2008-10-21"/> <Comment>Es un comentario</Comment> </Reservation> </Reservations> </OTA_HotelResRQ>
Tags
Package - Code Offer - Code
Description Code for the package which you want to reserve. Code for the offer which you want to reserve.
Values Integer Integer
Size
Compulsory
No No
OTA_HotelResRS-Initiate (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelResRS TimeStamp="2008-08-25T22:42:29" Target="Production"> <UniqueID Value="2659210"/> <Reservation Success="1"/> <RoomStays> <RoomStay Status="1"> <RoomType Code="2"/> <RatePlan Code="SA"/> <Package Code="48"/> <RoomRate Amount="413.00"/> <Guest AdultsCount="2" ChildsCount="0"/> <StayDate Start="2008-10-14" End="2008-10-21"/> <BasicInfo HotelCode="8"/> </RoomStay> </RoomStays> <TotalReservation Amount="413.00" CurrencyCode="EUR"/> </OTA_HotelResRS>
In the XML format, please note that the package to be booked is also included.
Example 4: A request for pre-reservation reply which has not worked will have the following XML structure:
OTA_HotelResRS-Initiate (Response)
Pag. 51

<?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelResRS TimeStamp="2008-08-25T22:42:29" Target="Production"> <UniqueID Value="2659210"/> <Reservation Success="0"/> </OTA_HotelResRS>
Pag. 52
3.13.2.- Confirm reservation

As we commented previously, the request for Reservation Confirmation is required in order to confirm the rooms which have been pre-reserved. The confirmation must be carried out within a 30 minute limit from when the XML request for Pre-Reservation and the Request for confirmation are made. In short, in order to confirm the reservation, it is necessary that the UniqueID which the previous request returned to us is used. This UniqueID is the unique identifier/reference number for the reservation.
Example 1: The structure for the Reservation Confirmation must take the following format:
OTA_HotelResRQ-Commit (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelResRQ PrimaryLangID="es" ResStatus="Commit"> <Agency UserId="AgencyId"/> <UniqueID Value="2632954"/> <UniqueIDExternal Value="GD12345" /> </OTA_HotelResRQ>
Tags
PrimaryLangID ResStatus
Description Language for receiving the hotel information. Indicate the type of reservation request.
Values String Initiate = Pre-Reservation request. Commit =Request for Reservation Confirmation. String String 2
Size
Compulsory
Yes Yes
Agency - UserId UniqueID Value
Identifier for the agency making the request. Identifier for the reservation. A unique reference which identifies the reservation.
Yes Yes
OTA_HotelResRQ-Commit (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelResRS TimeStamp="2008-08-25T21:19:41" Target="Production"> <UniqueID Value="2632954" /> <Reservation Confirmation="1" /> </OTA_HotelResRS>
Tags
TimeStamp UniqueID -
Descripction Time of the response request. Identifier for the reservation. A unique Pag. 53
Values AAAA-MMDDTHH:mm:SS String
Size 19
Compulsory
Yes Yes

Value Reservation Confirmation
reference which identifies the reservation. Indicates the status of the Reservation Confirmation. The reservation ID provider (optional)
UniqueIDExterna l - Value
0 = Error in confirming the reservation. 1 = The reservation has been confirmed correctly. String
Yes
No
Once this operation has been completed, the entire reservation process has taken place correctly.
Example 2: example of a XML reply for an incorrect reservation confirmation would have the following format:
OTA_HotelResRQ-Commit (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_HotelResRS TimeStamp="2008-08-25T21:19:41" Target="Production"> <UniqueID Value="2632954" /> <Reservation Confirmation="0" /> </OTA_HotelResRS>
Note: Efimatica & ObeHotel system will not carry out any payment against the credit cards provided during the reservation requests. In no case, will we provide third parties with any data which does not comply with the privacy policy currently in place.
Pag. 54
3.13.3.- Cancel reservation.

The request for a reservation cancellation is used to cancel a reservation which has been previously confirmed. The cancellations are subject to a cancellation policy. The cancellation policy can be obtained via the request for Hotel Information. It is recommended that cancellation requests are made for a maximum of 4 references (UniqueID) within the same request. However, the system can support up to a maximum of 10.
Example 1: In order to carry out a cancellation of a reservation, the XML should have the following format:
OTA_CancelRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_CancelRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <Reservations> <Reservation UniqueID="2806544"/> </Reservations> </OTA_CancelRQ>
Tags
PrimaryLangID Agency - UserId Reservation UniqueID
Description Language in which the hotel information will be received. Identifier of the agency which is making the request. Identifier (reference) of the booking which you want to cancel.
Values String String String 2
Size
Compulsory
Yes Yes Yes
OTA_CancelRS (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_CancelRS TimeStamp="2008-09-14T17:01:17"> <Reservations> <Reservation UniqueID="2806544" Success="1"/> </Reservations> </OTA_CancelRS>
Tags
TimeStamp Reservation UniqueID Reservation UniqueIDExterna l
Description Time of the response request. Identifier of the reservation. A unique identifier/reference which identifies the reservation. External identifier of the reservation. A unique identifier/reference which identifies the reservation. Only if exists. Pag. 55
Values AAAA-MMDDTHH:mm:SS String String
Size 19
Compulsory
Yes Yes No

Reservation Success
Indicates the status of the cancellation of the reservation.
0 = Error in cancelling the reservation. 1 = The reservation has been cancelled correctly.
Yes
Once this process has been completed, the reservation has been cancelled correctly.
Example 2: An XML reply for an incorrect cancellation will follow this standard:
OTA_CancelRS (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_CancelRS TimeStamp="2008-09-14T17:01:17"> <Reservations> <Reservation UniqueID="2806544" Success="0"/> </Reservations> </OTA_CancelRS>
Note that the attribute success of the tag reservation has returned the value 0.
Example 3: In order to carry out a cancellation of a reservation using UniqueIDExternal, the XML should have the following format:
OTA_CancelRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_CancelRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <Reservations> <Reservation UniqueIDExternal="BV000009"/> </Reservations> </OTA_CancelRQ>
Tags
PrimaryLangID Agency - UserId Reservation UniqueIDExterna l
Description Language in which the hotel information will be received. Identifier of the agency which is making the request. Identifier (reference) external of the booking which you want to cancel.
Size
Compulsory
Yes Yes Yes
OTA_CancelRS (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_CancelRS TimeStamp="2008-09-14T17:01:17"> <Reservations> <Reservation UniqueID="2845673" UniqueIDExternal="BV000009" Success="1"/> </Reservations> </OTA_CancelRS>
Pag. 56
ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved Tags

TimeStamp Reservation UniqueID Reservation Success
Description Time of the response request. Identifier of the reservation. A unique identifier/reference which identifies the reservation. Indicates the status of the cancellation of the reservation.
Values AAAA-MMDDTHH:mm:SS String 0 = Error in cancelling the reservation. 1 = The reservation has been cancelled correctly.
Size 19
Compulsory
Yes Yes
Yes
Once this process has been completed, the reservation has been cancelled correctly.
Example 4: An XML reply for an incorrect cancellation will follow this standard:
OTA_CancelRS (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_CancelRS TimeStamp="2008-09-14T17:01:17"> <Reservations> <Reservation UniqueID="2845673" UniqueIDExternal="BV000009" Success="0"/> </Reservations> </OTA_CancelRS>
Note that the attribute success of the tag reservation has returned the value 0. Example 5: An XML reply if UniqueIDExternal has not a relation with an UniqueID will follow this standard:
OTA_CancelRS (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_CancelRS TimeStamp="2008-09-14T17:01:17"> <Reservations> <Reservation UniqueID="" UniqueIDExternal="BV000019" Success="0"/> </Reservations> </OTA_CancelRS>
Note that the attribute success of the tag reservation has returned the value 0.
Pag. 57
3.14.- Get status reservation

The request for the status of a reservation is used to ask for the status of the reservation. With this procedure it is possible to check if the reservation has been cancelled, or also, to check if the reservation has been confirmed correctly.
Example 1: The request for status of the reservation has the following format:
OTA_StateRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_StateRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <Reservations> <Reservation UniqueID="2806544"/> </Reservations> </OTA_StateRQ>
Tags
PrimaryLangID Agency - UserId Reservation UniqueID
Description Language in which the hotel String information will be received. Identifier of the agency making the String request. Identifier (reference) of the booking String for which you want to get information.
Values 2
Size
Compulsory
Yes Yes Yes
OTA_StateRS (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_StateRS TimeStamp="2008-09-14T17:43:12"> <Reservations> <Reservation UniqueID="2806544" Success="0"> <LogTime PreBook="2008-09-08" ConfirmBook="2008-09-09" CancelBook="2008-09-14"/> </Reservation> </Reservations> </OTA_StateRS>
Tags
TimeStamp Reservation UniqueID Reservation Success
Description Time of the response request. Identifier of the reservation. A unique reference which identifies the reservation. Indicates the status of the reservation.
Values AAAA-MMDDTHH:mm:SS String -1 =The reservation does not exist or there has been an error. 0 = The reservation has been cancelled. 1 = The reservation is pending confirmation.
Size 19
Compulsory
Yes Yes
Yes
Pag. 58
ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved 2 = The reservation is confirmed. AAAA-MM-DD AAAA-MM-DD AAAA-MM-DD
LogTime PreBook LogTime ConfirmBook LogTime CancelBook
Date the request for pre-reservation was made. Date the request for reservation confirmation was made. Date the request for cancellation of reservation was made. The value is 0 if it has not been cancelled.
10 10 10
Yes Yes Yes
Example 2: A status request, which has resulted in an error, has the following XML structure:
OTA_StateRS (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_StateRQ TimeStamp="2008-09-14T17:43:34"> <Reservations> <Reservation UniqueID="2806543" Success="-1"/> </Reservations> </OTA_StateRQ>
Note that the value of the attribute success is -1. This indicates that the reservation does not exist, or that you are not authorized to see the status of this reservation, or else there has been an error in the system. Example 3: The request for status of the reservation using UniqueIDexternal has the following format:
OTA_StateRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_StateRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <Reservations> <Reservation UniqueIDExternal="BV00000009"/> </Reservations> </OTA_StateRQ>
Tags
PrimaryLangID Agency - UserId Reservation UniqueIDExterna l
Description Language in which the hotel information will be received. Identifier of the agency making the request. External identifier (reference) of the booking for which you want to get information.
Size
Compulsory
Yes Yes Yes
OTA_StateRS (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_StateRS TimeStamp="2008-09-14T17:43:12"> <Reservations> <Reservation UniqueID="2806545" UniqueIDExternal="BV00000009" Success="0">
Pag. 59

<LogTime PreBook="2008-09-08" ConfirmBook="2008-09-09" CancelBook="2008-09-14"/> </Reservation> </Reservations> </OTA_StateRS>
Tags
TimeStamp Reservation UniqueID Reservation UniqueIDExterna l Reservation Success
Description Time of the response request. Identifier of the reservation. A unique reference which identifies the reservation. External identifier of the reservation. A unique reference which identifies the reservation. Indicates the status of the reservation.
Values AAAA-MMDDTHH:mm:SS String String -1 =The reservation does not exist or there has been an error. 0 = The reservation has been cancelled. 1 = The reservation is pending confirmation. 2 = The reservation is confirmed. AAAA-MM-DD AAAA-MM-DD AAAA-MM-DD
Size 19
Compulsory
Yes Yes Yes
Yes
LogTime PreBook LogTime ConfirmBook LogTime CancelBook
Date the request for pre-reservation was made. Date the request for reservation confirmation was made. Date the request for cancellation of reservation was made. The value is 0 if it has not been cancelled.
10 10 10
Yes Yes Yes
Example 2: A status request, which has resulted in an error, has the following XML structure:
OTA_StateRQ (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_StateRQ TimeStamp="2008-09-14T17:43:34"> <Reservations> <Reservation UniqueID="2806545" UniqueIDExternal="BV00000009" Success="-1"/> </Reservations> </OTA_StateRQ>
Pag. 60
3.15.- Get Reservations List

This XML request returns a list of reservations made on a date range for a hotel. Example 1: This function returns the list with reservations from agency.
OTA_ReservationListRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_ReservationListRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <Reservations> <Reservation HotelCode="8" StartDate="2010-01-02" EndDate="2010-01-10"/> </Reservations> </OTA_ReservationListRQ>
Tags
PrimaryLangID Agency - UserId Reservation HotelCode Reservation StartDate Reservation EndDate
Description Language in which the hotel information will be received. Identifier of the agency making the request. Hotel Code Check in date at the hotel Checkout in date at the hotel
Values String String Int AAAA-MM-DD AAAA-MM-DD 2
Size
Compulsory
Yes Yes Yes
10 10
Yes Yes
OTA_ReservationListRS (Response) <?xml version="1.0" encoding="UTF-8" ?> <OTA_ReservationListRS TimeStamp="2008-09-14T17:43:12"> <Reservations> <Reservation UniqueID="2806544"> <Client Name="Linus" Surname="Torvalds" Phone="555555555" Email="linus.torvals@kernel.org" /> <Rooms> <Room> <Hotel Code="8" Name="Hotel Rio Park" /> <RoomType Code="10" Name="Double Med Room" /> <RatePlan Code="AD" Name="Alojamiento y desayuno" /> <Status Value="1" /> <Guest AdultsCount="2" ChildsCount="0" /> <StayDate Start="2010-01-03" End="2010-01-08" /> <Rate Value="36.00" /> <comment>Esto son las observaciones</comment> </Room> <Room> </Room> </Rooms> </Reservation> </Reservations> </OTA_ReservationListRS>
Pag. 61
Tags
TimeStamp Reservation UniqueID Client - Name Client Surname Client - Phone Client - Email Hotel Code Hotel Name RoomType - Code Roomtype Name RatePlan - Code RatePlan Name Status Value
Description Time of the response request. Identifier of the reservation. A unique reference which identifies the reservation. Name of the lead name of booking. Surname of the lead name of booking. Telephone number of lead name of booking. Email address of the lead name of booking. Code of hotel Name of hotel Code for room type of this booking Name for room type of this booking Code for rate plan of this booking Name for rate plan of this booking Status of this booking
Values AAAA-MMDDTHH:mm:SS String String String String String Integer String Integer String Integer String Integer 0 = Cancelled 1 = Pending 2 = Confirmed Integer Integer Integer Name Integer Name Integer Name AAAA-MM-DD AAAA-MM-DD BigDecimal Text
Size 19
Compulsory
Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes
Guest AdultsCount Guest ChildsCount Package Code Package Name Offer Code Offer Name Promotion Code Promotion Name StayDate Start StayDate - End Rate Value Comments
Number of adults. Number of children. Package code applied to the booking Package name applied to the booking Offer code applied to the booking Offer name applied to the booking Promotion code applied to the booking Promotion name applied to the booking Check in date at the hotel. Check out date at the hotel. rate of the booking Any comments include in booking.
2 2
Yes Yes No No No No No No
10 10
Yes Yes Yes Yes
Pag. 62
3.16.- Upload Reservation

This XML request inserts into the system a list of bookings. The booking can have more than one room.
OTA_ReservationUploadRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_ReservationUploadRQ PrimaryLangID="es"> <Agency UserId="AgencyId" Trackcode="andalucia" /> <Reservations> <Reservation HotelCode="8" Status="new"> <RoomStays> <RoomStay> <StayDate Start="2011-10-10" End="2011-10-17" /> <RoomType Code="2" /> <RatePlan Code="AD" /> <Package Code="2" /> <Guest AdultsCount="2" ChildsCount="0" /> <RoomRate ExternalAmount="294.0" /> </RoomStay> <RoomStay> <StayDate Start="2011-10-10" End="2011-10-17" /> <RoomType Code="3" /> <RatePlan Code="AD" /> <Offer Code="2" /> <Guest AdultsCount="2" ChildsCount="1" /> <RoomRate ExternalAmount="340.0" /> </RoomStay> </RoomStays> <UniqueIDExternal Value="0123412" /> <Client Name="Linus" Surname="Torvalds" Phone="555555555" Email="lt@kernel.org"> <Payment CardType="VisaCard" CardNumber="41xxx" ExpireDate="082008" CVC="123" PercentagePaid="0"> <CardHolderName>Bill Gates</CardHolderName> </Payment> <Comment>Esto son las observaciones</Comment> </Client> </Reservation> <Reservation HotelCode="8" Status="new"> </Reservation> </Reservations> </OTA_ReservationUploadRQ>
Tags
PrimaryLangID Agency - UserId Reservation HotelCode Reservation Status Reservation Trackcode StayDate Start
Description Language in which the hotel information will be received. Identifier of the agency making the request. Hotel Code Status Trackcode of reservation. This is optional Check in date at the hotel Pag. 63
Values String String Int "new" String AAAA-MM-DD 2
Size
Compulsory
Yes Yes Yes Yes Yes
10
Yes

StayDate End RoomType Code RatePlan Code Package Code Offer Code Guest AdultCount Guest ChildsCount RoomRate ExternalAmount Client Name Client Surname Client Phone Client Email Payment CardType
Checkout in date at the hotel Code for room type which you want to reserve. Code for the board basis which you want to reserve. Code of the package included. Code of the offer included. Number of adults. Number of children. Price of room Name of the lead name of booking. Surname of the lead name of booking. Telephone number of lead name of booking. Email address of the lead name of booking. Type of payment card being used.
AAAA-MM-DD Integer String Integer Integer Integer Integer BigDecimal String String String String VisaCard = Visa. MasterCard = MasterCard Maestro = Maestro. America = American Exp. Discover = Discover. Others = Other cards. String MMAAAA String BigDecimal String String String
10
Yes Yes Yes No No Yes Yes Yes Yes Yes Yes Yes Yes
Payment CardNumber Payment ExpireDate Payment CVC Payment PercentagePaid CardHolderName Comment UniqueIDExterna l - Value
Number on the payment card. Expiry date of the payment card. The three digits on the back of card next to signature. Percentage of reservation paid Name of the cardholder. Any comments you want to include. The reservation ID provider (optional)
16 6 3-4
Yes Yes Yes Yes Yes Yes No
OTA_ReservationUploadRS (Response) <?xml version="1.0" encoding="utf-8" ?> <OTA_ReservationUploadRS TimeStamp="2011-04-04T18:08:28"> <Reservations> <Reservation HotelCode="8" RequestReservationId="1"> <UniqueID Value="453087640" /> <RoomStays> <RoomStay Success="1"> <StayDate Start="2011-10-10" End="2011-10-17" /> <RoomType Code="2" /> <RatePlan Code="AD" /> <Package Code="2" /> </RoomStay> <RoomStay Success="1"> </RoomStay> </RoomStays>
Pag. 64

</Reservation> <Reservation HotelCode="8" RequestReservationId="2" Confirmation="1"> <UniqueID Value="453098388" /> <RoomStays> <RoomStay Status="2" Confirmation="1"> </RoomStay> </RoomStays> </Reservation> </Reservations> </OTA_ReservationUploadRS>
Tags
TimeStamp Reservation HotelCode Reservation RequestReservat ionId UniqueID Value RoomStay Success StayDate Start StayDate - End RoomType - Code RatePlan - Code Package Code Offer Code
Description Time of the response request. Identifier of the reservation. A unique reference which identifies the reservation. counter / identifier of the reservation Identifier of the reservation. A unique reference which identifies the reservation. Booking confirmation inserted correctly Check in date at the hotel. Check out date at the hotel. Code for room type of this booking Code for rate plan of this booking Package code applied to the booking Offer code applied to the booking
Values AAAA-MMDDTHH:mm:SS String Integer String Integer 0 = error 1 = success AAAA-MM-DD AAAA-MM-DD Integer Integer Integer Integer
Size 19
Compulsory
Yes Yes Yes Yes
1 10 10
Yes Yes Yes Yes Yes No No
Pag. 65
3.17.- Get Inventory

Example 1: This request gets the inventory of a specific roomtype and rateplan based on a hotel and period of dates.
OTA_InventoryRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_InventoryRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <Inventories> <Inventory HotelCode="8" StartDate="2011-05-02" EndDate="2011-05-10"> <RoomType> <GetType Code="10"/> </RoomType> <RatePlan> <GetType Code="MP"/> </RatePlan> </Inventory> </Inventories> </OTA_InventoryRQ>
Tags
PrimaryLangID Agency - UserId Inventory HotelCode Inventory StartDate Inventory EndDate Roomtype Getype - Code RatePlan Getype - Code
Description Language in which the hotel information will be received. Identifier of the agency making the request. Hotel Code Check in date at the hotel Checkout in date at the hotel Code of the room type that you want the inventory. Code of the rate plan that you want the inventory.
Values String String Int AAAA-MM-DD AAAA-MM-DD Int String 2 2
Size
Compulsory
Yes Yes Yes
10 10
Yes Yes No No
OTA_InventorytRS (Response) <?xml version="1.0" encoding="utf-8" ?> <OTA_InventoryRS TimeStamp="2011-04-29T08:33:58"> <Inventories> <Inventory HotelCode="8" Date="2011-05-02" RatePlanCode="MP" RoomTypeCode="10" > <Availability Value="16" Shared="0" /> <StopSell Value="0" /> <MinimumDays Value="4" /> <Release Value="0" /> <Supplement Days="0" Value="0.00" /> <CloseArrivals Value="0" /> <CloseDepartures Value="0" /> <Rate Value="68.20" /> </Inventory> <Inventory HotelCode="8" Date="2011-05-02" RatePlanCode="MP" RoomTypeCode="10" > <Availability Value="16" Shared="0" /> <StopSell Value="0" /> <MinimumDays Value="4" /> <Release Value="0" />
Pag. 66

<Supplement Days="0" Value="0.00" /> <CloseArrivals Value="0" /> <CloseDepartures Value="0" /> <Rate Value="68.20" /> </Inventory> .... </Inventories> </OTA_InventoryRS>
Tags
TimeStamp Inventory HotelCode Inventory RoomTypeCode Inventory RatePlanCode Inventory Date Availability Value Availability Shared
Description Time of the response request. Code of hotel Code of room type Code of rate plan. Date of inventory Number of romos available Room availability
Values AAAA-MMDDTHH:mm:SS Integer Integer String AAAA-MM-DD Integer 0 = The individuals availability. 0 > The availability is shared, the value is the id of the room where you take the availability 0 = Sales are allowed. 1 = closed sales Integer Integer Integer Integer 0 = Allow checkin that day. 1 = Not allowed checkin that day. 0 = Allow checkout that day. 1 = Not allowed checkout that day. BigDecimal
Size 19
Compulsory
StopSell Value MinimumDays Value Release Value Supplement Days Supplement Value CloseArrivals Value
Allow sales for that day Minimum days of reservation to begin that day. Days ahead for reservations to start the day. If the stay is less than this value, additional charges for Booking. Charge per day applies if stay is less than Supplement Days Close checkin for that day.
Yes Yes
Yes Yes Yes
CloseDepartures Value
Close checkout for that day.
Yes
Rate Value
Room rate for that day.
Yes
Pag. 67
ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved Example 2: This request gets the inventory of any roomtype and rateplan according to a hotel and period of dates.
OTA_InventoryRQ (Request) <?xml version="1.0" encoding="UTF-8" ?> <OTA_InventoryRQ PrimaryLangID="es"> <Agency UserId="AgencyId"/> <Inventories> <Inventory HotelCode="8" StartDate="2011-05-02" EndDate="2011-05-10"> <RoomType> <GetType Code="0"/> </RoomType> <RatePlan> <GetType Code="0"/> </RatePlan> </Inventory> </Inventories> </OTA_InventoryRQ>
OTA_InventorytRS (Response) <?xml version="1.0" encoding="utf-8" ?> <OTA_InventoryRS TimeStamp="2011-04-29T08:33:58"> <Inventories> <Inventory HotelCode="8" Date="2011-05-02" RatePlanCode="MP" RoomTypeCode="10" > <Availability Value="16" Shared="0" /> <StopSell Value="0" /> <MinimumDays Value="4" /> <Release Value="0" /> <Supplement Days="0" Value="0.00" /> <CloseArrivals Value="0" /> <CloseDepartures Value="0" /> <Rate Value="68.20" /> </Inventory> <Inventory HotelCode="8" Date="2011-05-02" RatePlanCode="MP" RoomTypeCode="11" > <Availability Value="16" Shared="10" /> <StopSell Value="0" /> <MinimumDays Value="4" /> <Release Value="0" /> <Supplement Days="0" Value="0.00" /> <CloseArrivals Value="0" /> <CloseDepartures Value="0" /> <Rate Value="68.20" /> </Inventory> .... </Inventories> </OTA_InventoryRS>
Pag. 68
4.- Contact Details

Please do not hesitate to contact us for any query or question you may have. Our team is available to answer queries from Monday to Friday 9-13.30 and 15.00-18.30 IT Department Integrations XML. Informatica - Tel. 972 411 600 dsi@efimatica.com
Pag. 69
Pag. 70

ObeHotel InterfaceXMLv2 60 6

Загружено:

Сведения о документе

Оригинальное название

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

ObeHotel InterfaceXMLv2 60 6

Загружено:

Авторское право:

Доступные форматы

ObeHotel Online Booking Engine

XML Services Specifications Version v2.60.6

ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved

ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved

1.- General Description

ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved

2.- Access Specifications

ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved

2.1.- Examples of the Access Request

ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved

2.2.- Request Generator.

ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved

Values String String 2

Description Time of the response request. Identifier of language. Language Name

Values AAAA-MMDDTHH:mm:SS Integer String

Yes Yes Yes

ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved

3.2.- Get countries List

Values String String 2

Values AAAA-MMDDTHH:mm:SS Integer String

Yes Yes Yes

ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved

3.3.- Get provinces List

Values String String Integer 2

Yes Yes Yes

Values AAAA-MMDDTHH:mm:SS Integer String Integer

Yes Yes Yes Yes

ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved

3.4.- Get cities List

Values String String Integer 2

Yes Yes Yes

Values AAAA-MMDDTHH:mm:SS Integer String Integer

Yes Yes Yes Yes

ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved

3.5.- Get destinations List

Values String String 2

Values AAAA-MMDDTHH:mm:SS Integer String String

Yes Yes Yes Yes

ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved

3.6.- Get zones List

Values String String 2

Values AAAA-MMDDTHH:mm:SS Integer String

Yes Yes Yes

ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved

3.7.- Get hotels List

Values String String Integer 2

Yes Yes Yes

Values AAAA-MMDDTHH:mm:SS Integer String Integer Integer

Yes Yes Yes Yes Yes

ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved

Values String String Integer 2

Yes Yes Yes

Values String String Integer 2

Yes Yes Yes

ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved

ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved

3.8.- Get services list

3.8.1.- Get general hotel services list

Values String String 2

Description Time of the response request. Identifier of service. Service name

Values AAAA-MMDDTHH:mm:SS Integer String

Yes Yes Yes

ObeHotel (www.obehotel.com) 2009 - XML Specifications - All Rights Reserved