BookingHotelSegmentReq |
element |
|
|
|
Used for Hotel Segment Sell and modification. |
| SessionKey |
typeRef simple type |
|
Optional |
|
System generated session token. Token contains the session information of the user. User must supply this in the resquest to use the current session they are working on. |
| 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. |
| 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. |
| AddHotelSegment |
element |
|
|
|
Container for Hotel Segment to be added. |
| HotelRateDetail |
element |
|
|
|
Returns hotel rate details during the stay if rates are available for requested property. |
| ApproximateBase |
string simple type |
|
Optional |
|
Hotel base rate expressed in another currency |
| ApproximateRateGuaranteed |
boolean simple type |
|
Optional |
|
If true, approximate rate is guaranteed by vendor. Supported Providers: 1G,1V |
| ApproximateSurcharge |
string simple type |
|
Optional |
|
Surcharge associated with the room expressed in another currency. |
| ApproximateTax |
string simple type |
|
Optional |
|
Taxes expressed in another currency |
| ApproximateTotal |
string simple type |
|
Optional |
|
Hotel total rate expressed in another currency. |
| BookableQuantity |
nonNegativeInteger simple type |
|
Optional |
|
The number of rooms which can be booked on the rate returned in HotelRateDetails. When the aggregator responds ‘IsPackage’= true (pricing for all rooms together), the BookableQuantity value will be ‘1’. |
| ExtraFeesIncluded |
string simple type |
true , false , unknown |
Optional |
|
When true, total amounts includes additional fees or charges." Enumerated values are true, false, and unknown |
| 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. |
| Key |
string simple type |
|
Optional |
|
|
| RateCategory |
positiveInteger simple type |
|
Optional |
|
An enumerated type that allows the query to specify a rate category type, and provides major categories for comparison across brands. Refer to OpenTravel Code List Rate Plan Type (RPT). Encode/decode data in Util ReferenceDataRetrieveReq TypeCode=“HotelRateCategory". |
| RateChangeIndicator |
string simple type |
true , false , unknown |
Optional |
|
Determines if the rate changes during the length of stay. Enumerated values are true, false, and unknown. |
| RateGuaranteed |
boolean simple type |
|
Optional |
|
|
| RateOfferId |
string simple type |
|
Optional |
|
Offer Identifier. Maybe required for hotels provided by aggregators. |
| RatePlanType |
string simple type |
|
Required |
|
|
| RateSupplier |
string simple type |
|
Optional |
|
Indicates the source of the rate. |
| Base |
string simple type |
|
Optional |
|
This attribute is used to describe the Hotel Supplier Base Rate |
| Surcharge |
string simple type |
|
Optional |
|
This attribute used to describe Surcharge associated with the room |
| Tax |
string simple type |
|
Optional |
|
This attribute used to describe Tax associated with the room |
| Total |
string simple type |
|
Optional |
|
This attribute used to describe Hotel Supplier Total Rate |
| 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’. |
| RoomRateDescription |
typeHotelRateDescription complex type |
|
|
|
A code that indicates why the maximum fare or rate was determined to be ‘out of policy’. |
| 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 |
| HotelRateByDate |
element |
|
|
|
The daily rate details |
| ApproximateBase |
string simple type |
|
Optional |
|
Hotel base rate expressed in another currency |
| ApproximateTotal |
string simple type |
|
Optional |
|
Hotel total rate expressed in another currency. Supported Providers: 1P |
| Contents |
string simple type |
|
Optional |
|
Contents will be representing all unformatted data returned by HOST, those are not uAPI supported. Support provider 1P. |
| EffectiveDate |
string simple type |
|
Optional |
|
|
| ExpireDate |
string simple type |
|
Optional |
|
|
| Base |
string simple type |
|
Optional |
|
This attribute is used to describe the Hotel Supplier Base Rate |
| Surcharge |
string simple type |
|
Optional |
|
This attribute used to describe Surcharge associated with the room |
| Tax |
string simple type |
|
Optional |
|
This attribute used to describe Tax associated with the room |
| Total |
string simple type |
|
Optional |
|
This attribute used to describe Hotel Supplier Total Rate |
| 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. |
| AcceptedPayment |
element |
|
|
|
When set to true,
the data in the CorporateDiscountID is a negotiated rate code.
Otherwise, this data is a Corporate Discount ID rate. |
| PaymentCode |
string simple type |
|
Optional |
|
The issuer of the form of payment, such as the credit card bank. |
| Commission |
element |
|
|
|
The issuer of the form of payment, such as the credit card bank. |
| ApproxCommissionAmount |
string simple type |
|
Optional |
|
The approximate commission amount in the agency’s provisioned or requested currency. |
| ApproxCommissionOnSurcharges |
string simple type |
|
Optional |
|
The approximate commission on surcharges in the agency’s provisioned or requested currency. |
| CommissionAmount |
string simple type |
|
Optional |
|
The commission amount in the aggregator’s or supplier’s currency. |
| CommissionOnSurcharges |
string simple type |
|
Optional |
|
Commission on surcharges in the aggregator’s or supplier’s currency. |
| Indicator |
string simple type |
true , false , unknown |
Optional |
|
Indicates if the Rate Plan is commissionable.True: Rate is commissionable.False: Rate is not commissionable.Unknown: Commission indicator is not returned by the hotel supplier (chain or property). |
| Percent |
string simple type |
|
Optional |
|
The percentage applied to the commissionable amount to determine the payable commission amount. |
| RateMatchIndicator |
element |
|
|
|
"Match" Indicators for certain request parameters, e.g. Child Count, Extra Adults etc. |
| Status |
string simple type |
Available , NotAvailable , SubstituteOffered , MaximumExceeded |
Required |
|
|
| Type |
string simple type |
RateCategory , RoomCount , AdultCount , ChildCount , AdultRollaway , ChildRollaway , Crib |
Required |
|
|
| Value |
string simple type |
|
Optional |
|
|
| TaxDetails |
element |
|
|
|
|
| Tax |
element |
|
|
|
|
| Code |
positiveInteger simple type |
|
Required |
|
Code identifying fee (e.g. agency fee, bed tax etc.). Refer to OPEN Travel Code List for Fee Tax Type. Possible values are OTA Code against FTT. |
| CollectionFreq |
string simple type |
|
Optional |
|
Indicates how often the tax is collected. Values can be Once or Daily |
| EffectiveDate |
date simple type |
|
Optional |
|
|
| ExpirationDate |
date simple type |
|
Optional |
|
|
| Term |
string simple type |
|
Optional |
|
Indicates how the tax is applied. Values can be PerPerson, PerNight and PerStay |
| Amount |
typeMoney simple type |
|
|
|
Indicates how the tax is applied. Values can be PerPerson, PerNight and PerStay |
| Percentage |
float simple type |
|
|
|
Indicates how the tax is applied. Values can be PerPerson, PerNight and PerStay |
| CancelInfo |
element |
|
|
|
Returns cancellation information for certain hotel returned in response. This information is available through GDS transactions |
| CancelDeadline |
dateTime simple type |
|
Optional |
|
Last date/time the reservation can be canceled without penalty. |
| CancelPenaltyAmount |
string simple type |
|
Optional |
|
This will contain the cancellation penalty amount. |
| CancelPenaltyPercent |
float simple type |
|
Optional |
|
This will contain the cancellation penalty expressed as a percentage. |
| CancelPenaltyPercentAppliesTo |
string simple type |
|
Optional |
|
This will contain the cost qualifier that explains what the percentage is applied to in order to calculate the cancel penalty. |
| FeeInclusive |
boolean simple type |
|
Optional |
|
Indicates whether or not the Penalty amount includes fees. |
| Method |
string simple type |
|
Optional |
|
Cancellation method, either "API", "URL", "INFO", or "NONE". |
| NonRefundableStayIndicator |
string simple type |
true , false , unknown |
Optional |
|
True if Deposit or Payment is non-refundable |
| NumberOfNights |
integer simple type |
|
Optional |
|
This will contain the number of nights that will be assessed as the cancelation penalty. |
| Supported |
boolean simple type |
|
Optional |
|
If true, the booking can be canceled. If false, the booking cannot be canceled. |
| TaxInclusive |
boolean simple type |
|
Optional |
|
Indicates whether or not the Penalty amount includes taxes. |
| URL |
string simple type |
|
Optional |
|
The URL provided by the supplier to cancel the booking, if @Method="URL". For all other values of @Method, @URL is not returned. |
| OffsetDropTime |
string simple type |
|
Optional |
|
An enumerated type indicating when the deadline drop time goes into effect. Enumerated values are “AfterBooking” and “BeforeArrival”. |
| OffsetTimeUnit |
string simple type |
|
Optional |
|
The units of time, e.g: days, hours, etc that apply to the deadline. Enumerated values are “Year”, “Month”, “Day”, and “Hour”. |
| OffsetUnitMultiplier |
integer simple type |
|
Optional |
|
The number of units of DeadlineTimeUnit. |
| CancellationPolicy |
string simple type |
|
|
|
Return cancellation policy text by the aggregator. |
| Text |
string simple type |
|
|
|
The informational text provided by the supplier to cancel the booking, if @Method="INFO". For all other values of @Method, Text is not returned. |
| GuaranteeInfo |
element |
|
|
|
The informational text provided by the supplier to cancel the booking, if @Method="INFO". For all other values of @Method, Text is not returned. |
| AbsoluteDeadline |
dateTime simple type |
|
Optional |
|
Latest date/time when deposit/payment/guarantee is required. |
| CredentialsRequired |
boolean simple type |
|
Optional |
|
Identification required at booking/checkin. Not supported by 1P. |
| GuaranteeType |
string simple type |
Deposit , Guarantee , Prepayment |
Optional |
|
Deposit, Guarantee, or Prepayment required to hold/book the room. Applicable only for HotelSupershopper, Hotel Details and Hotel rules. |
| HoldTime |
string simple type |
|
Optional |
|
Expiration time for room reservation held without deposit/guarantee. |
| OffsetDropTime |
string simple type |
|
Optional |
|
An enumerated type indicating when the deadline drop time goes into effect. Enumerated values are “AfterBooking” and “BeforeArrival”. |
| OffsetTimeUnit |
string simple type |
|
Optional |
|
The units of time, e.g: days, hours, etc that apply to the deadline. Enumerated values are “Year”, “Month”, “Day”, and “Hour”. |
| OffsetUnitMultiplier |
integer simple type |
|
Optional |
|
The number of units of DeadlineTimeUnit. |
| DepositAmount |
element |
|
|
|
Amount required for deposit/prepayment |
| Amount |
string simple type |
|
Optional |
|
Supplier deposit amount required for
deposit/prepayment.Supported by all Providers when supported by
supplier |
| ApproximateAmount |
string simple type |
|
Optional |
|
Approximate deposit amount required for
deposit/prepayment. |
| DepositNights |
integer simple type |
|
|
|
Number of Nights required for deposit/prepayment |
| DepositPercent |
integer simple type |
|
|
|
Percentage of stay required for deposit/prepayment |
| GuaranteePaymentType |
element |
|
|
|
Accepted payment types. Applicable only for HotelSupershopper, Hotel Details and Hotel rules. |
| Description |
string simple type |
|
Optional |
|
|
| Type |
string simple type |
|
Required |
|
Accepted payment types: CreditCard, AgencyIATA/ARC, FrequentGuest, SpecialIndustry, CDNumber, HomeAddress, CompanyAddress, Override, Other, or None |
| SupplementalRateInfo |
string simple type |
|
|
|
Supplemental rate information provided by the aggregator. |
| RoomCapacity |
element |
|
|
|
The maximum number of guests for a room or for each room in a package. |
| IsPackage |
boolean simple type |
|
Optional |
|
If true, the rooms are offered as a package by the aggregator. |
| Capacity |
positiveInteger simple type |
|
|
|
The maximum number of guests per room. |
| ExtraCharges |
element |
|
|
|
Additional charges applied to the hotel rate. |
| AdultRollawayCharge |
string simple type |
|
Optional |
|
Additional charge for an extra rollaway bed provided for an adult guest. |
| ChildRollawayCharge |
string simple type |
|
Optional |
|
Additional charge for an extra rollaway bed provided for a child guest. |
| CribAmount |
string simple type |
|
Optional |
|
Additional charge for a crib. |
| ExtraAdultAmount |
string simple type |
|
Optional |
|
Additional charge for an extra guest. |
| ExtraChildAmount |
string simple type |
|
Optional |
|
dditional charge for an extra child guest. |
| Inclusions |
element |
|
|
|
Additional items included in the hotel rate plan. |
| SmokingRoomIndicator |
string simple type |
true , false , unknown |
Optional |
|
Indicates if the room is designated as nonsmoking or smoking.
true = Smoking
false = NonSmoking
unknown = Information is not returned by the hotel supplier (chain or property). |
| BedTypes |
element |
|
|
|
Bed types in the rate plan. |
| Code |
positiveInteger simple type |
|
Optional |
|
Bed Type Code. Uses Open Travel Code List Room Amenity Type (RMA). Encode/decode data in Util ReferenceDataRetrieveReq TypeCode=“HotelAmenities”. |
| Quantity |
integer simple type |
|
Optional |
|
Bed Quantity. |
| MealPlans |
element |
|
|
|
Meal options available for the rate plan. |
| Breakfast |
string simple type |
true , false , unknown |
Optional |
|
Indicates whether a daily breakfast is included in the meal plan.
true = Breakfast is included
false = Breakfast is not included
unknown = Information is not returned by the hotel supplier (chain or property). |
| Dinner |
string simple type |
true , false , unknown |
Optional |
|
Indicates whether a daily dinner is included in the meal plan.
true = Dinner is included
false = Dinner is not included
unknown = Information is not returned by the hotel supplier (chain or property). |
| Lunch |
string simple type |
true , false , unknown |
Optional |
|
Indicates whether a daily lunch is included in the meal plan.
true = Lunch is included
false = Lunch is not included
unknown = Information is not returned by the hotel supplier (chain or property). |
| MealPlan |
element |
|
|
|
Meal plan. |
| Code |
positiveInteger simple type |
|
Optional |
|
Meal plan code. Uses Open Travel Code List Meal Plan Type (MPT). Encode/decode data in Util ReferenceDataRetrieveReq TypeCode=“HotelMealPlans”. |
| RoomView |
element |
|
|
|
Meal plan code. Uses Open Travel Code List Meal Plan Type (MPT). Encode/decode data in Util ReferenceDataRetrieveReq TypeCode=“HotelMealPlans”. |
| Code |
positiveInteger simple type |
|
Optional |
|
OTA code represents different hotel room views. |
| 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 |
|
|
| 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 |
|
|
|
|
| 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 |
| GuestInformation |
element |
|
|
|
The information like number of rooms ,number of adults,children to be provided while booking the hotel |
| HotelRateDetailRef |
string simple type |
|
Optional |
|
Reference for the Hotel Rate Detail. Used for Hotel Booking only. The value is arbitrary. |
| NumberOfRooms |
long simple type |
|
Optional |
|
|
| NumberOfAdults |
element |
|
|
|
Number of Adults |
| Amount |
string simple type |
|
Optional |
|
Fee for extra adults. Providers: 1g/1v/1p |
| Content |
string simple type |
|
Optional |
|
Additional information. Providers 1p |
| ExtraAdults |
long simple type |
|
Optional |
|
The number of extra adults in the room ,use '0' to delete the extra adults |
| 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. |
| ExtraChild |
element |
|
|
|
Providers: 1p |
| Content |
string simple type |
|
Optional |
|
Additional information |
| Count |
long simple type |
|
Optional |
|
The number of extra children in the room |
| PromotionCode |
element |
|
|
|
The number of extra children in the room |
| Key |
string simple type |
|
Optional |
|
|
| Guarantee |
element |
|
|
|
Payment GuaranteeGuarantee, Deposit or PrePayment |
| ExternalReference |
string simple type |
|
Optional |
|
|
| 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 |
|
Key for update/delete of the element |
| Reusable |
boolean simple type |
|
Optional |
false |
Indicates whether the form of payment can be reused or not. Currently applicable for Credit and Debit form of payment |
| ReuseFOP |
string simple type |
|
Optional |
|
Key of the FOP Key to be reused as this Form of Payment.Only Credit and Debit Card will be supported for FOP Reuse. |
| Type |
string simple type |
|
Required |
|
Guarantee, Deposit for 1G/1V/1P and PrePayment for 1P only |
| 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. |
| CreditCard |
element |
|
|
|
Container for all credit card information. |
| AcceptanceOverride |
boolean simple type |
|
Optional |
|
Override airline restriction on the credit card. |
| BankCountryCode |
string simple type |
|
Optional |
|
ISO Country code associated with the issuing bank |
| BankName |
string simple type |
|
Optional |
|
Issuing bank name for this credit card |
| BankStateCode |
string simple type |
|
Optional |
|
State code associated with the issuing bank. |
| CustomerReference |
string simple type |
|
Optional |
|
Agencies use this to pass the traveler information to the credit card company. |
| Enett |
boolean simple type |
|
Optional |
false |
Acceptable values are true or false. If set to true it will denote that the credit card used has been issued through Enett. For all other credit card payments this value will be set to false. |
| ExtendedPayment |
string simple type |
|
Optional |
|
Used for American Express (AX) and other credit cards, e.g., Visa (VI) and Master card (CA), that allow Extended Payment, subject to the BSP market rule. |
| ThirdPartyPayment |
boolean simple type |
|
Optional |
false |
If true, this indicates that the credit card holder is not one of the passengers. |
| ApprovalCode |
string simple type |
|
Optional |
|
This code is required for an authorization process from the Credit Card company directly,required for some of the CCH carriers.This attribute is also used for EMD retrieve and issuance transactions. |
| CVV |
string simple type |
|
Optional |
|
Card Verification Code |
| ExpDate |
gYearMonth simple type |
|
Optional |
|
The Expiration date of this card in YYYY-MM format. |
| Name |
string simple type |
|
Optional |
|
The name as it appears on the card. |
| Number |
string simple type |
|
Optional |
|
|
| Type |
string simple type |
|
Optional |
|
The 2 letter credit/ debit card type. |
| Key |
string simple type |
|
Optional |
|
The Key assigned to the payment details value from the specified profile. |
| ProfileID |
string simple type |
|
Optional |
|
The unique ID of the profile that contains the payment details to use. |
| 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 |
|
|
| BillingAddress |
typeStructuredAddress complex type |
|
|
|
The address to where the billing statements
for this card are sent. Used for address verification purposes. |
| 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 |
|
|
| OtherGuaranteeInfo |
element |
|
|
|
|
| Type |
string simple type |
IATA/ARC Number , Agency Address , Deposit Taken , Others |
Required |
|
1) IATA/ARC Number
2) Agency Address
2) Deposit Taken
3) Others |
| HotelSpecialRequest |
element |
|
|
|
Make a textual special request to the Hotel supplier. |
| 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 |
|
|
| 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 |
|
|
| ReservationName |
element |
|
|
|
Container to represent reservation name as appears in GDS booking |
| HotelRateDetailRef |
string simple type |
|
Optional |
|
Reference for the Hotel Rate Detail. Used for Hotel Booking only. The value is arbitrary. |
| 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 |
|
|
| NameOverride |
element |
|
|
|
To be used if the name is different from booking travelers in the PNR |
| Age |
decimal simple type |
|
Optional |
|
Age. |
| First |
string simple type |
|
Required |
|
First Name. |
| Last |
string simple type |
|
Required |
|
Last Name. |
| DeleteHotelSegment |
element |
|
|
|
Container for Hotel Segment to be deleted |
| HotelReservationRef |
typeNonAirReservationRef complex type |
|
|
|
Container for Hotel Segment to be deleted |
| LocatorCode |
string simple type |
|
Required |
|
|