VehicleCancelReq |
element |
|
|
|
PNR Cancel request for a vehicle booking. Given a provider code and a provider locator code.This will cancel one or more vehicle segments based on the criteria given. If more than onesegment matches, then all matching will be removed. |
| RetrieveProviderReservationDetails |
boolean simple type |
|
Optional |
false |
|
| AuthorizedBy |
string simple type |
|
Optional |
|
Used in showing who authorized the request. Use is optional. |
| LanguageCode |
token simple type |
|
Optional |
|
ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P. |
| OverrideLogging |
string simple type |
TRACE , DEBUG , INFO , WARN , ERROR , FATAL |
Optional |
|
Use to override the default logging level |
| ReturnAmenities |
boolean simple type |
|
Optional |
false |
When set to true, Amenities information will be returned in the response. |
| ReturnSponsoredFlight |
boolean simple type |
|
Optional |
|
When set to true, Sponsored flight information will be returned in the response. |
| SponsoredFltTrnxId |
string simple type |
|
Optional |
|
Identifier for Sponsored Flight transaction information. |
| TargetBranch |
string simple type |
|
Optional |
|
Used for Emulation - If authorised will execute the request as if the agent's parent branch is the TargetBranch specified. |
| TokenId |
string simple type |
|
Optional |
|
Authentication Token ID used when running in statefull operation. Obtained from the LoginRsp. Use is optional. |
| TraceId |
string simple type |
|
Optional |
|
Unique identifier for this atomic transaction traced by the user. Use is optional. |
| SupplierCode |
string simple type |
|
Optional |
|
|
| SupplierLocatorCode |
string simple type |
|
Optional |
|
|
| Version |
integer simple type |
|
Required |
|
|
| ProviderCode |
string simple type |
|
Required |
|
|
| ProviderLocatorCode |
string simple type |
|
Required |
|
|
| BillingPointOfSaleInfo |
element |
|
|
|
Point of Sale information for Billing |
| CIDBNumber |
integer simple type |
|
Optional |
|
A 10 Digit customer number generated by CIDB system. |
| OriginApplication |
string simple type |
|
Required |
|
Name of the Point of Sale application which initiated the Request.This information will be provided as part of the provisioning of the user. |
| AgentIDOverride |
element |
|
|
|
Vendor specific agent identifier overrides to be used to access vendor systems. |
| AgentID |
string simple type |
|
Required |
|
The Agent ID for the applicable supplier/vendor |
| ProviderCode |
string simple type |
|
Required |
|
Provider code to route the AgentId to proper provider. |
| SupplierCode |
string simple type |
|
Optional |
|
Supplier code to determine which vendor this AgentId belongs to. |
| TerminalSessionInfo |
string simple type |
|
|
|
Travelport use only. This element contains CDATA information representing existing GDS session data or ACH credentials information of the terminal user |
| OverridePCC |
element |
|
|
|
Used to emulate to another PCC or SID. Providers: 1G, 1V, 1P. |
| ProviderCode |
string simple type |
|
Required |
|
The code of the provider (e.g. 1G, 1S) |
| PseudoCityCode |
string simple type |
|
Required |
|
The PCC in the host system. |
| VehicleDateLocation |
element |
|
|
|
The PCC in the host system. |
| DropDistance |
double simple type |
|
Optional |
|
|
| DropLatitude |
double simple type |
|
Optional |
|
|
| DropLongitude |
double simple type |
|
Optional |
|
|
| DropUnit |
string simple type |
MI , KM |
Optional |
MI |
|
| Key |
string simple type |
|
Optional |
|
|
| PickUpDistance |
double simple type |
|
Optional |
|
|
| PickUpLatitude |
double simple type |
|
Optional |
|
|
| PickUpLongitude |
double simple type |
|
Optional |
|
|
| PickUpUnit |
string simple type |
MI , KM |
Optional |
MI |
|
| PickupDateTime |
string simple type |
|
Required |
|
|
| PickupLocation |
string simple type |
|
Optional |
|
PickUpLocation is optional if Reference point is specified |
| PickupLocationNumber |
string simple type |
|
Optional |
|
The value of this attribute should be the same as the value of VendorLocationID returned as part of VendorLocation@VendorLocationID in a VehicleLocationRsp. |
| PickupLocationType |
string simple type |
Terminal , ShuttleOnAirport , ShuttleOffAirport , RailwayStation , Hotel , CarDealer , CityCenterDowntown , EastOfCityCenter , SouthOfCityCenter , WestOfCityCenter , NorthOfCityCenter , PortOrFerry , NearResort , Airport , Unknown , Military , FixedBaseOperations |
Optional |
|
Required if use VendorLocationID. Ex: Terminal, ShuttleOnAirport, ShuttleOffAirport, RailwayStation, Hotel, CarDealer, CityCenterDowntown, EastOfCityCenter, SouthOfCityCenter, WestOfCityCenter, NorthOfCityCenter, PortOrFerry, NearResort, Airport, Unknown |
| ReturnDateTime |
string simple type |
|
Required |
|
|
| ReturnLocation |
string simple type |
|
Optional |
|
If not specified, the PickupLocation will be assumed |
| ReturnLocationNumber |
string simple type |
|
Optional |
|
|
| ReturnLocationType |
string simple type |
Terminal , ShuttleOnAirport , ShuttleOffAirport , RailwayStation , Hotel , CarDealer , CityCenterDowntown , EastOfCityCenter , SouthOfCityCenter , WestOfCityCenter , NorthOfCityCenter , PortOrFerry , NearResort , Airport , Unknown , Military , FixedBaseOperations |
Optional |
|
Defaults to Pickup Location. Same options as Pickup Location. |
| VendorLocation |
element |
|
|
|
Specific vendor rental locations. Applicable only for VehicleSearchAvailability. |
| AddressInfoRef |
string simple type |
|
Optional |
|
|
| Latitude |
double simple type |
|
Optional |
|
Latitude point of the city in PickUp or Drop |
| LocationCode |
string simple type |
|
Optional |
|
Airport or City Code |
| LocationType |
string simple type |
Terminal , ShuttleOnAirport , ShuttleOffAirport , RailwayStation , Hotel , CarDealer , CityCenterDowntown , EastOfCityCenter , SouthOfCityCenter , WestOfCityCenter , NorthOfCityCenter , PortOrFerry , NearResort , Airport , Unknown , Military , FixedBaseOperations |
Optional |
|
Rental counter location such as Terminal, CityCenterDowntown, |
| Longitude |
double simple type |
|
Optional |
|
Longitude point of the city in PickUp or Drop |
| Type |
string simple type |
Pickup , Return |
Optional |
|
Pickup or Return |
| Key |
string simple type |
|
Optional |
|
Key which maps vendor location with vehicles |
| MoreRatesToken |
string simple type |
|
Optional |
|
Enter the Token when provided by hotel property, more rates exist. HADS/HSS support only. |
| PreferredOption |
boolean simple type |
|
Optional |
|
Preferred Option marker for Location. |
| ProviderCode |
string simple type |
|
Required |
|
The code of the provider (e.g. 1G, 1S) |
| VendorCode |
string simple type |
|
Required |
|
The code of the vendor (e.g. HZ, etc.) |
| VendorLocationID |
string simple type |
|
Optional |
|
Location identifier |
| Distance |
element |
|
|
|
Container to encapsulate the a distance value with its unit of measure. |
| Direction |
string simple type |
|
Optional |
|
Directions: S, N, E, W, SE, NW, ... |
| Units |
string simple type |
MI , KM |
Optional |
MI |
|
| Value |
decimal simple type |
|
Required |
|
|
| BusinessHours |
string simple type |
|
|
|
Operational hours of the vendor. |
| Vehicle |
element |
|
|
|
Information related to single vehicle |
| AcrissVehicleCode |
string simple type |
|
Optional |
|
The Association of Car Rental Industry System Standards (ACRISS), develops standards to avoid misleading information when making a car rental booking online or via any electronic means. ACRISS provides an industry standard vehicle matrix to define car models ensuring a like to like comparison of vehicle. Each ACRISS code defining a car model consists of four characters as defined. 1st character denotes the vehicle category – based on size, cost, power and luxury factor.2nd character defines the vehicle type – chassis type (van, SUV, wagon, convertible).3rd character defines the transmission and drive – automatic / manual and 2WD / 4WD / AWD.
4th character defines the fuel type (petrol / diesel / hybrid…) and whether air conditioned.Examples are ICAR,ECAR,etc. |
| AirConditioning |
boolean simple type |
|
Required |
|
True or False. |
| AlternateVendor |
string simple type |
|
Optional |
|
A vendor renting the vehicle on behalf of another company |
| BagCount |
string simple type |
|
Optional |
|
Indicates count of bags that a vehicle could hold. |
| Category |
string simple type |
Car , Van , SUV , Convertible , Truck , StationWagon , Pickup , AllTerrain , Recreational , Sport , Special , ExtendedCabPickup , RegularCabPickup , SpecialOffer , Coupe , Monospace , Roadster , Crossover , Motorcycle , Limo , Motorhome , TwoWheelVehicle , CommercialVanOrTruck |
Required |
|
Category of vehicle. Each supplier decides how these categories map to a vehicle class. |
| CounterLocationCode |
string simple type |
|
Optional |
|
Four character Code to identify the Location of the Rental Counter, e.g. OMSO, PHON. |
| Description |
string simple type |
|
Optional |
|
Car type Description such as 'CHRYSLER SEBRING OR SIMILAR' |
| DoorCount |
string simple type |
TwoToThreeDoors , TwoToFourDoors , FourToFiveDoors |
Optional |
|
The number of doors on vehicle. Ex: TwoToThreeDoors, TwoToFourDoors, FourToFiveDoors |
| FuelType |
string simple type |
Petrol , Diesel , Hybrid , Electric , LPGCNG , Hydrogen , MultiFuel , Ethanol |
Optional |
|
The fuel type of vehicle |
| Key |
string simple type |
|
Optional |
|
|
| Location |
string simple type |
|
Optional |
|
Location of the Vehicle or Counter |
| MakeModel |
string simple type |
|
Optional |
|
Indicates the make/model of the vehicle. |
| PassengerCount |
string simple type |
|
Optional |
|
Indicates count of passenger that a vehicle could occupy. |
| ReturnAtPickup |
boolean simple type |
|
Optional |
|
Indicates whether vehicle can be returned at any location or pickup point only. If ReturnAtPickup = false then vehicle can be returned at any location else if ReturnAtPickup = true, vehicle should be returned in Pickup point only. Supported Providers : 1G/1V |
| TransmissionType |
string simple type |
Automatic , Automatic4WD , AutomaticAWD , Manual , Manual4WD , ManualAWD |
Required |
|
Automatic, Manual |
| VehicleClass |
string simple type |
Mini , Economy , Compact , Intermediate , Standard , Fullsize , Luxury , Premium , Special , MiniElite , EconomyElite , CompactElite , IntermediateElite , StandardElite , FullsizeElite , PremiumElite , LuxuryElite , Oversize , Subcompact , Minivan , TwelvePassengerVan , MovingVan , FifteenPassengerVan , CargoVan , TwelveFootTruck , TwentyFootTruck , TwentyfourFootTruck , TwentysixFootTruck , Moped , Stretch , Regular , Unique , Exotic , SmallOrMediumTruck , LargeTruck , SmallSUV , MediumSUV , LargeSUV , ExoticSUV , FourWheelDrive |
Required |
|
Class of vehicle |
| VendorCode |
string simple type |
|
Required |
|
|
| VendorLocationKey |
string simple type |
|
Optional |
|
Identifies the specific vendor location |
| VendorName |
string simple type |
|
Optional |
|
The vendor's name |
| InPolicy |
boolean simple type |
|
Optional |
|
This attribute will be used to indicate if a fare or rate has been determined to be ‘in policy’ based on the associated policy settings. |
| PolicyCode |
int simple type |
|
Optional |
|
This attribute is used to provide a code that can be used to determine why an item was determined to be ‘out of policy’. |
| PreferredOption |
boolean simple type |
|
Optional |
|
This attribute is used to indicate if the vendors responsible for the fare or rate being returned have been determined to be ‘preferred’ based on the associated policy settings. |
| PolicyCodesList |
typePolicyCodesList complex type |
|
|
|
A list of codes that indicate why an item was determined to be ‘out of policy’. |
| PolicyCode |
anonymous simple type |
|
|
|
A code that indicates why an item was determined to be ‘out of policy’. |
| MinPolicyCode |
anonymous simple type |
|
|
|
A code that indicates why the minimum fare or rate was determined to be ‘out of policy’. |
| MaxPolicyCode |
anonymous simple type |
|
|
|
A code that indicates why the maximum fare or rate was determined to be ‘out of policy’. |
| VehicleRate |
element |
|
|
|
Rate summary |
| AdvancedBooking |
string simple type |
|
Optional |
|
Indicates the number of Hours or Days a rate must be booked in advance. Values are for Days = number followed by “D” e.g., "002D" and Hours = number followed by “H” e.g., 002H” 1P/1G/1V only. |
| CardNumber |
string simple type |
|
Optional |
|
Vehicle Loyalty Card Number. Supported Provider 1P. |
| CardNumberApplied |
string simple type |
true , false , unknown |
Optional |
|
Loyalty Card Number has been applied to the Rate. Values: "true", "false", "unknown". Supported Providers 1P. |
| CorporateRate |
boolean simple type |
|
Optional |
|
If "true" a Corporate Discount has been applied to the rate. Applicable to 1P |
| DiscountNumber |
string simple type |
|
Optional |
|
Corporate Discount number used to request a specified discount. Supported Providers Requests: 1P,1G,1V, Responses only 1P. |
| DiscountNumberApplied |
string simple type |
true , false , unknown |
Optional |
|
Discount Number has been applied to the Rate. Valid values: "true", "false", "unknown". Supported Providers 1P. |
| DropOffChargesIncluded |
boolean simple type |
|
Optional |
|
If true: Drop off charges are included. If false, not included. If not specified, additional drop off charges MAY apply (but this has not been confirmed by vendor) |
| FlightRestriction |
boolean simple type |
|
Optional |
|
Flight restriction indicator is true if flight information is required at booking. 1P/1G/1V only. |
| MileageAllowance |
long simple type |
|
Optional |
|
Only set if UnlimitedMileage is false. Number of miles allowed for rate |
| NumberOfPeriods |
long simple type |
|
Optional |
|
Define how many periods (e.g. number of days or weeks) |
| PromotionalCode |
string simple type |
|
Optional |
|
Specific coupon or promotion code. Providers 1P,1V,1G. |
| PromotionalCodeApplied |
string simple type |
true , false , unknown |
Optional |
|
Promotional/Coupon Number has been applied to the Rate. Valid values: "true", "false", "unknown". Supported Providers 1P. |
| RateAvailability |
string simple type |
Available , Call , Closed |
Optional |
|
Rate is available to sell, Need to Call or Closed |
| RateCategory |
string simple type |
Association , Business , Corporate , Government , Industry , Package , Inclusive , Promotional , Credential , Standard , Consortium , Convention , Negotiated , Prepay |
Optional |
|
The category of this rate (Best, etc) |
| RateCode |
string simple type |
|
Optional |
|
Rate Code of the vehicle. Supported Providers 1P,1G,1V. |
| RateCodePeriod |
string simple type |
|
Optional |
|
RateCodePeriod |
| RateGuaranteeType |
string simple type |
Rate Guaranteed , Rate Quoted , Agent Entered |
Optional |
|
To identify whether rate is already guaranteed or rate quoted or agent entered |
| RateGuaranteed |
boolean simple type |
|
Optional |
false |
Guarantee indicator for vehicle rate. |
| RatePeriod |
string simple type |
Hourly , Daily , Weekly , Monthly , WeekendDay , Other , Package , Bundle , Total |
Optional |
|
The period for the rate (daily, weekly, etc) |
| RateQualifierInd |
nonNegativeInteger simple type |
|
Optional |
|
Indicates whether rates comply with CD, ID, or Drop Off requested. 1 is fully qualified, 2 is partly qualified, and 3 is other rates. 1G, 1V only. |
| RateSource |
string simple type |
|
Optional |
|
The rate source indicator for GWS |
| RentalRestriction |
boolean simple type |
|
Optional |
|
RentalRestriction attribute value is true if vehicle rate has rental restrictions. Rental restrictions can be obtained from the Vehicle Rules. 1P only. |
| RequestedRateCodeApplied |
string simple type |
true , false , unknown |
Optional |
|
The requested Rate Code applied to the Rate. Valid values: "true", "false", "unknown". Supported Providers 1P. |
| RequiredCharges |
string simple type |
|
Optional |
|
|
| RequiredPayment |
string simple type |
Guarantee , Deposit , PrePayment |
Optional |
|
Returns Payment information required by vendor at the time og booking. |
| TourCode |
string simple type |
|
Optional |
|
Tour Number for the Vehicle Booking |
| TourCodeApplied |
string simple type |
true , false , unknown |
Optional |
|
Tour Code Number has been applied to the Rate. Valid values: "true", "false", "unknown". Supported Providers 1P. |
| Units |
string simple type |
MI , KM |
Optional |
|
Describes distance units for MileageAllowance or ExtraMileageCharge |
| UnlimitedMileage |
boolean simple type |
|
Optional |
|
True if unlimited miles for rate |
| VendorCode |
string simple type |
|
Optional |
|
|
| SupplierRate |
element |
|
|
|
|
| BaseRate |
string simple type |
|
Optional |
|
Rate for the entire rent without the required charges |
| DropOffCharge |
string simple type |
|
Optional |
|
The additional fee for dropping off a vehicle at a different location. |
| EstimatedTotalAmount |
string simple type |
|
Optional |
|
The estimated total amount |
| ExtraMileageCharge |
string simple type |
|
Optional |
|
Cost per mile over allowance for rate |
| FuelSurcharge |
string simple type |
|
Optional |
|
The additional amount charged for fuel |
| PayLater |
string simple type |
|
Optional |
|
Pay later is added for Future Functionality |
| PayNow |
string simple type |
|
Optional |
|
Pay Now is added for Future Functionality |
| RateForPeriod |
string simple type |
|
Optional |
|
The rate for the period |
| SeniorDriverCharge |
string simple type |
|
Optional |
|
The additional amount charged for senior drivers |
| YoungDriverCharge |
string simple type |
|
Optional |
|
The additional amount charged for young drivers |
| ApproximateTotal |
string simple type |
|
Optional |
|
The total sum of all mandatory, optional and conditional charges |
| DiscountAmount |
string simple type |
|
Optional |
|
Discount Amount 1P only |
| MandatoryChargeTotal |
string simple type |
|
Optional |
|
Total Mandatory Charges, which may include taxes, surcharges, and fees. 1P only. |
| RateVariance |
typeRateVariance complex type |
|
|
|
Used on VehicleCreateReservationReq ONLY. @MandatoryRateMatch ='true' is required for this element to be applied. 1P. |
| Apply |
string simple type |
|
Required |
|
Variance to response amount; 'high', 'low' or 'both. 1P. |
| Type |
string simple type |
|
Required |
|
Supported values are 'percentage.1P. Future release 'amopunt'. |
| Value |
decimal simple type |
|
Required |
|
Represents value of user permitted variance for sell success. eg. "5.00" = 5% variance on the supplier estimated total amount response will be successful. 1P. |
| ApproximateRate |
typeVehicleRates complex type |
|
|
|
Monetary amounts expressed in another currency |
| BaseRate |
string simple type |
|
Optional |
|
Rate for the entire rent without the required charges |
| DropOffCharge |
string simple type |
|
Optional |
|
The additional fee for dropping off a vehicle at a different location. |
| EstimatedTotalAmount |
string simple type |
|
Optional |
|
The estimated total amount |
| ExtraMileageCharge |
string simple type |
|
Optional |
|
Cost per mile over allowance for rate |
| FuelSurcharge |
string simple type |
|
Optional |
|
The additional amount charged for fuel |
| PayLater |
string simple type |
|
Optional |
|
Pay later is added for Future Functionality |
| PayNow |
string simple type |
|
Optional |
|
Pay Now is added for Future Functionality |
| RateForPeriod |
string simple type |
|
Optional |
|
The rate for the period |
| SeniorDriverCharge |
string simple type |
|
Optional |
|
The additional amount charged for senior drivers |
| YoungDriverCharge |
string simple type |
|
Optional |
|
The additional amount charged for young drivers |
| VehicleCharge |
typeVehicleCharge complex type |
|
|
|
Charges associated with the vehicle rental. |
| Category |
string simple type |
|
Required |
|
The type of charge information for the vehicle rental. |
| Description |
string simple type |
|
Optional |
|
Special Equipment Charge description text of the rental charge. 1P only. |
| IncludedInRate |
string simple type |
NotIncluded , IncludedInBase , IncludedInTotal |
Optional |
|
Specifies whether the charge is included in the rate and if it is, if it is in the base or total rate. |
| Name |
string simple type |
|
Optional |
|
Identifies the type of charge information for the category. For 1P , when category is “Special”, Name attribute will have Special Equipment code enumeration, which can be used in booking vehicle on 1P host. |
| Type |
string simple type |
NoCharge , Percent , Rental , PerContract , PerHour , PerDay , PerWeek , PerMonth |
Optional |
|
Used to specify how a charge is applied, such as per rental, per day, etc. |
| Amount |
typeMoney simple type |
|
|
|
The amount of the charge. |
| Percentage |
typePercentageWithDecimal simple type |
|
|
|
The amount of the charge in percentage. |
| VehicleRateDescription |
typeVehicleRateDescription complex type |
|
|
|
The amount of the charge in percentage. |
| Name |
string simple type |
|
Optional |
|
Optional context name of the text block being returned i.e. Room details |
| Text |
anonymous simple type |
|
|
|
Optional context name of the text block being returned i.e. Room details |
| RateHostIndicator |
typeRateHostIndicator complex type |
|
|
|
Optional context name of the text block being returned i.e. Room details |
| InventoryToken |
string simple type |
|
Optional |
|
Vendor info about rate to adjust pricing as needed |
| RateToken |
string simple type |
|
Optional |
|
Assocates shop response to sell request |
| HourlyLateCharge |
typeRateInfo complex type |
|
|
|
Assocates shop response to sell request |
| ExtraMileageCharge |
string simple type |
|
Optional |
|
Cost per mile or kilometer over allowance for rate |
| MileageAllowance |
long simple type |
|
Optional |
|
Number of miles or kilometers allowed for rate if not unlimited |
| NumberOfPeriods |
long simple type |
|
Optional |
|
Define how many periods (e.g. number of days or weeks) |
| RateForPeriod |
string simple type |
|
Optional |
|
The rate for the period |
| Units |
string simple type |
MI , KM |
Optional |
|
Describes distance units for MileageAllowance or ExtraMileageCharge |
| UnlimitedMileage |
boolean simple type |
|
Optional |
|
True if unlimited miles allowed. Not set if unknown |
| DailyLateCharge |
typeRateInfo complex type |
|
|
|
True if unlimited miles allowed. Not set if unknown |
| ExtraMileageCharge |
string simple type |
|
Optional |
|
Cost per mile or kilometer over allowance for rate |
| MileageAllowance |
long simple type |
|
Optional |
|
Number of miles or kilometers allowed for rate if not unlimited |
| NumberOfPeriods |
long simple type |
|
Optional |
|
Define how many periods (e.g. number of days or weeks) |
| RateForPeriod |
string simple type |
|
Optional |
|
The rate for the period |
| Units |
string simple type |
MI , KM |
Optional |
|
Describes distance units for MileageAllowance or ExtraMileageCharge |
| UnlimitedMileage |
boolean simple type |
|
Optional |
|
True if unlimited miles allowed. Not set if unknown |
| PricedEquip |
element |
|
|
|
Special Equipment detail and charge for rental |
| Equipment |
element |
|
|
|
Requested Special Equipment Information |
| Description |
string simple type |
|
Required |
|
Special Equipment description |
| Quantity |
decimal simple type |
|
Optional |
|
Special Equipment quantity |
| Status |
string simple type |
|
Optional |
|
Status of the request returned by the supplier. Valid Values KK (Confirmed), UC (Unable to Confirm and NN (On request) |
| Type |
string simple type |
|
Required |
|
The Type of Special Equipment requested |
| Charge |
element |
|
|
|
Charge information associated to Special Equipment |
| Amount |
string simple type |
|
Required |
|
Special Equipment Charge Amount. |
| IncludedInEstTotalInd |
boolean simple type |
|
Required |
|
Special Equipment Amount is included in the Estimated Total Amount |
| RatePeriod |
string simple type |
|
Required |
|
Rate Period associated to the Special Equipment Charge Amount.e.g. Daily, Weekly, Rental |
| RateInclusions |
element |
|
|
|
Provides the list of additional charges included in Rate. e.g Tax, Airport Surcharge, CDW etc |
| IncludedItem |
element |
|
|
|
Provides details of included item. |
| Code |
string simple type |
|
Required |
|
Code for included item. |
| Description |
string simple type |
|
Required |
|
Description of included item. |
| WeeklyLateCharge |
typeRateInfo complex type |
|
|
|
Extra Week Charges information. Supported providers:1P only |
| ExtraMileageCharge |
string simple type |
|
Optional |
|
Cost per mile or kilometer over allowance for rate |
| MileageAllowance |
long simple type |
|
Optional |
|
Number of miles or kilometers allowed for rate if not unlimited |
| NumberOfPeriods |
long simple type |
|
Optional |
|
Define how many periods (e.g. number of days or weeks) |
| RateForPeriod |
string simple type |
|
Optional |
|
The rate for the period |
| Units |
string simple type |
MI , KM |
Optional |
|
Describes distance units for MileageAllowance or ExtraMileageCharge |
| UnlimitedMileage |
boolean simple type |
|
Optional |
|
True if unlimited miles allowed. Not set if unknown |
| PrintText |
string simple type |
|
|
|
Informational text provided by the supplier that may be related to the reservation. This is applicable in response messages only, 1p only. |
| MediaItem |
element |
|
|
|
Photos and other media urls for the property referenced above. |
| caption |
string simple type |
|
Optional |
|
|
| height |
integer simple type |
|
Optional |
|
|
| icon |
anyURI simple type |
|
Optional |
|
|
| sizeCode |
string simple type |
|
Optional |
|
|
| type |
string simple type |
|
Optional |
|
|
| url |
anyURI simple type |
|
Optional |
|
|
| width |
integer simple type |
|
Optional |
|
|
| FileFinishingInfo |
element |
|
|
|
Misc Data required for File Finishing. This
data is transient and not saved in database. |
| ShopInformation |
element |
|
|
|
Shopping Information required for File
Finishing |
| CabinSelected |
string simple type |
|
Optional |
|
|
| CabinShopped |
string simple type |
|
Optional |
|
|
| LowestFareOffered |
string simple type |
|
Optional |
|
|
| SearchRequest |
element |
|
|
|
Search parameters that were used in LFS
request |
| ClassOfService |
string simple type |
|
Optional |
|
|
| DepartureTime |
string simple type |
|
Optional |
|
Date and Time at which this entity
departs. This does not include Time Zone information since it
can be derived from origin location |
| Destination |
string simple type |
|
Optional |
|
|
| Origin |
string simple type |
|
Optional |
|
|
| FlightsOffered |
element |
|
|
|
Flights with lowest logical airfare
returned as response to LFS request |
| Carrier |
string simple type |
|
Optional |
|
|
| ClassOfService |
string simple type |
|
Optional |
|
|
| Connection |
boolean simple type |
|
Optional |
false |
|
| DepartureTime |
string simple type |
|
Optional |
|
Date and Time at which this entity
departs. This does not include Time Zone information since it
can be derived from origin location |
| Destination |
string simple type |
|
Optional |
|
|
| FlightNumber |
string simple type |
|
Optional |
|
|
| Origin |
string simple type |
|
Optional |
|
|
| StopOver |
boolean simple type |
|
Optional |
false |
|
| TravelOrder |
long simple type |
|
Optional |
|
|
| PolicyInformation |
element |
|
|
|
Policy Information required for File
Finishing |
| Name |
anySimpleType simple type |
|
Optional |
|
Policy Name |
| OutOfPolicy |
boolean simple type |
|
Optional |
|
In Policy / Out of Policy Indicator |
| SegmentRef |
string simple type |
|
Optional |
|
|
| Type |
string simple type |
Air , Vehicle , Hotel , Rail , Ticketing |
Required |
|
Policy Type - Air, Hotel, Car, Rail,
Ticketing |
| ReasonCode |
element |
|
|
|
Reason Code |
| OutOfPolicy |
string simple type |
|
|
|
Reason Code - Out of Policy |
| PurposeOfTrip |
string simple type |
|
|
|
Reason Code -Purpose of Trip |
| Remark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
| Key |
string simple type |
|
Optional |
|
|
| AccountInformation |
element |
|
|
|
Account Information required for File
Finishing |
| AccountName |
string simple type |
|
Optional |
|
|
| Address |
typeStructuredAddress complex type |
|
|
|
|
| Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| AddressName |
anonymous simple type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| Street |
anonymous simple type |
|
|
|
The Address street and number, e.g. 105 Main St. |
| City |
anonymous simple type |
|
|
|
The city name for the requested address, e.g. Atlanta. |
| State |
element |
|
|
|
Container to house the state code for an address |
| PostalCode |
anonymous simple type |
|
|
|
The 5-15 alphanumeric postal Code for the requested address, e.g. 90210. |
| Country |
anonymous simple type |
|
|
|
The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches. |
| ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
| Key |
string simple type |
|
Required |
|
|
| PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
| AreaCode |
string simple type |
|
Optional |
|
|
| CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
| Extension |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Optional |
|
|
| Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
| Number |
string simple type |
|
Required |
|
The local phone number |
| Text |
string simple type |
|
Optional |
|
|
| Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
| Key |
string simple type |
|
Required |
|
|
| AgencyInformation |
element |
|
|
|
Agency Information required for File
Finishing |
| Address |
typeStructuredAddress complex type |
|
|
|
Agency Information required for File
Finishing |
| Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| AddressName |
anonymous simple type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| Street |
anonymous simple type |
|
|
|
The Address street and number, e.g. 105 Main St. |
| City |
anonymous simple type |
|
|
|
The city name for the requested address, e.g. Atlanta. |
| State |
element |
|
|
|
Container to house the state code for an address |
| PostalCode |
anonymous simple type |
|
|
|
The 5-15 alphanumeric postal Code for the requested address, e.g. 90210. |
| Country |
anonymous simple type |
|
|
|
The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches. |
| ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
| Key |
string simple type |
|
Required |
|
|
| Email |
element |
|
|
|
Container for an email address with a type specifier (max 128 chars) |
| Comment |
string simple type |
|
Optional |
|
|
| EmailID |
string simple type |
|
Required |
|
|
| Key |
string simple type |
|
Optional |
|
|
| Type |
string simple type |
|
Optional |
|
|
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
| Key |
string simple type |
|
Required |
|
|
| PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
| AreaCode |
string simple type |
|
Optional |
|
|
| CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
| Extension |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Optional |
|
|
| Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
| Number |
string simple type |
|
Required |
|
The local phone number |
| Text |
string simple type |
|
Optional |
|
|
| Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
| Key |
string simple type |
|
Required |
|
|
| TravelerInformation |
element |
|
|
|
Traveler Information required for File
Finishing |
| BookingTravelerRef |
string simple type |
|
Required |
|
A reference to a passenger. |
| HomeAirport |
string simple type |
|
Optional |
|
|
| VisaExpirationDate |
date simple type |
|
Optional |
|
|
| EmergencyContact |
element |
|
|
|
|
| Name |
anySimpleType simple type |
|
Optional |
|
Name of Emergency Contact Person |
| Relationship |
anySimpleType simple type |
|
Optional |
|
Relationship between Traveler and
Emergency Contact Person |
| PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
| AreaCode |
string simple type |
|
Optional |
|
|
| CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
| Extension |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Optional |
|
|
| Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
| Number |
string simple type |
|
Required |
|
The local phone number |
| Text |
string simple type |
|
Optional |
|
|
| Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
| ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
| KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
| ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
| Key |
string simple type |
|
Required |
|
|
| CustomProfileInformation |
element |
|
|
|
Custom Profile Field Data required for File
Finishing |