Table I: Mandatory Parameters |
|||
The deep link syntax for an event-led package search with only mandatory parameters is as follows: http://[localhost]/ui_net/Products/DynamicPackage/FlightAndHotels.aspx?LeavingFrom=[departure name]
An example of the above syntax populated with values is as follows: http://www.companyTBsite.com/ui_net/Products/DynamicPackage/FlightAndHotels.aspx?LeavingFrom=LHR&AreaName=Amsterdam&Departing=15MAR16&Returning=23MAR16&NumOfAdult=2&NumOfChildren=1 |
|||
Parameter Name |
Description |
Mandatory |
Example of Use |
localhost |
URL of your website |
Yes |
http://www.companyTBsite.com/ui_net/Products/DynamicPackage/FlightAndHotels.aspx?LeavingFrom=LHR&AreaName=Amsterdam&Departing=15MAR16 |
LeavingFrom |
IATA code of departure airport |
Yes Only if dpName or packageid are not defined. |
http://www.companyTBsite.com/ui_net/Products/DynamicPackage/FlightAndHotels.aspx?LeavingFrom=LHR&AreaName=Amsterdam&Departing=15MAR16 |
AreaName |
Dynamic package destination The destination value must match the value entered in Setup - Geography - Destinations. |
Yes Only if dpName or packageid are not defined. |
http://www.companyTBsite.com/ui_net/Products/DynamicPackage/FlightAndHotels.aspx?LeavingFrom=LHR&AreaName=Amsterdam&Departing=15MAR16 |
Departing |
Departure date Date format: ddMMMyy |
Yes |
http://www.companyTBsite.com/ui_net/Products/DynamicPackage/FlightAndHotels.aspx?LeavingFrom=LHR&AreaName=Amsterdam&Departing=15MAR16 |
Returning |
Return date Date format: ddMMMyy |
Yes |
http://www.companyTBsite.com/ui_net/Products/DynamicPackage/FlightAndHotels.aspx?LeavingFrom=LHR&AreaName=Amsterdam&Departing=15MAR16 |
dpName |
The name of the event-led package. |
Yes. Only if LeavingFrom and AreaName and packageid are not defined. |
http://www.companyTBsite.com/ui_net/Products/DynamicPackage/FlightAndHotels.aspx?LeavingFrom=LHR&CountryName=AMS&AreaName=Amsterdam&Departing=15MAR16 |
packageid |
The event-led package ID number |
Yes. Only if LeavingFrom and AreaName and dpName are not defined. |
http://www.companyTBsite.com/ui_net/Products/DynamicPackage/FlightAndHotels.aspx?LeavingFrom=LHR&CountryName=AMS&AreaName=Amsterdam&Departing=15MAR16 |
The number of adults in the first room. |
Only if NumOfChildren is not defined |
http://www.companyTBsite.com/ui_net/Products/DynamicPackage/FlightAndHotels.aspx?LeavingFrom=LHR&CountryName=AMS&AreaName=Amsterdam&Departing=15MAR16 |
|
The number of children in the first room. |
Only if NumOfAdult is not defined |
http://www.companyTBsite.com/ui_net/Products/DynamicPackage/FlightAndHotels.aspx?LeavingFrom=LHR&CountryName=AMS&AreaName=Amsterdam&Departing=15MAR16 |
|
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 |
http://www.companyTBsite.com/ui_net/Products/DynamicPackage/FlightAndHotels.aspx?LeavingFrom=LHR&CountryName=AMS&AreaName=Amsterdam&Departing=15MAR16 |
Table II: Conditionally Mandatory and Optional Parameters |
|||
Parameter Name |
Description |
Mandatory |
Example of Use |
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/DynamicPackage/FlightAndHotels.aspx? |
NumOfChildren[B..E] |
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/DynamicPackage/FlightAndHotels.aspx? |
ChdAge[X][B..E] |
The ages 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. The letter follows the number for the child. |
No |
http://www.companyTBsite.com/ui_net/Products/DynamicPackage/FlightAndHotels.aspx? |
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/DynamicPackage/FlightAndHotels.aspx?LeavingFrom=LHR&CountryName=Netherlands&AreaName=Amsterdam&Departing=15MAR16 |
HotelName |
The name of the hotel (in the first destination of the dynamic package) 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/DynamicPackage/FlightAndHotels.aspx? |
IncludeCharterFlight |
Indicates if to include charter flights in the search results for the dynamic package. 0 = No 1 = Yes (default) |
No |
http://www.companyTBsite.com/ui_net/Products/DynamicPackage/FlightAndHotels.aspx? |
IncludeFullyBooked |
Indicates if to include fully booked flights in the search results for the dynamic package. 0 = No 1 = Yes |
No |
http://www.companyTBsite.com/ui_net/Products/DynamicPackage/FlightAndHotels.aspx? |
DirectFlightsOnly |
Indicates if to include only direct flights in the search results for the dynamic package. 0 = No 1 = Yes |
No |
http://www.companyTBsite.com/ui_net/Products/DynamicPackage/FlightAndHotels.aspx? |
Currency |
Currency in which dynamic package price will be displayed.
|
No |
http://www.companyTBsite.com/ui_net/Products/DynamicPackage/FlightAndHotels.aspx? |
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/DynamicPackage/FlightAndHotels.aspx? |