Table I: Mandatory Parameters |
|||
The deep link syntax for a car search with only mandatory parameters is as follows: http://[localhost]/ui_net/Products/Car/Car.aspx?PickupPoint=[airport]&PickupArea=[destination name]&PickupStation=[IATA code of airport]&PickupDate=[ddMMMyy]&NumOfNights=[x]&DriverAge=[x]
Examples of the above syntax populated with values are as follows: Pickup airport http://www.companyTBsite.com/ui_net/Products/Car/Car.aspx?PickupPoint=airport&PickupArea=Rome&PickupStation=FCO&PickupDate=04APR14&NumOfNights=2&DriverAge=37 Pickup null http://www.companyTBsite.com/UI_NET/Products/car/car.aspx?PickupPoint=&PickupArea=Paris&PickupStation=CDG&PickUpDate=30Jun14&NumOfNights=8&DriverAge=30 Pickup free text http://www.companyTBsite/UI_NET/Products/car/car.aspx?PickupPoint=downtown&PickupArea=New York&PickupStation=ZI;JFK001&PickUpDate=30Jun14&NumOfNights=8&DriverAge=30 |
|||
Parameter Name |
Description |
Mandatory |
Example of Use |
localhost |
URL of your website |
Yes |
http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37 |
Indicates the location of the car pick-up station
Parameter value = airport or free text
If the parameter value is airport or null, the PickupStation should be the city IATA
If the parameter value is anything else, the PickupStation should be the station ID. The format of the station ID is: SupplierIATA;Station Code (the station code is defined in Setup - Car Stations)
|
Yes if PickupStation is not defined, and PickupPoint is not null (PickupPoint=), and not airport, and there are no active GDS or CRS that contain an active car service. |
Airport http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37
Null http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37
Anything else http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=downtown&PickupArea=Rome &PickupStation=ZI;FCO001&PickupDate=04APR14 &NumOfNights=2&DriverAge=37 |
|
PickupArea |
Destination of car pick-up station as written in the reservation search (and not the internal contract)
The destination value must match the value entered in Setup - Geography - Destinations.
Serves as the DropOffArea if the DropOffArea is null (DropOffArea=) |
Yes |
http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37 |
PickupStation |
Depends on what is entered in the PickUpPoint parameter: city IATA or station ID |
Yes if PickUpPoint is airport or null, or there are active GDS or CRS that contain an active car service. |
City IATA http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37
Station ID http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=downtown&PickupArea=Rome &PickupStation=ZI;FCO001&PickupDate=04APR14 &NumOfNights=2&DriverAge=37 |
PickupDate |
Date of car pick-up
Date format: ddMMMyy |
Yes |
http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37 |
NumOfNights |
Number of days of car reservation |
Yes |
http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37 |
DriverAge |
Age of driver renting the car |
Yes |
http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37 |
Table II: Conditionally Mandatory and Optional Parameters |
|||
Parameter Name |
Description |
Mandatory |
Example of Use |
Indicates the location of the car drop-off station
Parameter value = airport or free text
If the parameter value is airport or null, the DropOffStation should be the city IATA
If the parameter value is anything else, the DropOffStation should be the station ID. The format of the station ID is: SupplierIATA;CodeDesc |
No |
Airport http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37&DropOffPoint=airport &DropOffArea=Rome&DropOffStation=FCO
Null http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37&DropOffPoint= &DropOffArea=Rome&DropOffStation=FCO
Anything else http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=downtown&PickupArea=Rome &PickupStation=ZI;FCO001&PickupDate=04APR14 &NumOfNights=2&DriverAge=37&DropOffPoint=downtown &DropOffArea=Rome&DropOffStation=ZI;FCO002 |
|
DropOffArea |
Destination of car pick-up station as written in the reservation search (and not the internal contract)
The destination value must match the value entered in Setup - Geography - Destinations.
If the DropOffArea is null, the PickUpArea is used. |
No |
http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37&DropOffPoint=airport &DropOffArea=Rome&DropOffStation=FCO |
DropOffStation |
Depends on what is entered in the DropOffPoint parameter: city IATA or station ID |
No |
City IATA http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37&DropOffPoint=airport &DropOffArea=Rome&DropOffStation=FCO
Station ID http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=downtown&PickupArea=Rome &PickupStation=ZI;(CodeDesc)&PickupDate=04APR14 &NumOfNights=2&DriverAge=37&DropOffPoint=airport &DropOffArea=Rome&DropOffStation=ZI;FCO002 |
PickupTime |
Time of car pick-up Time format: hh:mm (24-hour clock) If you enter null (PickupTime=), the pickup time is taken from Setup - Database Definitions - Services |
No |
http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37&PickupTime=07:30 |
DropOffTime |
Time of car drop-off Time format: hh:mm (24-hour clock) If you enter null (DropOffTime=), the drop-off time is taken from the pick-up time. If the pick-up time is null, the drop-off time is taken from Setup - Database Definitions - Services |
No |
http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37&PickupTime=07:30 &DropOffTime=13:30 |
Class |
The car SIPP code The SIPP code must match the value entered in If a Category is also defined in the deeplink and the Category is not null, the Category will override the Class. |
No |
http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37&Class=CCMR |
CarType |
The car type character, in the car's SIPP code |
No |
http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37&CarType=C |
TransmisionType |
The transmission type character of the car's SIPP code |
No |
http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37&TransmisionType=M |
Doors |
The character for the number of doors in the car's SIPP code |
No |
http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37&Doors=C |
AirConditioning |
The character for the air conditioning in the car's SIPP code |
No |
http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37&AirConditioning=R |
Radius |
The radius in miles between the center of the destination and the car rental station. The radius needs to match the value defined in Setup - Car Stations |
No |
http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37&Radius=1 |
Category |
The car SIPP code The Category parameter must match the value entered in Setup - Product Definitions - Categories
If both a Category and Class are defined in the deeplink, and the Category is not null, the Category will override the Class |
No |
http://www.companyTBsite.com/ui_net/ Products/Car/Car.aspx? PickupPoint=airport&PickupArea=Rome &PickupStation=FCO&PickupDate=04APR14 &NumOfNights=2&DriverAge=37&Category=CCMR |