PMS Interface Messages Specification V1.5

Transcription

1 PMS Interface Messages Specification V.5

2 CONTENTS CONTENTS... 2 DOCUMENT PURPOSE TRANSACTION DESCRIPTION Communication Protocol WSDL Booking Query Messaging format and transport XSD SCHEMA AND XML INSTANCE FILES XSD s XML sample files BOOKING QUERY MESSAGE SPECIFICATION Request Message Field Table Response Message Field Table of 2

3 Document Purpose The PMS Interface allows to send booking requests from CRS (Idiso s Central Reservation System) to PMS (Property Management Systems) by means of a predefined message. This document specifies the format of this message. 2 Transaction Description 2. Communication Protocol The communication protocol between Tradyso CRS and partner PMS consists of a web service created from the wsdl specifications (paragraph 2.2) and using HTTP protocol. 2.2 WSDL The Partner webservice must be based on this simplest wsdl possible which is attached on the following link: user/password (xmltest/ahx3na4m) 2.3 Booking Query This transaction, with stay and customer details, performs a booking on the PMS returning a reservation identificator and the possible errors. 2.4 Messaging format and transport The interface s operation messages are based on the Open Travel Alliance (OTA) standard message specifications, specifically the messages for Hotel Reservation Notification. These messages are: - OTA_HotelResNotifRQ Sends a reservation to another system. All the elements and attributes are optional, unless otherwise stated as required. - OTA_HotelResNotifRS Returns acknowledgement that the reservation has been successfully received or includes errors if the request did not succeed. 3 of 2

4 3 XSD schema and XML instance files 3. XSD s Request Response XML sample files Request Samples TRADYSO_OTA_RQ.xml Response Samples TRADYSO_OTA_RS_SUCCESS.xml TRADYSO_OTA_RS_ERROR.xml 4 Booking Query Message Specification Fields are described on tables using under the following headers: Field: field common names. XPath: route to the XML element(s) and/or attribute(s) that represent a field Description/Values/Format: description and possible values and format of the field Multi: optionality and cardinality of the field: []: one optional instance. [ ]: one mandatory instance. [0-n]: optional, maximum of n instances. [-n]: mandatory, maximum of n instances. 4 of 2

5 Booking Query v. 4. Request Message Field Table Message Identifier ntifier Unique 4-char long alphanumeric string that identifies each request distinctively Version Version information. Decimal value Reservation CRS ID s/hotelreservation/resglobalinfo/hotelre _Value (ResID_Source="SIRIUS" or no show) Reservation unique identifier in CRS Up to ten-digit numeric code Reservation GDS ID Indicator of reservation multipnr, s/hotelreservation/resglobalinfo/hotelre _Value (ResID_Source="EXT") s/hotelreservation/resglobalinfo/hotelre _Type (without ResID_Source) Reservation unique identifier in GDS Up to 64-char alphanumeric code Reservation that it pertains at group of bookings. The value always is 25. This means that the booking is associated reservation. Multi PNR Identifier s/hotelreservation/resglobalinfo/hotelre _Value (ResID_Type= 25 ) Reservation that it pertains at group of bookings. It is a String with the acronym of the pms (two letters), concatenated with the first reservation of this group, (ten numbers). 5 of 2

6 Check-in Date Format: YYYY-MM-DD+hh:mm (e.g :00 for 5 th June 09) Check-out Date elreservation/resglobalinfo/timespan/@end Format: YYYY-MM-DD+hh:mm (e.g :00 for 6 th June 09) Action Code s/tp A_Extensions/Action/@Type Three possible values: A : Creation M : Modification B : Cancellation GDS Code /OTA_HotelResNotifRQ/POS/Source/BookingC hannel/companyname/@code (código OTA para Booking Channel Type= ) Two-char alphanumeric code. Channel identifier provided by TRADYSO SGA Code /OTA_HotelResNotifRQ/POS/Source/@AgentS ine Three-char alphanumeric code. Sub-channel identifier provided by TRADYSO Sell Office /OTA_HotelResNotifRQ/POS/Source/Requesto rid/@id (código OTA para Unique Id Type= 2 ) Up to eight-digit numeric code. Provided by TRADYSO Agency ofileinfo/uniqueid/@id_context (Unique Id Type= 5 ) ofileinfo/uniqueid/@id_context (Unique Id Type= 5 ) Agency Code Up to eight-char alphanumeric code Agency identifier. Either Solres code or a IATA code. Agency CodeType Two possible values: Solres or IATA 6 of 2

7 ofileinfo/profile/companyinfo/companyname (Unique Id Type= 5 ) ofileinfo/profile/agreements/commissioninfo (Unique Id Type= 5 ) ofileinfo/profile/agreements/commissioninfo/@ Amount (Unique Id Type= 5 ) ofileinfo/profile/companyinfo/paymentform/ba nkacct/@bankacctnumber s/tpa_extensions/discountmode ofileinfo/profile/companyinfo/addressinfo/addr essline (Unique Id Type= 5 ) ofileinfo/profile/companyinfo/addressinfo/city Name (Unique Id Type= 5 ) Agency Name Up to forty-char alphanumeric code Agency Commission Percentage Up to six-digit numeric Agency Commission Amount Up to thirteen-digit numeric Agency Bank Account Number Up to 32-char alphanumeric code Indicates if the agency works with rebate or not S N Agency Address Up to 255-char alphanumeric code 0-2 Agency City Name Up to 64-char alphanumeric code 7 of 2

8 ofileinfo/profile/companyinfo/addressinfo/post alcode (Unique Id Type= 5 ) Agency Postal Code Up to 6-char alphanumeric code ofileinfo/profile/companyinfo/addressinfo/cou ntryname (Unique Id Type= 5 ) Agency Country Code Up to 64-char alphanumeric code ofileinfo/profile/companyinfo/ Agency Up to 28-char alphanumeric code ofileinfo/profile/companyinfo/telephoneinfo/ph onenumber (PhoneTechType="") (Unique Id Type= 5 ) Agency Telephone Up to 32-char alphanumeric code ofileinfo/profile/companyinfo/telephoneinfo/ph onenumber (PhoneTechType="3") (Unique Id Type= 5 ) Agency Fax Up to 32-char alphanumeric code Company ofileinfo/uniqueid/@id (Unique Id Type= 4 ) Company Code Up to eight-digit numeric code. Provided by TRADYSO 8 of 2

9 ofileinfo/profile/companyinfo/companyname (Unique Id Type= 4 ) ofileinfo/profile/companyinfo/addressinfo/addr essline (Unique Id Type= 4 ) ofileinfo/profile/companyinfo/addressinfo/city Name (Unique Id Type= 4 ) ofileinfo/profile/companyinfo/addressinfo/post alcode (Unique Id Type= 4 ) Company Name Up to forty-char alphanumeric code Company Address Up to 255-char alphanumeric code 0-2 Company City Name Up to 64-char alphanumeric code Company Postal Code Up to 6-char alphanumeric code ofileinfo/profile/companyinfo/addressinfo/cou ntryname (Unique Id Type= 4 ) ofileinfo/profile/companyinfo/telephoneinfo/ph onenumber (PhoneTechType="") (Unique Id Type= 4 ) Company Country Code Up to 64-char alphanumeric code Company Telephone Up to 32-char alphanumeric code 9 of 2

10 ofileinfo/profile/companyinfo/telephoneinfo/ph onenumber (PhoneTechType="3") (Unique Id Type= 4 ) Company Fax Up to 32-char alphanumeric code Discount s/tp A_Extensions/Discount/@Percent s/tp A_Extensions/Discount/@Amount Percentage Up to six-digit numeric Amount Up to thirteen-digit numeric Guest ofileinfo/profile/customer/personname/givenn ame ofileinfo/profile/customer/personname/surna me ofileinfo/profile/customer/personname/namep refix ofileinfo/profile/customer/ GivenName Up to fifty-char alphanumeric code -n SurName Up to sixty-four -char alphanumeric code -n Treatment Up to four-char alphanumeric code -n Customer Up to 28-char alphanumeric code 0 of 2

11 Number ofileinfo/profile/customer/address/addressline ofileinfo/profile/customer/address/postalcode ofileinfo/profile/customer/address/cityname ofileinfo/profile/customer/address/stateprov Customer Telephone (MAS program only) Up to 32-char alphanumeric code Customer Address (MAS program only) Up to 255-char alphanumeric code Customer PostalCode (MAS program only) Up to 6-char alphanumeric code Customer City Up to 64-char alphanumeric code Customer State - Prov Up to 64-char alphanumeric code ofileinfo/profile/customer/address/countrynam e/@code Customer Country Two-digit numeric code defined in ISO366 Hotel Code elreservation/roomstays/roomstay/basicpro pertyinfo/@hotelcode Four-digit numeric code. Provided by TRADYSO Rooms elreservation/roomstays/roomstay/@indexn umber Index Number Up to two-digit numeric code -n of 2

12 elreservation/roomstays/roomstay/roomty Type Code Three-char alphanumeric code elreservation/roomstays/roomstay/roomty Number of units Up to two-digit numeric code elreservation/roomstays/roomstay/guestco Number of adults per room Up to three-digit numeric code elreservation/roomstays/roomstay/guestco (AgeQulifyingCode=8) Number of children per room Up to three-digit numeric code 0-n elreservation/roomstays/roomstay/servicer Index of the connected service Up to two-digit numeric code 0-m elreservation/roomstays/roomstay/resgues Index of the connected person Two-digit numeric code 0-m Fidelity elreservation/resglobalinfo/memberships/me elreservation/resglobalinfo/memberships/me Program Code Two-char alphanumeric code Card Number Up to ten-char alphanumeric code 2 of 2

13 s/tp A_Extensions/OficialLodging Indicates whether the hosts holds the loyalty card S N elreservation/services/service/@servicerph Index Number Two-digit numeric code elreservation/services/service/@serviceinven torycode Service Code Three-char alphanumeric code elreservation/services/service/@quantity Number of units Up to two-digit numeric code Services elreservation/services/service/servicedetails/ GuestCounts/GuestCount Number of pax Up to two-digit numeric code -n elreservation/services/service/servicedetails/ Comments/Comment/Text (Name="Description") Service Name Up to twenty-char alphanumeric code elreservation/services/service/servicedetails/ Comments/Comment/Text (Name="ServiceType") Service Type One-char alphanumeric code H(Room), P(Person), R(Regime), P(Package), O(Others) 3 of 2

14 elreservation/services/service/servicedetails/ Comments/Comment/Text (Name=" RoomType ") elreservation/services/service/servicedetails/ Comments/Comment/Text (Name=" MealPlanCodes") elreservation/services/service/servicedetails/ Comments/Comment/Text (Name="ServiceLodging") elreservation/services/service/servicedetails/ Comments/Comment/Text (Name="LodgingIndicator ") mountbeforetax mountbeforetax edate Room Type (room type of the connected room) Three-char alphanumeric code Service Regime Values belongs to rom OTA code table MPT (Meal Plan Type) Indicates whether the service is lodging S N Indicates whether the service type is Room S N Total amount to be pay for the service (not including applicable taxes) Up to thirteen-digit numeric Daily amount to be pay for the service (not including applicable taxes) Up to thirteen-digit numeric Date From Format: YYYY-MM-DD+hh:mm (e.g :00 for 5 th June 09) -m 4 of 2

15 Rate Code elreservation/roomstays/roomstay/rateplan Three-char alphanumeric code Price eforetax Total amount to be pay for the reservation (not including applicable taxes) Up to thirteen-digit numeric Total Price tertax Total amount to be pay for the reservation (including applicable taxes) Up to thirteen-digit numeric Currency Code Three-char alphanumeric code (TaxDescription=IVA) IVA Percentage Up to six-digit numeric Tax (TaxDescription=IVA) IVA Amount Up to thirteen-digit numeric (TaxDescription=Others) Others Amount Up to thirteen-digit numeric Arival Time Limit elreservation/resglobalinfo/guarantee/deadli Format: YYYY-MM-DD+hh:mm (e.g T8:00: :00 for 6 th June 09 8:00 hours) 5 of 2

16 Guarantee ranteetype s/tp A_Extensions/DemandGuaranteeDays Guarantee Type Four possible values: CC/DC/Voucher, Profile, Deposit, PrePay Number of days to demand the guarantee Up to four-digit numeric Deposit s/hotelreservation/resglobalinfo/deposit Payments/GuaranteePayment/AmountPer s/hotelreservation/resglobalinfo/deposit Payments/GuaranteePayment/AmountPer Deposit Percentage Up to six-digit numeric Deposit Amount Up to ten-digit numeric Payment Type s/tpa_extensions/paytype Up to two-digit numeric Credit Card Details s/hotelreservation/resglobalinfo/guarant ee/guaranteesaccepted/guaranteeaccept s/hotelreservation/resglobalinfo/guarant ee/guaranteesaccepted/guaranteeaccept Card Type Three-char alphanumeric code Card Number Up to nineteen-char alphanumeric code 6 of 2

17 s/hotelreservation/resglobalinfo/guarant ee/guaranteesaccepted/guaranteeaccept s/hotelreservation/resglobalinfo/guarant ee/guaranteesaccepted/guaranteeaccept Expire Date Format: MM-YY (e.g for June 09) CVV Up to eight-char alphanumeric code Voucher s/hotelreservation/resglobalinfo/guarant ee/guaranteesaccepted/guaranteeaccept ed/voucher Voucher s/hotelreservation/resglobalinfo/guarant ee/guaranteesaccepted/guaranteeaccept ed/voucher/ Identifier Up to Seventy-five-char alphanumeric code Availability Type s/tp Two-char alphanumeric code Daily Rate Indicator s/tp A_Extensions/DailyRateIndicator S N 7 of 2

18 Key Account s/tpa_extensions/keyaccount Indicates whether the prices are special for agencies S N Restricted Changes s/tpa_extensions/restrictedchanges Indicates whether the client has been informed that the price may change if the reserve changed S N Special Price s/tpa_extensions/specialprice Three possible values: G : Normal Price, N : Agency Price, S : Company Price Booking Holder s/tpa_extensions/bookingholder Booking holder depending on the payment type Three possible values: A : Agency, E : Company, C : Costumer Time Operation Format: hh:mm:ss (e.g. 3:59:2) Date Operation Format: YYYY-MM-DD (e.g for 5 th June 09) Package Rate s/tpa_extensions/package/@code s/tpa_extensions/package/@description Package Code Up to ten-char alphanumeric code Package Name Up to one-hundred-char alphanumeric code 8 of 2

19 Package Type Up to ten-char alphanumeric code Package Subtype Up to ten-char alphanumeric code s/tpa_extensions/package/packageservi Service Index Number Two-digit numeric code 0-n s/tpa_extensions/package/packageservi Service Code Three-char alphanumeric code 0-n s/tpa_extensions/package/packageservi Service Name Up to Forty-five-char alphanumeric code 0-n Booking Comment s/hotelreservation/resglobalinfo/comme s/hotelreservation/resglobalinfo/comme nts/comment/text Up to Seventy-five-char alphanumeric code 9 of 2

20 Booking Comment 2 s/hotelreservation/resglobalinfo/comme nts/comment/@paragraphnumber=2 s/hotelreservation/resglobalinfo/comme nts/comment/text Up to Seventy-five-char alphanumeric code 4.2 Response Message Field Table Field XPath Values and Format Multi If request has been processed successfully Success /OTA_HotelResNotifRS/Success Indicates that the request has been processed successfully Reservatio n CRS ID /OTA_HotelResNotifRS/ HotelReservations/ HotelReservation/ ResGlobalInfo/ HotelReservationIDs/HotelReservationID/@ ResID_Value (ResID_Source="SIRIUS") Reservation unique identifier Alphanumeric string Reservatio n PMS ID /OTA_HotelResNotifRS/ HotelReservations/ HotelReservation/ ResGlobalInfo/ HotelReservationIDs/HotelReservationID/@ ResID_Value Reservation unique identifier Alphanumeric string assigned by the PMS 20 of 2

21 Field XPath Values and Format Multi- CRS Name PMS Name /OTA_HotelResNotifRS/ HotelReservations/ HotelReservation/ ResGlobalInfo/ ResID_Source (ResID_Source="SIRIUS") /OTA_HotelResNotifRS/ HotelReservations/ HotelReservation/ ResGlobalInfo/ ResID_Source (ResID_Source="NOMBRE PMS") Up to Sixty-four-char alphanumeric code Up to Sixty-four-char alphanumeric code If request has not been processed successfully Error Type Values belongs to rom OTA code table EWT (Error Warning Type) Reservatio n CRS ID /OTA_HotelResNotifRS/Errors/Error/@Reco rdid Up to Sixty-four-char alphanumeric code Error Description /OTA_HotelResNotifRS/Errors/Error Alphanumeric string 2 of 2