| Name |
Type |
Description |
AcceptableGuarantee
|
Core Object |
|
AcceptableGuarantees
|
Core Object |
|
Action_Enum
|
Closed Enumeration |
Identifies an action to take place. |
AdditionalCharge
|
Core Object |
|
AdditionalDetail
|
Core Object |
Used to send additional information. |
AdditionalDetails
|
Core Object |
A collection of AdditionalDetail. |
AdditionalGuestAmount
|
Core Object |
Charges related to additional guests. |
AdditionalGuestAmounts
|
Core Object |
|
AddtionalRules
|
Core Object |
Indicates an additional rule for the reservation (e.g., cancelable, modifiable or refundable). |
AdvanceBookingRestriction
|
Core Object |
|
AgeQualifying
|
Core Object |
Base age group of occupants for which this rate is valid (ex Adult). |
AgeQualifyingCode_Enum
|
Open Enumeration |
A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Adult). This attribute allows for an increase in rate by occupant class.
Person age categories.
Note: Age categories are typically used to qualify pricing and/or eligibility. |
Amenities
|
Core Object |
Container for amenities. |
Amount
|
Core Object |
Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentages, total amount, and the rate description. |
AmountApplyAs_Enum
|
Closed Enumeration |
Used to specify how the amount needs to be applied with respect to the stay. |
AmountDetermination_Enum
|
Closed Enumeration |
Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other). |
AmountPercent
|
Core Object |
Defines the percentage basis for calculating the fee amount or the amount. |
AvailabilityStatus_Enum
|
Closed Enumeration |
Identifies the availability status of an item. |
Basis_Enum
|
Closed Enumeration |
Provides the basis for how the amount of the guarantee is calculated. |
BookingRule
|
Business Object |
The BookingRule element defines restrictions to rates and stays at the hotel for a given rate plan, room type or rate plan/room type combination. |
CancelPenalty
|
Core Object |
The CancelPenalty class defines the cancellation policy of the hotel facility. |
CancelPolicies
|
Core Object |
A collection of CancelPenalty. |
ChargeFrequency_Enum
|
Open Enumeration |
Source: Charge Type (CHG) OpenTravel codelist. |
ChargePenaltyReason_Enum
|
Closed Enumeration |
To specify if the charge applies to early or late checkout. |
ChargeUnit
|
Value With Attributes |
Specifies charge information by unit (e.g., room, person, item) and frequency (e.g., daily, weekly, stay). |
ChargeUnit_Enum
|
Open Enumeration |
Source: Charge Type (CHG) OpenTravel codelist. |
CheckoutCharge
|
Core Object |
The charges that may apply to an early or late checkout. |
Code
|
Value With Attributes |
Some code. |
CodeList
|
Value With Attributes |
Any code used to specify an item, for example, type of traveler, service code, room amenity, etc. |
Codes
|
Core Object |
A collections of strings that identify booking channels, such as GDSs or Internet sites, etc., |
Comment
|
Core Object |
|
Comments
|
Core Object |
A collection of comments. |
Commission
|
Core Object |
Contains details pertaining to commissions. |
Commission_Enum
|
Closed Enumeration |
|
CommissionableAmount
|
Core Object |
|
ContactNumbers
|
Core Object |
|
Reservation_Create
|
SOAP Operation |
|
Reservation_CreateReservations
|
SOAP Operation |
|
DOW_Restrictions
|
Core Object |
|
DayOfOperation
|
Simple |
Days of week |
Deadline
|
Core Object |
The absolute deadline or amount of offset time before a deadline for a payment of cancel goes into effect. |
DeadlineOffsetDropTime_Enum
|
Closed Enumeration |
An enumerated type indicating when the deadline drop time goes into effect. |
Reservation_Delete
|
SOAP Operation |
|
Discount
|
Core Object |
Identifies and provides details about the discount. |
DisplayOptions
|
Value With Attributes |
Provides information on whether an item may be displayed and in what order. |
DistributorTypes
|
Core Object |
|
Donation
|
Core Object |
Provides information about donations made during a booking. |
DonationFrontOfficeInfo
|
Core Object |
TODO-The identifying fields for the front office for a Massive Good donation: |
Feature
|
Core Object |
|
Features
|
Core Object |
A collection of features that are made available as part of this speciific room and this specifiic rate plan. |
Fee
|
Core Object |
Used for non-tax fees and charges (e.g. service charges) . |
FeeDetails
|
Value With Attributes |
Defines the fees and/or taxes associated with a charge (e.g. taxes associated with a hotel rate). |
Fees
|
Core Object |
A collection of fees. |
FormattedText
|
Core Object |
Collection of formatted text sub sections. |
FormattedTextSubSection
|
Core Object |
Used to provide subsection formatted text information. |
GDSCode_Enum
|
Open Enumeration |
|
Geolocation
|
Value With Attributes |
TODO-(use enums and other for lat,long??)Used to specify the geographic coordinates of a location. |
Guarantee
|
Core Object |
The guarantee information to hold a reservation |
GuaranteePayment
|
Core Object |
|
GuaranteePayments
|
Core Object |
A collection of required payments. |
GuaranteeType_Enum
|
Closed Enumeration |
An enumerated type defining the guarantee to be applied to this reservation. |
GuaranteesAccepted
|
Core Object |
TODO- (split between type accepted in location and guest provided)GuaranteeAccepted |
Guest
|
Business Object |
A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGuestRPHs collection. |
GuestCount
|
Core Object |
Defines the number of guests. |
GuestCounts
|
Core Object |
A collection of GuestCount by age group. |
GuestIds
|
Core Object |
A collection of unsigned integers serving as reference placeholders, and used as an index identifying which guests occupy this room |
Guests
|
Core Object |
A collection of Guest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGuestRPHs collection. |
HospitalityOrder
|
Business Object |
Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally finacial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties. |
HotelAdditionalCharges
|
Core Object |
|
HotelFacility
|
Core Object |
An abbreviated short summary of hotel descriptive information. |
HotelReservation
|
Business Object |
The Reservation class contains the current reservation being created or altered. |
HotelReservations
|
Core Object |
A collection of hotel reservations. |
Image
|
Business Object |
|
ImageCategory
|
Business Object |
Each video item represents a specific category. |
InvBlockCutoff
|
Value With Attributes |
Defines the absolute deadline or amount of offset time before unused block inventory is returned to general inventory. |
LengthOfStay
|
Value With Attributes |
A pattern defining allowable lengths of stay (LOS). |
LengthsOfStay
|
Core Object |
A collection of LengthOfStay. |
LengthsOfStay_Enum
|
Closed Enumeration |
|
LocationCode
|
Value With Attributes |
(TODO- Code in the value with a enum for type of code?) Location code is city, stateProvence, or country code |
LocationCodes
|
Core Object |
|
MealPlanList
|
Simple |
A list of meal plans |
MealPlan_Enum
|
Closed Enumeration |
Different meal plans |
MealsIncluded
|
Value With Attributes |
Used to identify meals that are included. |
MeetingCenter
|
Value With Attributes |
Meeting center details for a facility. |
Membership
|
Business Object |
|
Multimedia
|
Business Object |
Describes multimedia item(s). |
MultimediaCollection
|
Core Object |
Contains multimedia item(s). |
MultimediaDescription
|
Core Object |
The description associated with the video in a specific language. |
MultimediaDetails
|
Value With Attributes |
The title of the multimedia object. |
MultimediaItemGroup
|
Value With Attributes |
Specific information about a multimedia item. |
OffsetCalculationMode_Enum
|
Closed Enumeration |
This indicates how the offset period is applied for the release back to general inventory of unbooked rooms in the inventory block . |
OperationSchedule
|
Core Object |
The OperationSchedule class defines the dates and hours of operation. |
OperationSchedules
|
Core Object |
Collection of operation schedules. |
Pricing_Enum
|
Closed Enumeration |
An enumerated type that defines how a service is priced. Values: Per stay, Per person, Per night, Per person per night, Per use. |
PriorQuoteReference
|
Core Object |
|
PromotionCode
|
Value With Attributes |
Promotion code is the identifier used by the host to link directly with a specific named advertising campaign. By including the required code, the client is able to gain access to special offers which may have been created for a specifically targeted group via a CRM system or for a wider advertising campaign using Television or press adverts. |
PropertyAmenity
|
Value With Attributes |
Name of the Amenity |
PropertyBusinessService
|
Value With Attributes |
Name of the business service. |
PropertyFeature
|
Value With Attributes |
Name of the feature. |
PropertyPolicy
|
Value With Attributes |
|
PropertyReference
|
Value With Attributes |
The property reference identifies a specific property by using the Chain Code, the Brand Code, and the Hotel Code. The codes used are agreed upon by trading partners. |
Queue
|
Value With Attributes |
Information to identify a queue. |
Rate
|
Core Object |
The Rate contains a collection of elements that define the amount of the rate, associated fees, additional occupant amounts as well as payment and cancellation policies. Taxes can be broken out or included within the various amounts. A currency can be associated to each amount The applicable period of the the rate are indicated by the effective dates. Restrictions that may apply to that rate, such as the minimum or maximum length of stay, stay-over dates (such as a Saturday night), min/max guests applicable for the rate, and age group (ex Adult) are attributes of Rate. It indicates the number of units that the quoted rate is based upon, as well as the TimeUnits type used that the rate is based upon, e.g.: 3days at $100.00 per day. |
RateIndicator_Enum
|
Closed Enumeration |
An enumerated type indicating special conditions with the rate Valid values: ChangeDuringStay, MultipleNights, Exclusive, OnRequest, LimitedAvailability. |
RatePlan
|
Core Object |
Information significant to defining a rate plan. |
RatePlanCode
|
Value With Attributes |
A string value may be used to request a particular code or an ID if the guest qualifies for a specific rate, such as AARP, AAA, a corporate rate, etc., or to specify a negotiated code as a result of a negotiated rate. |
RatePlanInclusions
|
Core Object |
Defines charges that are included in this rate plan. |
RatePlanType_Enum
|
Closed Enumeration |
Note: Typically used for rate plans that may be published, e.g. have no qualifying criteria, or may be restricted or negotiated, e.g. has qualifying criteria for eligibility and/or has been negotiated between parties. |
RatePlans
|
Core Object |
A collection of Rate Plans associated with a particular Room Stay. |
Rates
|
Core Object |
Individual rate amount. This rate is valid for a range of number of occupants and an occupant type. |
Reservation_Read
|
SOAP Operation |
|
Rebate
|
Core Object |
Information about a suppliers participation in a rebate program, e.g. a VAT (value added tax) program. |
RebatePrograms
|
Core Object |
|
ReceiverNAddress
|
Core Object |
|
Recreation
|
Value With Attributes |
Name of the recreation. |
RelativePosition
|
Core Object |
The RelativePosition object contains information about the direction, distance and travel time to/from a facility (hotel, car rental location, or airport) or to/from a designated location. |
RequiredPayments_Enum
|
Closed Enumeration |
|
ResCommonDetail
|
Core Object |
A grouping of elements including Guest Counts, Time Span, pointers to Res Guests, guest Memberships, Comments and Special Requests and finally finacial information including Guarantee, Deposit and Payyment and Cancellation Penalties. |
ResGuestType_ProfileRPHs
|
Core Object |
|
ResGuestType_ProfileRPHs_ProfileRPH
|
Core Object |
|
ResStatus_Enum
|
Closed Enumeration |
Statuses that exist in a property management system (PMS). |
ReservationGlobalInfo
|
Core Object |
ResGlobalInfo is a container for various information that affects the Reservation as a whole. These include global comments, counts, reservation IDs, loyalty programs, and payment methods. |
RestrictionStatus
|
Value With Attributes |
Identifies the availability status of an item. |
RestrictionStatus_Enum
|
Closed Enumeration |
|
Retribution_Enum
|
Closed Enumeration |
An enumerated type defining the type of action taken when the deadline has been exceeded. |
RoomAmenities
|
Core Object |
|
RoomAmenity
|
Value With Attributes |
Hotel room amenities. |
RoomAmenityQuality_Enum
|
Closed Enumeration |
Used to designate the quality level of the RoomAmenity |
RoomCharacteristics
|
Core Object |
Used to define a room (eg. its location, configuration, view). |
RoomGender_Enum
|
Closed Enumeration |
|
RoomOccupancy
|
Core Object |
Occupany for the room. |
RoomRate
|
Core Object |
Individual rate amount. This rate is valid for a range of number of occupants and an occupant type. |
RoomRateRestriction
|
Core Object |
|
RoomRateRestrictionStatus
|
Value With Attributes |
Describes the status of a restriction on a room and/or rate. |
RoomRateRestrictions
|
Core Object |
|
RoomStay
|
Business Object |
Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally finacial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties. |
RoomStayProduct
|
Business Object |
A unique identifier defined by an external authority for this object. |
RoomStays
|
Core Object |
A collection of RoomStay objects. Room stays associated with this reservation. |
RoomType
|
Core Object |
Provides details regarding rooms, usually guest rooms. |
RoomViewType_Enum
|
Closed Enumeration |
Describes room view types |
RoutingHop
|
Core Object |
A RoutingHop object conveys information about the path that this notification update took (e.g. how many and which systems it passed through). |
RoutingHops
|
Core Object |
A collection of RoutingHop objects. This details the path that the original request or notification traveled. |
Service
|
Business Object |
A ServiceType class. |
ServiceCategory
|
Value With Attributes |
The representation code of the specific service category for the service being reserved. Hotel systems often group multiple services into a single category. This refers to that category that is specific to the hotel CRS/PMS. |
ServiceDetails
|
Core Object |
Details on the Service including Guest Counts, Time Span of this Service, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Service and finally financial information related to the Service, including Guarantee, Deposit and Paymen |
ServiceIDs
|
Core Object |
A collection of unsigned integers that reference the ID attribute in the Service object. The ServiceRPH attribute in the Service object is an indexing attribute that identifies the services attached to a specific guest or to the reservation. |
ServiceOffer
|
Business Object |
TODO- (Ancillary) A ServiceType class. |
ServiceProduct
|
Business Object |
TODO- (Ancillary) A ServiceType class. |
Services
|
Core Object |
A collection of Service objects. This is the collection of all services associated with any part of this reservation (the reservation in its entirety, one or more guests, or one or more room stays). Which services are attributable to which part is determined by each object's ServiceRPHs collection. |
SpecialRequest
|
Core Object |
|
SpecialRequests
|
Core Object |
A collection of SpecialRequest objects. The collection of all special requests associated with any part of the reservation (the reservation in its entirety, one or more guests, or one or more room stays). Which special requests belong to which part is determined by each object's SpecialRequestRPHs collection. |
StringTiny
|
Simple |
A tiny string
Minimum length of 0 and a maximum length of 32 |
Tax
|
Core Object |
Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should be calculated in only one of the two ways. |
Taxes
|
Core Object |
A collection of taxes. |
Text
|
Business Object |
|
TextCategory
|
Business Object |
Each video item represents a specific category. |
TimeUnit_Enum
|
Closed Enumeration |
Defines the unit in which the time is expressed (e.g. year, day, hour). |
ToFrom_Enum
|
Closed Enumeration |
Used to indicate whether the context is to a facility or from a facility. |
Total
|
Core Object |
The total amount charged for the service including additional amounts and fees. |
TransactionAction_Enum
|
Closed Enumeration |
To specify the type of action requested when more than one function could be handled by the message. |
Transportation
|
Business Object |
Detailed transportation information. |
Transportation_Enum
|
Open Enumeration |
Type of tranportation: Air, Rail, Bus, Boat, Private Auto, Other. |
Transportations
|
Core Object |
Used to define the types of transportation offered. |
TravelSector_Enum
|
Closed Enumeration |
Code for the travel sector |
TripPurpose
|
Value With Attributes |
The purpose of the trip. If the customer has a default trip purpose this should be pre-populated with that value and the @TripPurposeRequiredInd should be set to FALSE. |
TripPurpose_Enum
|
Closed Enumeration |
Typical trip purposes. |
Reservation_Update
|
SOAP Operation |
|
VendorMessage
|
Core Object |
Provides formatted textual information that a vendor wishes to make known. The type of information is indicated. |
VendorMessages
|
Core Object |
Collection of vendor messages. |
Video
|
Business Object |
|
VideoCategory
|
Business Object |
Each video item represents a specific category. |
Viewership
|
Core Object |
Viewerships determine the distribution channel(s) for a rate plan. As an optional element, the absence of Viewerships implies a generally available rate, while the presence of a Viewerships collection implies qualifications on the rate. This may also be used to define a system that is able to view the hotel content. |
Viewerships
|
Core Object |
A collection of Viewships. |
WrittenConfInst
|
Core Object |
Method by which confirmations should be delivered. |
rating
|
Value With Attributes |
The actual award or rating received by the facility. |