HotelDetailsReq |
element |
|
|
|
Request to retrieve the details of a hotel property |
| 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. |
| PolicyReference |
string simple type |
|
Optional |
|
This attribute will be used to pass in a value on the request which would be used to link to a ‘Policy Group’ in a policy engine external to UAPI. |
| ReturnGuestReviews |
boolean simple type |
|
Optional |
false |
If true, return reviews and comments for the hotel property. Not supported by all providers |
| ReturnMediaLinks |
boolean simple type |
|
Optional |
false |
If true, return the media links. Not supported by all providers |
| 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 |
| HotelDetailsModifiers |
element |
|
|
|
Controls and switches for the Hotel Details request |
| Key |
string simple type |
|
Optional |
|
|
| MaxWait |
nonNegativeInteger simple type |
|
Optional |
|
Maximum wait time in milliseconds for hotel detail results. |
| NumberOfAdults |
long simple type |
|
Optional |
|
The total number of adult guests per booking. Defaults to ‘1’. GDS Providers: 1G, 1V, 1P. |
| NumberOfRooms |
long simple type |
|
Optional |
1 |
The number of rooms per booking. Defaults to ‘1’. GDS Providers 1G, 1V, 1P. |
| PreferredCurrency |
string simple type |
|
Optional |
|
Alternate currency |
| ProcessAllNegoRatesInd |
boolean simple type |
|
Optional |
false |
When false, we will process the request with all the provided negotiated rates in a single request. The request will fail when the number of negotiated rates have exceeded for that hotel chain. When true, this allows to process a request for all provided negotiated rates that may exceed the hotel chain limit. Supported for 1P only. |
| RateRuleDetail |
string simple type |
None , Complete , RatePlansOnly |
Optional |
None |
'None' returns hotel property descriptive information-supported for 1p,1g/1v. 'Complete' returns the complete hotel and room rate information-supported for 1p,1g/1v, 'RatePlansOnly' returns hotel rate information only - supported for 1p, 1g/1v. |
| TotalOccupants |
long simple type |
|
Optional |
|
Number of guests for the room. Supported Providers: 1P |
| PermittedProviders |
element |
|
|
|
Number of guests for the room. Supported Providers: 1P |
| Provider |
element |
|
|
|
Provider identifier |
| Code |
string simple type |
|
Required |
|
|
| LoyaltyCard |
element |
|
|
|
Provider loyalty card information |
| CardNumber |
string simple type |
|
Required |
|
|
| FreeText |
string simple type |
|
Optional |
|
|
| Level |
string simple type |
|
Optional |
|
|
| MembershipStatus |
string simple type |
|
Optional |
|
|
| PriorityCode |
string simple type |
|
Optional |
|
|
| Status |
string simple type |
|
Optional |
|
|
| SupplierType |
string simple type |
Air , Vehicle , Hotel , Rail , Cruise , Other |
Optional |
|
|
| VendorLocationRef |
string simple type |
|
Optional |
|
|
| AllianceLevel |
string simple type |
|
Optional |
|
|
| Key |
string simple type |
|
Optional |
|
|
| MembershipProgram |
string simple type |
|
Optional |
|
Loyalty Program membership Id of the traveler specific to Amtrak(2V) Guest Rewards |
| SupplierCode |
string simple type |
|
Required |
|
The code used to identify the Loyalty supplier, e.g. AA, ZE, MC |
| 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. |
| ProviderReservationSpecificInfo |
typeProviderReservationSpecificInfo complex 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. |
| ProviderReservationLevel |
boolean simple type |
|
Optional |
|
If true means Loyalty card is applied at ProviderReservation level. |
| ReservationLevel |
boolean simple type |
|
Optional |
|
If true means Loyalty card is applied at Universal Record Reservation level e.g. Hotel Reservation, Vehicle Reservation etc. |
| OperatedBy |
element |
|
|
|
This is the carrier code to support Cross Accrual |
| ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
| Key |
string simple type |
|
Required |
|
|
| CorporateDiscountID |
element |
|
|
|
These are zero or more negotiated rate codes |
| NegotiatedRateCode |
boolean simple type |
|
Optional |
|
When set to true,
the data in the CorporateDiscountID is a negotiated rate code.
Otherwise, this data is a Corporate Discount ID rate. |
| 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 |
|
|
|
|
| NumberOfChildren |
element |
|
|
|
Number of Children |
| Amount |
string simple type |
|
Optional |
|
Fee per child. Providers: 1g/1v |
| Count |
long simple type |
|
Required |
|
The total number of children in the booking. Supported Providers 1P. |
| Age |
int simple type |
|
|
|
The Ages of the Children. . The defined age of a Child traveler may vary by supplier, but is typically 1 to 17 years. Supported Providers 1G/1V. |
| HotelBedding |
element |
|
|
|
Specify desired bedding |
| Amount |
string simple type |
|
Optional |
|
Fee for bed type. Providers: 1g/1v/1p |
| Content |
string simple type |
|
Optional |
|
Additional information Providers: 1p |
| NumberOfBeds |
long simple type |
|
Optional |
|
Number of beds of desired Type in room. Use '0' to delete the hotel Optional Beds ( Only RA RC CR ) |
| Type |
string simple type |
|
Required |
|
Queen, King, double, etc |
| RateCategory |
typeOTACode simple type |
|
|
|
Specify Rate Category |
| BookingGuestInformation |
element |
|
|
|
Information about requested rooms and guests allocation. |
| Room |
typeGuestRoomInformation complex type |
|
|
|
Individual room. Multiple occurrences if there are multiple rooms in the request. Maximum number of rooms may vary by supplier or aggregator. |
| Adults |
positiveInteger simple type |
|
|
|
The number of adult guests per room. Maximum number of adults may vary by supplier or aggregator. |
| BookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler and Loyalty cards |
| Key |
string simple type |
|
Optional |
|
|
| LoyaltyCardRef |
element |
|
|
|
|
| Key |
string simple type |
|
Required |
|
|
| DriversLicenseRef |
element |
|
|
|
|
| Key |
string simple type |
|
Required |
|
|
| DiscountCardRef |
element |
|
|
|
|
| Key |
string simple type |
|
Required |
|
|
| PaymentRef |
element |
|
|
|
|
| Key |
string simple type |
|
Required |
|
|
| Child |
element |
|
|
|
Information about a child guest. |
| Age |
integer simple type |
|
Optional |
|
Age of the Child. |
| BookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler and Loyalty cards |
| Key |
string simple type |
|
Optional |
|
|
| LoyaltyCardRef |
element |
|
|
|
|
| Key |
string simple type |
|
Required |
|
|
| DriversLicenseRef |
element |
|
|
|
|
| Key |
string simple type |
|
Required |
|
|
| DiscountCardRef |
element |
|
|
|
|
| Key |
string simple type |
|
Required |
|
|
| PaymentRef |
element |
|
|
|
|
| Key |
string simple type |
|
Required |
|
|
| PointOfSale |
element |
|
|
|
User can use this node to send a specific PCC to access fares allowed only for that PCC. This node gives the capability for fare redistribution at UR level. For fare redistribution at the stored fare level see AirPricingSolution/AirPricingInfo/AirPricingModifiers/PointOfSale. |
| IATA |
string simple type |
|
Optional |
|
Used for rapid reprice. This field is the IATA associated to this Point of Sale PCC. Providers: 1G/1V |
| Key |
string simple type |
|
Optional |
|
|
| ProviderCode |
string simple type |
|
Required |
|
The provider in which the PCC is defined. |
| PseudoCityCode |
string simple type |
|
Required |
|
The PCC in the host system. |
| HostToken |
element |
|
|
|
This is a host token. It contains some kind of payload we got from a hostthat must be passed in on successive calls they know who you are as our systemdoes not maintain state. The format of this string isn't important as long as itis not altered in any way between calls. Since a host token is only valid onthe host it is assocated with, there is also an attribute called Host so we knowhow to route the command(s). You can have multiple active sessions betweenone or more hosts |
| Host |
string simple type |
|
Optional |
|
The host associated with this token |
| Key |
anySimpleType simple type |
|
Optional |
|
Unique identifier for this token - use this key when a single HostToken is shared by multiple elements. |
| 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. |
| NextResultReference |
element |
|
|
|
Container to return/send additional retrieve/request additional search results |
| ProviderCode |
string simple type |
|
Optional |
|
The code of the Provider (e.g 1G,1S) |