HotelCancelReq |
element |
|
|
|
Cancel request for a hotel booking. Given a provider code and a provider locator code. |
| 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. |
| HotelProperty |
element |
|
|
|
The hotel property |
| Availability |
string simple type |
Available , NotAvailable , AvailableForOtherRates , OnRequest , Unknown |
Optional |
|
|
| HotelChain |
string simple type |
|
Required |
|
|
| HotelCode |
string simple type |
|
Required |
|
|
| HotelLocation |
string simple type |
|
Optional |
|
The location code for this entity. IATA code. |
| HotelRateDetailRef |
string simple type |
|
Optional |
|
Reference for the Hotel Rate Detail. Used for Hotel Booking only. The value is arbitrary. |
| HotelTransportation |
positiveInteger simple type |
|
Optional |
|
OTA Transporation code. Transportation available to hotel. |
| Key |
string simple type |
|
Optional |
|
|
| MoreRates |
boolean simple type |
|
Optional |
|
When true, more rates are available for this hotel property.Applicable only for HotelDetails and HotelSuperShopper. Supported Providers: 1G, 1V. |
| MoreRatesToken |
string simple type |
|
Optional |
|
HS3 Token to identify the Rates for a property. Supported Providers 1G,1V. |
| Name |
string simple type |
|
Optional |
|
|
| NetTransCommissionInd |
string simple type |
A , B , C , P , X |
Optional |
|
This attribute indicates whether hotel property is tracking through net trans commission indicator. |
| NumOfRatePlans |
nonNegativeInteger simple type |
|
Optional |
|
The specific number of RatePlanTypes for each property responded on the message, integer 1 - 999. Supported provider: HotelSuperShopper message only. |
| ParticipationLevel |
string simple type |
|
Optional |
|
2=Best Available Rate 1G, 1V, 4=Lowest Possible Rate 1G, 1V, 1P |
| 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. |
| ReserveRequirement |
string simple type |
Deposit , Guarantee , Prepayment , Other |
Optional |
|
|
| VendorLocationKey |
string simple type |
|
Optional |
|
The VendorLocationKey for this HotelProperty. |
| PropertyAddress |
typeUnstructuredAddress complex type |
|
|
|
The VendorLocationKey for this HotelProperty. |
| Address |
anonymous simple type |
|
|
|
The VendorLocationKey for this HotelProperty. |
| 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 |
|
|
| CoordinateLocation |
element |
|
|
|
Specific lat/long location, usually associated with a Distance |
| latitude |
double simple type |
|
Required |
|
|
| longitude |
double simple type |
|
Required |
|
|
| 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 |
|
|
| HotelRating |
element |
|
|
|
Hotel rating information |
| RatingProvider |
string simple type |
|
Required |
|
Rating providers, ie AAA, NTM |
| Rating |
typeSimpleHotelRating simple type |
|
|
|
Hotel rating value |
| RatingRange |
element |
|
|
|
Hotel rating value |
| MaximumRating |
integer simple type |
|
Optional |
|
|
| MinimumRating |
integer simple type |
|
Optional |
|
|
| Amenities |
element |
|
|
|
Amenity information |
| Amenity |
element |
|
|
|
Amenity information |
| AmenityType |
string simple type |
|
Optional |
|
Amenity type code. “HA” (Hotel Property Amenity) or “RA” (Room Amenity). Defaults to “HA” if no value is sent. |
| Code |
positiveInteger simple type |
|
Required |
|
|
| MarketingMessage |
element |
|
|
|
Marketing information provided by the supplier |
| Text |
string simple type |
|
|
|
Marketing information provided by the supplier |
| HotelStay |
element |
|
|
|
Arrival and Departure dates |
| HotelRateDetailRef |
string simple type |
|
Optional |
|
Reference for the Hotel Rate Detail. Used for Hotel Booking only. The value is arbitrary. |
| Key |
string simple type |
|
Optional |
|
|
| CheckinDate |
typeDate simple type |
|
|
|
|
| CheckoutDate |
typeDate simple type |
|
|
|
|
| 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 |