Lookup

8min
introduction the lookup method allows users to retrieve details of a specific reservation by passing in a reservation reference number request endpoint {{endpoint lookup}} element group element name type required element description lookupreservationrequest lookupreservationrequest group yes lookupreservationrequest timestamp attribute yes the current timestamp (yyyymmddthh🇲🇲ss) lookupreservationrequest version attribute no optional, but must exist and be set to 2 in order to see the v2 output lookupreservationrequest control group yes control username element yes your username control password element yes your password lookupreservationrequest referenceno element yes bonotel reference # response primary reservation data element group element name type req element description lookupreservationresponse lookupreservationresponse group yes lookupreservationresponse status attribute yes status of the response valid values are y – reservation lookup processed successfully n – reservation lookup error reservationdetails reservationdetails group yes reservationdetails referenceno element yes internal reference no sent by bonotel at the time of booking reservationdetails hotelconfirmation element yes the hotel’s confirmation number reservationdetails touroperatorname element yes tour operator name reservationdetails touroperatorordernumber element yes reference number of the tour operator booking reservationdetails hotelcode group yes internal hotel code of the booking reservationdetails hotelname attribute yes name of the hotel reservationdetails reservationsource element yes booking channel which booking has made xml via xml interface call center via bonotel call center web via bonotel website reservationdetails reservationstatus element yes current status of the booking normal booking remains unchanged modified booking has been modified by bonotel cancelled booking has been cancelled reservationdetails cancellationinfo group yes cancellation information cancellationinfo cancellationno element yes cancellation no cancellationinfo cancellationfee element yes applied cancellation fee reservationdetails confirmationtype element yes status notifying whether this is "con" – confirm "req" on request reservationdetails reservationdate element yes the date of the booking reservationdetails checkin element yes check in date reservationdetails checkout element yes check out date reservationdetails noofrooms element yes no of rooms booked reservationdetails noofnights element yes no of nights booked reservationdetails totalnoofadults attribute yes total number of adults for the booking reservationdetails totalnoofchildren element yes total number of children for the booking reservationdetails total element yes the total value of this reservation (including taxes) total currency attribute yes the currency of the total reservation reservationdetails totaltax element yes the total tax associated with the reservation totaltax currency element yes the currency of the tax reservationdetails roomdata group yes the room’s details, this should be repeated up to the no of rooms room data element group element name type req element description roomdata roomno element yes the room no of the booking roomdata roomresno element yes the room id assigned by bonotel roomdata roomcode element yes the room code assigned by bonotel roomdata roomtype element yes the room type name of the booked room roomdata roomtypecode element yes the room type code of the booked room roomdata bedtype element yes the bed type name of the booked room roomdata bedtypecode element yes the bed type code of the booked room roomdata rateplan element yes the rate plan name of the booked room roomdata rateplancode element yes the rate plan code of the booked room roomdata noofadults element yes no of adults of the booked room roomdata noofchildren element no no of children of the booked room roomdata occupancy group yes occupancy details are wrapped with in this group occupancy guest group yes occupancy group of the booked room note that the no of adults and children should be represented by this occupancy guest title element yes title of the guest, applicable only for adults list of titles \["dr ", "prof ", "mstr ", "mr ", "miss ", "ms ", "mrs ", "mr/mrs "] guest firstname element yes first name of the guest guest lastname element yes last name of the guest reservationdetails comment group yes comment customer element no any comments from the customer code example request {{endpoint lookup}} \<?xml version="1 0" encoding="utf 8" ?> \<lookupreservationrequest timestamp="20150325t14 01 29 " version="2"> &#x9;\<control> &#x9; \<username>{{username}}\</username> &#x9; \<password>{{password}}\</password> &#x9;\</control> &#x9;\<referenceno>123456789x\</referenceno> \</lookupreservationrequest> response \<?xml version="1 0" encoding="utf 8" ?> \<lookupreservationresponse status="y" xmlns\ xsi="http //www w3 org/2001/xmlschema instance"> &#x9;\<reservationdetails> &#x9; \<referenceno>354324117x\</referenceno> &#x9; \<hotelconfirmation>6c3ee91a 54c0 4499 a8cb df54dbcb14c8\</hotelconfirmation> &#x9; \<touroperatorname>my travel company\</touroperatorname> &#x9; \<touroperatorordernumber>654321\</touroperatorordernumber> &#x9; \<hotelcode>1343\</hotelcode> &#x9; \<hotelname>aria resort and casino\</hotelname> &#x9; \<reservationsource>xml\</reservationsource> &#x9; \<reservationstatus>normal\</reservationstatus> &#x9; \<cancellationinfo> &#x9; \<cancellationno/> &#x9; \<cancellationfee/> &#x9; \<cancellationtimestamp/> &#x9; \</cancellationinfo> &#x9; \<confirmationtype>con\</confirmationtype> &#x9; \<reservationtimestamp>2017 01 19t03 53 43+00 00\</reservationtimestamp> &#x9; \<modificaitontimestamp/> &#x9; \<checkin>22 apr 2017\</checkin> &#x9; \<checkout>24 apr 2017\</checkout> &#x9; \<noofrooms>2\</noofrooms> &#x9; \<noofnights>2\</noofnights> &#x9; \<totalnoofadults>1\</totalnoofadults> &#x9; \<totalnoofchildren>1\</totalnoofchildren> &#x9; \<total currency="usd">1274 88\</total> &#x9; \<totaltax currency="usd">0 00\</totaltax> &#x9; \<roomdata> &#x9; \<roomno>1\</roomno> &#x9; \<roomresno>57467147\</roomresno> &#x9; \<roomcode>5943\</roomcode> &#x9; \<roomtype>deluxe king\</roomtype> &#x9; \<roomtypecode>74\</roomtypecode> &#x9; \<bedtype>double\</bedtype> &#x9; \<bedtypecode>10\</bedtypecode> &#x9; \<rateplan>room only\</rateplan> &#x9; \<rateplancode>1\</rateplancode> &#x9; \<noofadults>1\</noofadults> &#x9; \<noofchildren>1\</noofchildren> &#x9; \<childages> &#x9; \<childage>4\</childage> &#x9; \</childages> &#x9; \<occupancy> &#x9; \<guest> &#x9; \<title>mr\</title> &#x9; \<firstname>testfirst1n\</firstname> &#x9; \<lastname>testlast1n\</lastname> &#x9; \</guest> &#x9; \<guest> &#x9; \<title>mr \</title> &#x9; \<firstname>testfirst2n\</firstname> &#x9; \<lastname>testlast2n\</lastname> &#x9; \</guest> &#x9; \</occupancy> &#x9; \<roombookingpolicy> &#x9; \<policyfrom>2008 04 01\</policyfrom> &#x9; \<policyto>2018 12 29\</policyto> &#x9; \<amendmenttype>cancel\</amendmenttype> &#x9; \<policybasedon>percentage\</policybasedon> &#x9; \<policybasedonvalue>100\</policybasedonvalue> &#x9; \<cancellationtype>normal\</cancellationtype> &#x9; \<staydaterequirement>n\</staydaterequirement> &#x9; \<arrivalrange>less than\</arrivalrange> &#x9; \<arrivalrangevalue>4\</arrivalrangevalue> &#x9; \<policyfee>$1175 52\</policyfee> &#x9; \<noshowbasedon>percentage\</noshowbasedon> &#x9; \<noshowbasedonvalue>100\</noshowbasedonvalue> &#x9; \<noshowpolicyfee>$1175 52\</noshowpolicyfee> &#x9; \</roombookingpolicy> &#x9; \<hotelfees> &#x9; \<hotelfee> &#x9; \<feetype>resort\</feetype> &#x9; \<feemethod>exclusive\</feemethod> &#x9; \<requiredfee>yes\</requiredfee> &#x9; \<feeassign>per room\</feeassign> &#x9; \<feefrequency>per night\</feefrequency> &#x9; \<feebasedon>val\</feebasedon> &#x9; \<feebasedonvalue>39 0\</feebasedonvalue> &#x9; \<salestax>13 38\</salestax> &#x9; \<conditions/> &#x9; \<feetotal>309 53\</feetotal> &#x9; \</hotelfee> &#x9; \</hotelfees> &#x9; \</roomdata> &#x9; \<comment> &#x9; \<customer>ground floor, non smoking\</customer> &#x9; \</comment> &#x9;\</reservationdetails> \</lookupreservationresponse> response codes code description l1 unspecified error please contact customer support l2 user id not supplied or not valid l3 no xml input detected l4 erroneous or incomplete data in lookup reservation request l5 reservation number not provided l6 request ip address not found for the user l7 request ip address not matched for the user l8 reservation was not found l9 reservation does not belong to this user