Table I: Mandatory Parameters |
|||
The deep link syntax for a hotel search with only mandatory parameters is as follows: http://[localhost]/ui_net/Products/Hotels/Hotel.aspx?AreaName=[destination name]&CheckInDate=[ddMMMyy]&NumOfNights=[x]&NumOfAdult=[x]
The NumOfAdults parameter is only mandatory if there is no NumOfChildren parameter defined. An example of the above syntax populated with values is as follows: http://www.companyTBsite.com/ui_net/Products/Hotels/Hotel.aspx?AreaName=London&CheckInDate=15FEB16&NumOfNights=3&NumOfAdult=2 |
|||
Parameter Name |
Description |
Mandatory |
Example of Use |
localhost |
URL of your website |
Yes |
http://www.companyTBsite.com/ui_net/ Products/Hotels/Hotel.aspx? AreaName=London&CheckInDate=15FEB16&NumOfNights=3 &NumOfAdult=2 |
AreaName |
Destination of hotel. The destination value must match the value entered in Setup - Geography - Destinations. |
Yes |
http://www.companyTBsite.com/ui_net/ Products/Hotels/Hotel.aspx? AreaName=London&CheckInDate=15FEB16&NumOfNights=3 &NumOfAdult=2 |
CheckInDate |
Hotel check-in date Date formats:
|
Yes |
http://www.companyTBsite.com/ui_net/ Products/Hotels/Hotel.aspx? AreaName=London&CheckInDate=15FEB16&NumOfNights=3 &NumOfAdult=2
http://www.companyTBsite.com/ui_net/ Products/Hotels/Hotel.aspx? AreaName=London&CheckInDate=T+7D&NumOfNights=3 &NumOfAdult=2 |
NumOfNights |
Number of nights of hotel reservation. |
Yes |
http://www.companyTBsite.com/ui_net/ Products/Hotels/Hotel.aspx? AreaName=London&CheckInDate=15FEB16&NumOfNights=3 &NumOfAdult=2 |
The number of adults in the room. |
Only if NumOfChildren is not defined |
http://www.companyTBsite.com/ui_net/ Products/Hotels/Hotel.aspx? AreaName=London&CheckInDate=15FEB16&NumOfNights=3 &NumOfAdult=2 |
|
The number of children in the room. |
Only if NumOfAdult is not defined |
http://www.companyTBsite.com/ui_net/ Products/Hotels/Hotel.aspx? AreaName=London&CheckInDate=15FEB16&NumOfNights=3 &NumOfAdult=2&NumOfChildren=2&ChdAge1=4&ChdAge2=6 |
|
ChdAge[1..4] |
Age of child(ren) in the room.
A maximum of 4 children can be defined in the room. |
Only if NumOfChildren is defined |
Table II: Conditionally Mandatory and Optional Parameters |
|||
Parameter Name |
Description |
Mandatory |
Example of Use |
CountryName |
The country of the destination. Used in instances when you have more than one destination that share the same name, such as Sydney, Canada and Sydney, Australia |
No |
http://www.companyTBsite.com/ui_net/Products/Hotels/Hotel.aspx? CountryName=Netherlands&AreaName=AmsterdamCheckInDate=15FEB16 &NumOfNights=3&NumOfAdult=2&NumOfChildren=2&ChdAge1=4&ChdAge2=6 |
NumOfAdult[B..E] |
The number of adults in additional rooms of the reservation. B denotes the second room of the reservation, C denotes the third room of the reservation, D and E, the fourth and fifth respectively. The first room of the reservation does not require a letter. |
No |
http://www.companyTBsite.com/ui_net/ Products/Hotels/Hotel.aspx? AreaName=London&CheckInDate=15FEB16&NumOfNights=3 &NumOfAdult=2&NumOfAdultB=2 |
The number of children in additional rooms of the reservation. B denotes the second room of the reservation, C denotes the third room of the reservation, D and E, the fourth and fifth respectively. The first room of the reservation does not require a letter. |
No |
http://www.companyTBsite.com/ui_net/ Products/Hotels/Hotel.aspx? AreaName=London&CheckInDate=15FEB16&NumOfNights=3 &NumOfAdult=2&NumOfAdultB=2&NumOfChildrenB=2 &ChdAge1B=10&ChdAge2B=8 |
|
ChdAge[1..4][B..E] |
Age of child(ren) in additional rooms of the reservation (together with adults). A maximum of 4 children can be defined in each room. |
Only if NumOfChildren[B..E] is defined |
|
Currency |
Currency in which hotel price will be displayed.
|
No |
http://www.companyTBsite.com/ui_net/ Products/Hotels/Hotel.aspx? AreaName=London&CheckInDate=15FEB16&NumOfNights=3 &NumOfAdult=2&Currency=GBP |
HotelName |
The name of the hotel as entered in Products – Contracts – [Hotel Name] or in the content interface.
All hotels containing this name will be retrieved (e.g. Sheraton will retrieve Sheraton Park Tower). |
No |
http://www.companyTBsite.com/ui_net/ Products/Hotels/Hotel.aspx? AreaName=London&CheckInDate=15FEB16&NumOfNights=3 &NumOfAdult=2&HotelName=Cumberland |
Culture |
The language in which results will be displayed. The default language is English (American). The culture (language) value must match the value in the table of languages. |
No |
http://www.companyTBsite.com/ui_net/ Products/Hotels/Hotel.aspx? AreaName=London&CheckInDate=15FEB16&NumOfNights=3 &NumOfAdult=2&Culture=fr-FR |