PMS Interface API

XML interface API for PMS communication toward Vertical Booking

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

2 | 22

17-Jan-20122 - ver. 1.8

Version History: Version 1.2 1.3 1.4 1.5 1.6 1.7 1.8 Date 3-Feb-2011 8-Jun-2011 4-Jul-2011 6-Oct-2011 24-Oct-2011 10-Nov-2011 17-Jan-2012 Author(s) Ing. Francesco Carsana Ing. Francesco Carsana Ing. Francesco Carsana Dott. Luca Stucchi Dott. Luca Stucchi Ing. Francesco Carsana Ing. Francesco Carsana Notes Added rates updates (for person prices) Added destination channel tags for booking rules Added booking retrieval reference section Moved GuestCounts section in booking response Added modified booking reference in booking response

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

3 | 22

17-Jan-20122 - ver. 1.8

Index
1 2 3 Introduction ......................................................................................................... 4 Set Up .................................................................................................................. 4 Availability Update ............................................................................................... 5 3.1 Reference ......................................................................................................... 5 3.2 Request Example .............................................................................................. 5 3.3 Response Example ............................................................................................ 6 Rates Update (per room prices) ........................................................................... 7 4.1 Reference ......................................................................................................... 7 4.2 Request Example .............................................................................................. 7 4.3 Response Example ............................................................................................ 8 Rates Update (per person prices) ......................................................................... 9 5.1 Reference ......................................................................................................... 9 5.2 Request Example .............................................................................................. 9 5.3 Response Example .......................................................................................... 10 Booking Rules Update ........................................................................................ 11 6.1 Reference ....................................................................................................... 11 6.2 Request Example ............................................................................................ 11 6.3 Response Example .......................................................................................... 12 Booking Retrieval ............................................................................................... 14 7.1 Request Reference .......................................................................................... 14 7.2 Request Example ............................................................................................ 14 7.3 Response Reference ........................................................................................ 14 7.4 Response Example .......................................................................................... 17 Booking Confirmation ......................................................................................... 21 8.1 Request Reference .......................................................................................... 21 8.2 Request Example ............................................................................................ 21 8.3 Response Example .......................................................................................... 22

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

4 | 22

17-Jan-20122 - ver. 1.8

Introduction

Vertical Booking is a complete and versatile online booking system with integrated a IDS Channel Manager and GDS connectivity. Simple for hoteliers to manage and incredibly easy to use for hotel guests, the system provides complete and up to date information for its users.

The following API allow to connect a PMS with Vertical Booking and through it to IDS and GDS.

Set Up

In order to activate the interface the following parameters are necessary: User name Password Hotel Id Room codes Rate plan codes

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

5 | 22

17-Jan-20122 - ver. 1.8

Availability Update

This method is used to update availability.

3.1

Reference
Item Type DateTime String Integer Unique identifier for the hotel Start date End date; note that end date is inclusive Vertical Booking Room Code YYYY-MM-DD YYYY-MM-DD Description Values Format 1.001

OTA_HotelInvCountNotifRQ TimeStamp Version Inventories HotelCode Inventory StatusApplicationControl Start End InvTypeCode InvCounts InvCount CountType Count

Date Date String Int Int

3.2

Request Example

This example update the inventory for room DBLST: from Nov 25th to Nov 26th put 0 rooms available.
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1 = "http://www.opentravel.org/OTA/2003/05" xmlns:ns2 = "http://docs.oasis-open.org/wss/2004/01/oasis200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns3 = "http://schemas.xmlsoap.org/ws/2004/08/addressing"> <SOAP-ENV:Header> <ns2:Security SOAP-ENV:mustUnderstand = "1"> <UsernameToken> <Username>test</Username> <Password>test</Password> </UsernameToken> </ns2:Security> <ns3:MessageID>uuid:84344d83-8078-e17f-a721-56e2facbf13d</ns3:MessageID> <ns3:To>http://www.myhotel.com/ws/ota</ns3:To> <ns3:Action>http://www.myhotel.com/ws/ota/OTA_ReadRQ</ns3:Action> <ns3:From> <ns3:Address>http://schemas.xmlsoap.org/ws/2004/12/addressing/role/anonymous</ns3:Address> </ns3:From> </SOAP-ENV:Header> <SOAP-ENV:Body> <ns1:OTA_HotelInvCountNotifRQ TimeStamp = "2010-10-22T16:47:16+02:00" Version = "1.001"> <ns1:Inventories HotelCode = "5071"> <ns1:Inventory>

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

6 | 22

17-Jan-20122 - ver. 1.8

<ns1:StatusApplicationControl Start = "2010-11-25" End = "2010-11-25" InvTypeCode = "MTRD"/> <ns1:InvCounts> <ns1:InvCount CountType = "1" Count = "10"/> </ns1:InvCounts> </ns1:Inventory> <ns1:Inventory> <ns1:StatusApplicationControl Start = "2010-11-26" End = "2010-11-26" InvTypeCode = "MTRD"/> <ns1:InvCounts> <ns1:InvCount CountType = "1" Count = "5"/> </ns1:InvCounts> </ns1:Inventory> </ns1:Inventories> </ns1:OTA_HotelInvCountNotifRQ> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

3.3

Response Example

<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1 = "http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:ns2 = "http://www.opentravel.org/OTA/2003/05"> <SOAP-ENV:Header> <ns1:MessageID>uuid:e73be007-3adb-cc93-8394-e56977350c3f</ns1:MessageID> <ns1:To>http://www.myhotel.com/ws/ota</ns1:To> <ns1:From> <Address>http://schemas.xmlsoap.org/ws/2004/12/addressing/role/anonymous</Address> </ns1:From> <ns1:RelatesTo RelationshipType = "ns1:Reply">uuid:84344d83-8078-e17f-a72156e2facbf13d</ns1:RelatesTo> <ns1:Action>http://www.aecinternet.it/booking_engine/int/myhotel/OTA_HotelInvCountNotifRS</ns1:Action> </SOAP-ENV:Header> <SOAP-ENV:Body> <ns2:OTA_HotelInvCountNotifRS> <ns2:Success/> </ns2:OTA_HotelInvCountNotifRS> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

7 | 22

17-Jan-20122 - ver. 1.8

Rates Update (per room prices)

This method is used to update rates (per room prices).

4.1

Reference
Item Type datetime String Integer Unique identifier the hotel for Description Values Format 1.000

OTA_HotelRateAmountNotifRQ TimeStamp Version RateAmountMessages HotelCode RateAmountMessages RateAmountMessage StatusApplicationControl Start End InvTypeCode RatePlanCode Rates Rate BaseByGuestAmts CurrencyCode AmoutAfterTax

Date Date String String

Start date End date; note that end date is inclusive Vertical Booking Room Code Vertical Booking Rate Code

YYYY-MM-DD YYYY-MM-DD

String Float

Hotel Currency Price

4.2

Request Example

This example update the rate for room MTRD and rate plan BB_BAR_ROOM: from Nov 25th to Nov 26th.
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1 = "http://www.opentravel.org/OTA/2003/05" xmlns:ns2 = "http://docs.oasis-open.org/wss/2004/01/oasis200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns3 = "http://schemas.xmlsoap.org/ws/2004/08/addressing"> <SOAP-ENV:Header> <ns2:Security SOAP-ENV:mustUnderstand = "1"> <UsernameToken> <Username>test</Username> <Password>test</Password> </UsernameToken> </ns2:Security> <ns3:MessageID>uuid:ee4f29bd-070d-a0d9-5e41-f06910676ff7</ns3:MessageID> <ns3:To>http://www.myhotel.com/ws/ota</ns3:To> <ns3:Action>http://www.myhotel.com/ws/ota/OTA_ReadRQ</ns3:Action> <ns3:From> <ns3:Address>http://schemas.xmlsoap.org/ws/2004/12/addressing/role/anonymous</ns3:Address> </ns3:From>

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

8 | 22

17-Jan-20122 - ver. 1.8

</SOAP-ENV:Header> <SOAP-ENV:Body> <ns1:OTA_HotelRateAmountNotifRQ TimeStamp = "2010-10-26T09:25:18+02:00" Version = "1.000"> <ns1:RateAmountMessages HotelCode = "5071"> <ns1:RateAmountMessage> <ns1:StatusApplicationControl Start = "2010-11-25" End = "2010-11-25" RatePlanCode = "BB_BAR_ROOM" InvTypeCode = "MTRD"/> <ns1:Rates> <ns1:Rate> <ns1:BaseByGuestAmts> <ns1:BaseByGuestAmt AmountAfterTax = "123.00" CurrencyCode = "EUR"/> </ns1:BaseByGuestAmts> </ns1:Rate> </ns1:Rates> </ns1:RateAmountMessage> <ns1:RateAmountMessage> <ns1:StatusApplicationControl Start = "2010-11-26" End = "2010-11-28" RatePlanCode = "BB_BAR_ROOM" InvTypeCode = "MTRD"/> <ns1:Rates> <ns1:Rate> <ns1:BaseByGuestAmts> <ns1:BaseByGuestAmt AmountAfterTax = "234.00" CurrencyCode = "EUR"/> </ns1:BaseByGuestAmts> </ns1:Rate> </ns1:Rates> </ns1:RateAmountMessage> </ns1:RateAmountMessages> </ns1:OTA_HotelRateAmountNotifRQ> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

4.3

Response Example

<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1 = "http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:ns2 = "http://www.opentravel.org/OTA/2003/05"> <SOAP-ENV:Header> <ns1:MessageID>uuid:952bf152-52e1-ede5-e16c-801bce155c60</ns1:MessageID> <ns1:To>http://www.myhotel.com/ws/ota</ns1:To> <ns1:From> <Address>http://schemas.xmlsoap.org/ws/2004/12/addressing/role/anonymous</Address> </ns1:From> <ns1:RelatesTo RelationshipType = "ns1:Reply">uuid:ee4f29bd-070d-a0d9-5e41f06910676ff7</ns1:RelatesTo> <ns1:Action>http://www.aecinternet.it/booking_engine/int/myhotel/OTA_HotelRateAmountNotifRS</ns1:Action> </SOAP-ENV:Header> <SOAP-ENV:Body> <ns2:OTA_HotelRateAmountNotifRS> <ns2:Success/> </ns2:OTA_HotelRateAmountNotifRS> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

9 | 22

17-Jan-20122 - ver. 1.8

Rates Update (per person prices)

This method is used to update rates (per person prices).

5.1

Reference
Item Type datetime String Integer Unique identifier the hotel for Description Values Format 1.000

OTA_HotelRateAmountNotifRQ TimeStamp Version RateAmountMessages HotelCode RateAmountMessages RateAmountMessage StatusApplicationControl Start End InvTypeCode RatePlanCode Rates Rate BaseByGuestAmts CurrencyCode AmoutAfterTax NumberOfGuests AgeQualifyingCode

Date Date String String

Start date End date; note that end date is inclusive Vertical Booking Room Code Vertical Booking Rate Code

YYYY-MM-DD YYYY-MM-DD

String Float Int Int

Hotel Currency Price Number of guest 10

5.2

Request Example

This example update the rate for room MTRD and rate plan BB_BAR_ROOM: from Nov 25th to Nov 26th.
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1 = "http://www.opentravel.org/OTA/2003/05" xmlns:ns2 = "http://docs.oasis-open.org/wss/2004/01/oasis200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns3 = "http://schemas.xmlsoap.org/ws/2004/08/addressing"> <SOAP-ENV:Header> <ns2:Security SOAP-ENV:mustUnderstand = "1"> <UsernameToken> <Username>test</Username> <Password>test</Password> </UsernameToken> </ns2:Security> <ns3:MessageID>uuid:ee4f29bd-070d-a0d9-5e41-f06910676ff7</ns3:MessageID> <ns3:To>http://www.myhotel.com/ws/ota</ns3:To> <ns3:Action>http://www.myhotel.com/ws/ota/OTA_ReadRQ</ns3:Action>

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

10 | 22

17-Jan-20122 - ver. 1.8

<ns3:From> <ns3:Address>http://schemas.xmlsoap.org/ws/2004/12/addressing/role/anonymous</ns3:Address> </ns3:From> </SOAP-ENV:Header> <SOAP-ENV:Body> <ns1:OTA_HotelRateAmountNotifRQ TimeStamp = "2010-10-26T09:25:18+02:00" Version = "1.000"> <ns1:RateAmountMessages HotelCode = "5071"> <ns1:RateAmountMessage> <ns1:StatusApplicationControl Start = "2010-11-25" End = "2010-11-25" RatePlanCode = "BB_BAR_ROOM" InvTypeCode = "MTRD"/> <ns1:Rates> <ns1:Rate> <ns1:BaseByGuestAmts> <ns1:BaseByGuestAmt AmountAfterTax = "123.00" CurrencyCode = "EUR" NumberOfGuests = "2" AgeQualifyingCode = "10"/> </ns1:BaseByGuestAmts> </ns1:Rate> </ns1:Rates> </ns1:RateAmountMessage> <ns1:RateAmountMessage> <ns1:StatusApplicationControl Start = "2010-11-26" End = "2010-11-28" RatePlanCode = "BB_BAR_ROOM" InvTypeCode = "MTRD"/> <ns1:Rates> <ns1:Rate> <ns1:BaseByGuestAmts> <ns1:BaseByGuestAmt AmountAfterTax = "234.00" CurrencyCode = "EUR" NumberOfGuests = "2" AgeQualifyingCode = "10"/> </ns1:BaseByGuestAmts> </ns1:Rate> </ns1:Rates> </ns1:RateAmountMessage> </ns1:RateAmountMessages> </ns1:OTA_HotelRateAmountNotifRQ> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

5.3

Response Example

<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1 = "http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:ns2 = "http://www.opentravel.org/OTA/2003/05"> <SOAP-ENV:Header> <ns1:MessageID>uuid:952bf152-52e1-ede5-e16c-801bce155c60</ns1:MessageID> <ns1:To>http://www.myhotel.com/ws/ota</ns1:To> <ns1:From> <Address>http://schemas.xmlsoap.org/ws/2004/12/addressing/role/anonymous</Address> </ns1:From> <ns1:RelatesTo RelationshipType = "ns1:Reply">uuid:ee4f29bd-070d-a0d9-5e41f06910676ff7</ns1:RelatesTo> <ns1:Action>http://www.aecinternet.it/booking_engine/int/myhotel/OTA_HotelRateAmountNotifRS</ns1:Action> </SOAP-ENV:Header> <SOAP-ENV:Body> <ns2:OTA_HotelRateAmountNotifRS> <ns2:Success/> </ns2:OTA_HotelRateAmountNotifRS> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

11 | 22

17-Jan-20122 - ver. 1.8

6
6.1

Booking Rules Update

OTA_HotelBookingRuleNotifRQ TimeStamp Target Version RulesMessages HotelCode RuleMessages RuleMessage StatusApplicationControl Start End InvTypeCode RatePlanCode DestinationSystemCodes DestinationSystemCode BookingRules BookingRule RestrictionStatus

Date Date String String Int

Start date End date; note that end date is inclusive Vertical Booking Room Code Vertical Booking Rate Code Vertical Booking Channel code

YYYY-MM-DD YYYY-MM-DD

Restiction

String

Master stop sales on room code /rate code for the specified period Arrival closed to arrival room code /rate code for the specified period

Master/Arrival

Status LengthsOfStay LengthOfStay MinMaxMessageType TimeUnit Time

Open/Close String String Int SetMinLOS Day

6.2

Request Example

This example update the inventory for room DBL and rate plan BAR: from Jun 19th to Jun 20th set a minimum stay of 2 nights, opens the room for selling and to arrival.
<?xml version="1.0" encoding="UTF-8"?>

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

12 | 22

17-Jan-20122 - ver. 1.8

<SOAP-ENV:Envelope xmlns:SOAP-ENV = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1 = "http://www.opentravel.org/OTA/2003/05" xmlns:ns2 = "http://docs.oasis-open.org/wss/2004/01/oasis200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns3 = "http://schemas.xmlsoap.org/ws/2004/08/addressing"> <SOAP-ENV:Header> <ns2:Security SOAP-ENV:mustUnderstand = "1"> <UsernameToken> <Username>test</Username> <Password>test</Password> </UsernameToken> </ns2:Security> <ns3:MessageID>uuid:be91c51a-b605-102d-94d6-0030487c664c</ns3:MessageID> <ns3:To>http://www.myhotel.com/ws/ota</ns3:To> <ns3:Action>http://www.myhotel.com/ws/ota/OTA_ReadRQ</ns3:Action> <ns3:From> <ns3:Address>http://schemas.xmlsoap.org/ws/2004/12/addressing/role/anonymous</ns3:Address> </ns3:From> </SOAP-ENV:Header> <SOAP-ENV:Body> <ns1:OTA_HotelBookingRuleNotifRQ TimeStamp = "2010-05-21T10:48:01+02:00" Target = "Production" Version = "1.000"> <ns1:RuleMessages HotelCode = "5071"> <ns1:RuleMessage> <ns1:StatusApplicationControl Start = "2010-06-19" End = "2010-06-20" RatePlanCode = "BAR" InvTypeCode = "DBL"> <ns1:DestinationSystemCodes> <ns1:DestinationSystemCode>11</ns1:DestinationSystemCode> <ns1:DestinationSystemCode>15</ns1:DestinationSystemCode> </ns1:DestinationSystemCodes> </ns1:StatusApplicationControl> <ns1:BookingRules> <ns1:BookingRule> <ns1:LengthsOfStay> <ns1:LengthOfStay Time = "2" TimeUnit = "Day" MinMaxMessageType = "SetMinLOS"/> </ns1:LengthsOfStay> </ns1:BookingRule> <ns1:BookingRule> <ns1:RestrictionStatus Restriction = "Master" Status = "Close"/> </ns1:BookingRule> <ns1:BookingRule> <ns1:RestrictionStatus Restriction = "Arrival" Status = "Open"/> </ns1:BookingRule> </ns1:BookingRules> </ns1:RuleMessage> </ns1:RuleMessages> </ns1:OTA_HotelBookingRuleNotifRQ> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

6.3

Response Example

<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1 = "http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:ns2 = "http://www.opentravel.org/OTA/2003/05"> <SOAP-ENV:Header> <ns1:MessageID>uuid:77bdaccb-e8cf-fb9f-5de6-0cb9f84a1f19</ns1:MessageID> <ns1:To>http://www.myhotel.com/ws/ota</ns1:To> <ns1:From> <Address>http://schemas.xmlsoap.org/ws/2004/12/addressing/role/anonymous</Address> </ns1:From> <ns1:RelatesTo RelationshipType = "ns1:Reply">uuid:be91c51a-b605-102d-94d60030487c664c</ns1:RelatesTo> <ns1:Action>http://www.aecinternet.it/booking_engine/int/myhotel/OTA_HotelBookingRuleNotifRQ</ns1:Action>

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

13 | 22

17-Jan-20122 - ver. 1.8

</SOAP-ENV:Header> <SOAP-ENV:Body> <ns2:OTA_HotelBookingRuleNotifRS> <ns2:Success/> </ns2:OTA_HotelBookingRuleNotifRS> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

14 | 22

17-Jan-20122 - ver. 1.8

7
7.1

Booking Retrieval
Request Reference
Item Type datetime String Integer Unique identifier for the hotel Description Values Format 1

OTA_ReadRQ TimeStamp Version ReadRequests HotelReadRequest HotelCode

7.2

Request Example

<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1 = "http://www.opentravel.org/OTA/2003/05" xmlns:ns2 = "http://docs.oasis-open.org/wss/2004/01/oasis200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns3 = "http://schemas.xmlsoap.org/ws/2004/08/addressing"> <SOAP-ENV:Header> <ns2:Security SOAP-ENV:mustUnderstand = "1"> <UsernameToken> <Username>test</Username> <Password>test</Password> </UsernameToken> </ns2:Security> <ns3:MessageID>uuid:712e7f5b-8353-d6b9-1531-b27d5a53f6d7</ns3:MessageID> <ns3:To>http://www.myhotel.com/ws/ota</ns3:To> <ns3:Action>http://www.myhotel.com/ws/ota/OTA_ReadRQ</ns3:Action> <ns3:From> <ns3:Address>http://schemas.xmlsoap.org/ws/2004/12/addressing/role/anonymous</ns3:Address> </ns3:From> </SOAP-ENV:Header> <SOAP-ENV:Body> <ns1:OTA_ReadRQ TimeStamp = "2010-10-22T16:26:02+02:00" Version = "1"> <ns1:ReadRequests> <ns1:HotelReadRequest HotelCode = "5071"/> </ns1:ReadRequests> </ns1:OTA_ReadRQ> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

7.3

Response Reference
Item Type Description 1.000 [fixed] DateTime Present only if request is correct Present only in case of errors Error description ISO 8601 Values Format

OTA_ResRetrieveRS Version Timestamp Success Errors Error

String

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

15 | 22

17-Jan-20122 - ver. 1.8

Code ReservationsList HotelReservation RoomStayReservation ResStatus CreateDateTime UniqueID Type ID_Context ID RoomStays RoomStay RoomTypes RoomType NumberOfUnits RoomTypeCode RatePlans RatePlan RatePlanCode RoomRates RoomRate RoomTypeCode RatePlanCode Rates Rate RateTimeUnit EffectiveDate ExpireDate Base AmountAfterTax CurrencyCode GuestCounts GuestCount AgeQualifyingCode Age Count TimeSpan Start End ResGuests ResGuest Profiles ProfileInfo Profile

String Boolean String DateTime Integer String String

Error Code true [fixed] Reservation status Creation time 14 [fixed] CrsConfirmNumber [fixed] Reservation CRS Code [Commit | Cancel] ISO 8601

Integer String String String String String Date Date Float String

Number of Rooms Room Type Code Rate Plan Code Room Type Code Rate Plan Code Day [fixed] Begin date End date Day-by-day price ISO 4217 [10=Adult | 8=Children] Age of the guest Number of guests related with the current AgeQualifyCode Check in date Check out date YYYY-MM-DD YYYY-MM-DD

YYYY-MM-DD YYYY-MM-DD

Integer Integer Integer Date Date

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

16 | 22

17-Jan-20122 - ver. 1.8

ProfileType Customer PersonName GivenName Surname Telephone PhoneTechType PhoneNumber Email Address CityName PostalCode StateProv CountryName ResGlobalInfo HotelReservationIDs HotelReservationID ResID_Type ResID_Value Comments Comment Text Guarantee GuaranteesAccepted GuaranteeAccepted PaymentTransactionTypeCode PaymentCard CardType CardCode

Integer

Code of the associated profile First (given) name of the guest Surname of the guest Type of telephone contact information Telephone number Email address City name City ZIP code Province Country name [optional] 25 (=Associated reservation) [fixed]

[1=Reserver | 21=Customer]

String String Integer String String String String String String

1 Fixed line

Present only in case of modification

String

Reservation CRS Code

Previuos reservation code (replaced by this reservation)

String

Comment string

String

charge [fixed] 1 (=Credit) [fixed] Credit Card Number

charge

CardNumber

[AX=American Express | BC=Bank Card | CB=Carte Blanche | BL=Carte Bleu | DN=Diners Club | DS=Discover Card | EC=Eurocard | JC=Japanese Credit Bureau Credit Card | MC=Master Card | TP=Universal Air Travel Card | VI=Visa]

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

17 | 22

17-Jan-20122 - ver. 1.8

ExpireDate SeriesCode CardHolderName Total AmountAfterTax CurrencyCode Profiles ProfileInfo UniqueID Type ID_Context ID Profile ProfileType CompanyInfo CompanyName CompanyShortName Code CodeContext AddressInfo TelephoneInfo PhoneTechType PhoneNumber TPA_Extentions PrenRequestCode String String String Integer Float String

CC Expiration Date

Total amount (gross), only if rates are commissionable Currency Total number of guests

ISO 4217

Integer Integer Integer

A unique identifying value assigned by the creating system Source of the identifier A unique identifying value assigned by the creating system

[7=Wholesaler | 12=Hotel | 13=Internet broker | 18=Other | 32=Merchant]

[CRS | IATA]

Code of the associated profile

[2=GDS | 3=Corporation | 4=Travel agent | 5=Wholesaler | 10=Internet broker | 12=Hotel]

Short name for the company Company Code VerticalBooking Type of telephone contact information Telephone number

Integer String Integer

1 Fixed Line

7.4

Response Example

<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1 = "http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:ns2 = "http://www.opentravel.org/OTA/2003/05"> <SOAP-ENV:Header> <ns1:MessageID>uuid:6548d817-95bb-49e4-2192-9becc3c73294</ns1:MessageID> <ns1:To>http://www.gestionealbergo.com/ws/ota</ns1:To> <ns1:From>

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

18 | 22

17-Jan-20122 - ver. 1.8

<Address>http://schemas.xmlsoap.org/ws/2004/12/addressing/role/anonymous</Address> </ns1:From> <ns1:RelatesTo RelationshipType = "ns1:Reply">uuid:712e7f5b-8353-d6b9-1531b27d5a53f6d7</ns1:RelatesTo> <ns1:Action>http://www.aec-internet.it/booking_engine/int/gestione albergo/OTA_ResRetrieveRS</ns1:Action> </SOAP-ENV:Header> <SOAP-ENV:Body> <ns2:OTA_ResRetrieveRS> <ns2:Success/> <ns2:ReservationsList> <ns2:HotelReservation RoomStayReservation = "true" ResStatus = "Commit" CreateDateTime = "2010-09-22T08:32:48+02:00"> <ns2:UniqueID Type = "14" ID_Context = "CrsConfirmNumber" ID = "287329696/87030894|8953"/> <ns2:RoomStays> <ns2:RoomStay> <ns2:RoomTypes> <ns2:RoomType RoomTypeCode = "MTRD" NumberOfUnits = "1"/> </ns2:RoomTypes> <ns2:RatePlans> <ns2:RatePlan RatePlanCode = "BB_BAR"/> </ns2:RatePlans> <ns2:RoomRates> <ns2:RoomRate RoomTypeCode = "MTRD" RatePlanCode = "BB_BAR"> <ns2:Rates> <ns2:Rate RateTimeUnit = "Day" EffectiveDate = "2010-10-23" ExpireDate = "201010-24"> <ns2:Base AmountAfterTax = "200.0000" CurrencyCode = "EUR"/> </ns2:Rate> <ns2:Rate RateTimeUnit = "Day" EffectiveDate = "2010-10-24" ExpireDate = "201010-25"> <ns2:Base AmountAfterTax = "102.0000" CurrencyCode = "EUR"/> </ns2:Rate> <ns2:Rate RateTimeUnit = "Day" EffectiveDate = "2010-10-25" ExpireDate = "201010-26"> <ns2:Base AmountAfterTax = "102.0000" CurrencyCode = "EUR"/> </ns2:Rate> <ns2:Rate RateTimeUnit = "Day" EffectiveDate = "2010-10-26" ExpireDate = "201010-27"> <ns2:Base AmountAfterTax = "85.0000" CurrencyCode = "EUR"/> </ns2:Rate> <ns2:Rate RateTimeUnit = "Day" EffectiveDate = "2010-10-27" ExpireDate = "201010-28"> <ns2:Base AmountAfterTax = "85.0000" CurrencyCode = "EUR"/> </ns2:Rate> <ns2:Rate RateTimeUnit = "Day" EffectiveDate = "2010-10-28" ExpireDate = "201010-29"> <ns2:Base AmountAfterTax = "72.2500" CurrencyCode = "EUR"/> </ns2:Rate> <ns2:Rate RateTimeUnit = "Day" EffectiveDate = "2010-10-29" ExpireDate = "201010-30"> <ns2:Base AmountAfterTax = "85.0000" CurrencyCode = "EUR"/> </ns2:Rate> </ns2:Rates> </ns2:RoomRate> </ns2:RoomRates> <GuestCounts> <GuestCount AgeQualifyingCode = "10" Count = "2"/> </GuestCounts> <ns2:TimeSpan Start = "2010-10-23" End = "2010-10-30"/> </ns2:RoomStay> </ns2:RoomStays> <ns2:ResGuests> <ns2:ResGuest> <ns2:Profiles> <ns2:ProfileInfo>

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

19 | 22

17-Jan-20122 - ver. 1.8

<ns2:Profile ProfileType = "1"> <ns2:Customer BirthDate = "1950-12-31"> <ns2:PersonName> <ns2:GivenName>tizio</ns2:GivenName> <ns2:Surname>caio</ns2:Surname> </ns2:PersonName> <ns2:Telephone PhoneTechType = "1" PhoneNumber = "0123456789"/> <ns2:Email>[email protected]</ns2:Email> <ns2:Address> <ns2:AddressLine>via viole 15</ns2:AddressLine> <ns2:CityName>Roma</ns2:CityName> <ns2:PostalCode>12345</ns2:PostalCode> <ns2:StateProv>RM</ns2:StateProv> <ns2:CountryName>IT</ns2:CountryName> </ns2:Address> </ns2:Customer> </ns2:Profile> </ns2:ProfileInfo> </ns2:Profiles> </ns2:ResGuest> </ns2:ResGuests> <ns2:ResGlobalInfo> <ns2: HotelReservationIDs> <ns2: HotelReservationID ResID_Type = "25" ResID_Value = "287329696/87030881|8947"/> <ns2: HotelReservationIDs> <ns2:Comments> <ns2:Comment> <ns2:Text> GUEST NAME:Mario ROSSI Late arrive No smoking room Nr. guests: 2 Commission Amount: 146.25 </ns2:Text> </ns2:Comment> </ns2:Comments> <ns2:Guarantee> <ns2:GuaranteesAccepted> <ns2:GuaranteeAccepted PaymentTransactionTypeCode = "charge"> <ns2:PaymentCard CardType = "1" CardCode = "MC" CardNumber = "0000000000099" SeriesCode = "000" ExpireDate = "0911"> <ns2:CardHolderName>tizio</ns2:CardHolderName> </ns2:PaymentCard> </ns2:GuaranteeAccepted> </ns2:GuaranteesAccepted> </ns2:Guarantee> <ns2:Total AmountAfterTax = "731.25" CurrencyCode = "EUR"/> <ns2:Profiles> <ns2:ProfileInfo> <ns2:UniqueID Type = "32" ID_Context = "CRS" ID = "11"/> <ns2:Profile ProfileType = "10"> <ns2:CompanyInfo> <ns2:CompanyName CompanyShortName = "BOOKINGS EUROPE B.V." Code = "9606020" CodeContext = "IATA"/> <ns2:AddressInfo/> <ns2:TelephoneInfo PhoneTechType = "1" PhoneNumber = "0031-200005414"/> <ns2:BusinessLocale> <ns2:AddressLine>WETERINGSCHANS 28 - 4, 1017 SG</ns2:AddressLine> <ns2:CityName>AMSTERDAM</ns2:CityName> <ns2:PostalCode>1000</ns2:PostalCode> <ns2:CountryName>NL</ns2:CountryName> </ns2:BusinessLocale> </ns2:CompanyInfo> </ns2:Profile> </ns2:ProfileInfo> </ns2:Profiles>

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

20 | 22

17-Jan-20122 - ver. 1.8

</ns2:ResGlobalInfo> </ns2:HotelReservation> </ns2:ReservationsList> </ns2:OTA_ResRetrieveRS> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

21 | 22

17-Jan-20122 - ver. 1.8

8
8.1

Booking Confirmation
Request Reference
Item Type Description Values Format

OTA_HotelResNotifRQ HotelReservations HotelReservation UniqueID Type ID_Context ID ResGlobalInfo HotelReservationIDs HotelReservationID ResID_Type ResID_Value ResID_Source ResID_SourceContext

Integer String String

14 CrsConfirmNumber Reservation ID to confirm

Integer String String String

10 Reservation ID in PMS system PMS PmsConfirmNumber

8.2

Request Example

<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1 = "http://www.opentravel.org/OTA/2003/05" xmlns:ns2 = "http://docs.oasis-open.org/wss/2004/01/oasis200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns3 = "http://schemas.xmlsoap.org/ws/2004/08/addressing"> <SOAP-ENV:Header> <ns2:Security SOAP-ENV:mustUnderstand = "1"> <UsernameToken> <Username>test</Username> <Password>test</Password> </UsernameToken> </ns2:Security> <ns3:MessageID>uuid:712e7f5b-8353-d6b9-1531-b27d5a53f6d7</ns3:MessageID> <ns3:To>http://www.myhotel.com/ws/ota</ns3:To> <ns3:Action>http://www.myhotel.com/ws/ota/OTA_ReadRQ</ns3:Action> <ns3:From> <ns3:Address>http://schemas.xmlsoap.org/ws/2004/12/addressing/role/anonymous</ns3:Address> </ns3:From> </SOAP-ENV:Header> <SOAP-ENV:Body> <ns1:OTA_HotelResNotifRQ> <ns1:HotelReservations> <ns1:HotelReservation> <ns1:UniqueID Type = "14" ID_Context = "CrsConfirmNumber" ID = "287329696/87030894|8953"/> <ns1:ResGlobalInfo> <ns1:HotelReservationIDs> <ns1:HotelReservationID ResID_Type = "10" ResID_Value = "123456ABCD" ResID_Source = "PMS" ResID_SourceContext = "PmsConfirmNumber"/> </ns1:HotelReservationIDs> </ns1:ResGlobalInfo> </ns1:HotelReservation> </ns1:HotelReservations> </ns1:OTA_HotelResNotifRQ> </SOAP-ENV:Body>

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]

PMS Interface API

22 | 22

17-Jan-20122 - ver. 1.8

</SOAP-ENV:Envelope>

8.3

Response Example

<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1 = "http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:ns2 = "http://www.opentravel.org/OTA/2003/05"> <SOAP-ENV:Header> <ns1:MessageID>uuid:6548d817-95bb-49e4-2192-9becc3c73294</ns1:MessageID> <ns1:To>http://www.gestionealbergo.com/ws/ota</ns1:To> <ns1:From> <Address>http://schemas.xmlsoap.org/ws/2004/12/addressing/role/anonymous</Address> </ns1:From> <ns1:RelatesTo RelationshipType = "ns1:Reply">uuid:712e7f5b-8353-d6b9-1531b27d5a53f6d7</ns1:RelatesTo> <ns1:Action>http://www.aec-internet.it/booking_engine/int/gestione albergo/OTA_ResRetrieveRS</ns1:Action> </SOAP-ENV:Header> <SOAP-ENV:Body> <ns2:OTA_HotelResNotifRS> <ns2:Success/> </ns2:OTA_HotelResNotifRS> </SOAP-ENV:Body> </SOAP-ENV:Envelope>

A.E.C. ADVERTISING AND ELECTRONIC COMMERCE s.r.l. Piazza Pontida, 7 I-24122 Bergamo (Italy) - Tel. +39 035 232366 - Fax. +39 035 210500 E-mail: [email protected]