Oracle Hospitality OPERA Cloud Web Self-Service ... · PrimaryInd boolean No When true, indicates a...

Oracle® Hospitality OPERA Cloud Web Self-Service

AvailabilityService Web Service Reference

October 2017

2

Copyright © 2017, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing

restrictions on use and disclosure and are protected by intellectual property laws. Except as

expressly permitted in your license agreement or allowed by law, you may not use, copy,

reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or

display any part, in any form, or by any means. Reverse engineering, disassembly, or

decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be

error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it

on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated

software, any programs installed on the hardware, and/or documentation, delivered to U.S.

Government end users are "commercial computer software" pursuant to the applicable Federal

Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication,

disclosure, modification, and adaptation of the programs, including any operating system,

integrated software, any programs installed on the hardware, and/or documentation, shall be

subject to license terms and license restrictions applicable to the programs. No other rights are

granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management

applications. It is not developed or intended for use in any inherently dangerous applications,

including applications that may create a risk of personal injury. If you use this software or

hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe,

backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its

affiliates disclaim any liability for any damages caused by use of this software or hardware in

dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be

trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC

trademarks are used under license and are trademarks or registered trademarks of SPARC

International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or

registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open

Group.

This software or hardware and documentation may provide access to or information about content,

products, and services from third parties. Oracle Corporation and its affiliates are not responsible

for and expressly disclaim all warranties of any kind with respect to third-party content, products,

and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle

Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to

your access to or use of third-party content, products, or services, except as set forth in an

applicable agreement between you and Oracle.

3

Preface

This document describes the AvailabilityService web service. The document describes methods, complex

types, and elements.

Audience This document is intended for developers who develop applications that interface with OPERA through

OPERA Cloud Web Self-Service.

Customer Support To contact Oracle Customer Support, access My Oracle Support at the following URL:

https://support.oracle.com

When contacting Customer Support, please provide the following:

Product version and program/module name

Functional and technical description of the problem (include business impact)

Detailed step-by-step instructions to re-create

Exact error message received and any associated log files

Screen shots of each step you take

Documentation Oracle Hospitality product documentation is available on the Oracle Help Center at

http://docs.oracle.com/en/industries/hospitality/

Revision History

Date Description of Change

October 2017 Initial publication

https://support.oracle.com/

http://docs.oracle.com/en/industries/hospitality/

4

Contents

Preface ....................................................................................................... 3

Audience ............................................................................................................................................................... 3

Customer Support ............................................................................................................................................... 3

Documentation .................................................................................................................................................... 3

Revision History .................................................................................................................................................. 3

1 AvailabilityService ............................................................................... 5

AvailabilityService Web Service ........................................................................................................................ 6

Methods: AvailabilityService ...................................................................................................................... 7

Complex Types: AvailabilityService .......................................................................................................... 9

Elements: AvailabilityService ................................................................................................................... 93

5

1 AvailabilityService

Sources

Name Description

AvailabilityService The AvailabilityService web service fetches Hotel Room-Rate Availability. This also includes operations to manage Restrictions and Hurdles, which allows control of Room-Rate Availability.

6

AvailabilityService Web Service

Name

AvailabilityService

Description

The AvailabilityService web service fetches Hotel Room-Rate Availability. This also includes operations

to manage Restrictions and Hurdles, which allows control of Room-Rate Availability.

See Also

Methods

Elements

Complex Types

7

Methods: AvailabilityService

Methods

Name Description

FetchHotelAvailability Fetches hotel availability for a given date and hotel.

FetchRegionalRateParity Fetches the regional rate parity.

Ping Sends a response to a ping.

Method: FetchHotelAvailability

Description

This Web Service Operation fetches hotel availability for a given date and hotel.

Input

The input of this method is the document element FetchHotelAvailabilityRQ having the structure defined

by the following table.

Name Type Required? Occurs Description

OperaContext OperaContextType No 0..1 Refer to Generic common types document.

AvailRequestSegments anyType (restriction) No 0..1 Availability Request Segment includes

a collection of criteria that requests a

Room Rate. At least one availability

request criteria is required

Output

The output of this method is the document element FetchHotelAvailabilityRS having the structure

defined by the following table.


Yes 1..1

Errors ErrorsType No 0..1 Refer to Generic common types document.

Yes 1..1

AvailResponseSegments anyType (restriction)

No 0..1

Method: FetchRegionalRateParity

Description

Fetches the regional rate parity.

Input

The input of this method is the document element RegionalRateParityRQ having the structure defined by

the following table.

8



RegionalRateParitySearchCriteria RegionalRateParitySearchType No 0..1 A collection of search criteria to fetch Rate Parity.

Output

The output of this method is the document element RegionalRateParityRS having the structure defined

by the following table.


Yes 1..1


Yes 1..1

RegionalRateParity RegionalRateParityType No 0..1 Information on room rate parity among channels or hotels.

Method: Ping

Description

Sends a response to a ping.

Input

The input of this method is the document element PingRQ having the structure defined by the following

table.



OperaPingInput OperaPingRequestType No 0..1 Optional input for the ping operation.

Output

The output of this method is the document element PingRS having the structure defined by the following

table.


Yes 1..1


Yes 1..1

OperaVersion OperaVersionNumberType No 0..1 OPERA version number.

9

Complex Types: AvailabilityService

Complex Type: AdditionalGuestAmountType

Attributes

Name Type Required? Description

AgeQualifyingCode AgeQualifyingCodeType Yes

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Amount TotalType 0..1

Complex Type: AddressInfoType

Description

Provides address information.

Content Model



1..1

UniqueID UniqueID_Type 0..1 Address ID for the address.

Address AddressType 0..1 Address details for the profile.

Complex Type: AddressSearchType

Description

Address details such as city, state, country, and postal code.

Attributes


ExcludeNoCity boolean No When true, indicates that only profiles with city will be fetched.

Content Model



1..1

CityName StringLength40 0..1 City (for example, Dublin), town, or postal station (that is, a postal service territory, often used in a military address).

PostalCode StringLength15 0..1 Post Office Code number.

State StringLength20 0..1 State or Province name (for example, Texas).

CountryName CountryNameType 0..1 Country name (for example, Ireland).

10


StreetAddress StringLength80 0..1 First Line of Street Address. For profile search it matches the first Address line.

Complex Type: AddressType

Description

Provides address information.

Attributes


Type CodeType No Defines the type of address (for example, home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT).

TypeDescription string No Describes the type code.

PrimaryInd boolean No When true, indicates a primary information.

UpdateReservations boolean No Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address.

Content Model



1..1

AddressLine StringLength80 0..4 When the address is unformatted (FormattedInd="false"), these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.



CityExtension StringLength20 0..1 Post Office City Extension Code number. City Extension is mainly used for UK addresses.

County StringLength20 0..1 County or District Name (for example, Fairfax). This is read-only.



Language CodeType 0..1 Language code associated with the address.

Complex Type: AlienInfoType

Description

Immigration and visa information of a foreign person.

11

Content Model



1..1

AlienRegistrationNo string 0..1 Alien Registration Number.

ImmigrationStatus StringLength40 0..1 Immigration Status on an Alien.

VisaValidityType StringLength40 0..1 Visa Type of an Alien.

Complex Type: AmountType

Description

Base charge and additional charges related to a room that includes such things as additional guest

amounts and cancel fees. Also includes discount percentages, total amount, and the rate description.

Attributes


Start date No The starting value of the date range.

End date No The ending value of the date range.

Content Model



1..1

Base TotalType 0..1 The base amount charged for the accommodation or service per unit of time (for example, Nightly, Weekly). If TaxInclusive is set to True, then taxes are included in the base amount. Additional charges should be itemized in the other elements.

AdditionalGuestAmounts anyType (restriction) 0..1 A collection of charges that apply to additional occupants, guests, or service users (over and above the rate's MaxGuest Applicable).

Discount DiscountType 0..1 Discount percentage and/or Amount, code, and textual reason for discount

ShareRatePercentage Percentage 0..1 Indicates the share rate percentage for the reservation if set to CUSTOMSPLIT.

ShareDistributionInstruction ShareDistributionInstructionType 0..1 Last rate share distribution instruction applied on share reservation daily rate segment.

Total TotalType 0..1 The total amount charged for this rate including additional occupant amounts and fees.

12


RequiredPoints PointsType 0..1 Contains the number of points required to book a particular room type.

Complex Type: AuthorizationRuleType

Description

Configured rule for computing the amount to authorize.

Content Model



1..1

Code integer 0..1 The authorization rule code.

1..1

Amount CurrencyAmountType 0..1 The amount applicable to the authorization rule.

Percent double 0..1 A percentage value if the authorization rule is percentage based.

Complex Type: AvailHotelResType

Description

Hotel Reservation ID and other details associated with a given reservation. Use this type when asking for

availability when modifying an existing reservation.

Content Model



1..1

HotelReservationId UniqueID_Type 0..1 Hotel Reservation Unique ID to identify the reservation.

TimeSpan TimeSpanType 0..1 Current Arrival and Departure date of the reservation.

RatePlanCode CodeType 0..1 Reservation's Current Rate plan code.

RoomType CodeType 0..1 Reservation's Current Room Type code.

Complex Type: AvailRatePlanInfoType

Description

A collection of rate plans.

Attributes


HotelCode CodeType No Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.

13

Content Model



1..1

RatePlan RatePlanInfoType (extension)

0..* Rate plan information.

Complex Type: AvailRequestFetchInstructionsType

Description

A collection response instructions regarding additional information.

Attributes


RatePlanInfo boolean No If true, Rate Plan Code Master information will be included in the response.

RoomTypeInfo boolean No If true, Room Type Master information will be included in the response.

ResGuaranteeInfo boolean No If true, Guarantee Code information will be fetched with Rate Code Information. This attribute is only effective when RatePlanInfo is true.

Complex Type: AvailRequestSegmentType

Attributes


CRO CodeType No Central reservation office Code that is requesting Rate Availability.

ChainCode CodeType No Chain code of the Hotel whose Rate Availability is requested.

HotelCode CodeType No Hotel code of the Hotel whose Rate Availability is requested.

InitialRatePlanSet boolean No If InitialRatePlanSet is set to true, the response will return most relevant Rate Plan Set (for example, NEGOTIATED if profiles have Negotiated Rates) depending on the request. If the request does not require special Rate Plan Set, it will return default Rate Plan Set if RatePlanSet value is not set.

RatePlanSet CodeType No Rate Plan Set code to filter Rate Plans based on the predefined set. If not specified, it will not filter any Rate Plans by Rate Plan Set. When InitialRatePlanSet is true, the response may not always return Rate Plans for the supplied Rate Plan Set (See InitialRatePlanSet documentation).

MaxFetchCount integer No Maximum number of records a Web Service returns.

14


PagePointerKey string No Specifies fetched record's key as pointer to fetch additional records from. If key is composite, use comma separated string.

PageBack boolean No If true, fetch records that are prior to the key pointer provided.

IncludeClosedRates boolean No Indicates if closed rates are to be included in the Rate Plan set.

IncludeDefaultRatePlanSet boolean No Indicates if the configured default rate plan set will be included.

RedeemAwards boolean No Indicates if the awards are to be redeemed.

Content Model



1..1

RoomStay RoomStaySearchType (extension) 0..1 Room Stay detail for the Availability Request. It includes availability request time span, number of rooms requested and persons staying. Date range can also be specified by using start dates and number of nights.

MinRate CurrencyAmountType 0..1 Minimum rate amount to filter Rates for the Rate Availability Request.

MaxRate CurrencyAmountType 0..1 Maximum rate amount to filter Rates for the Rate Availability Request.

RatePlanCandidates RatePlanCandidatesType 0..1 Contains rate Plan and its classification related filters for the Rate Availability Request.

RoomStayCandidates RoomStayCandidatesType 0..1 Contains Room and its classification related filters for the Rate Availability Request.

ResGuestID UniqueID_Type 0..1 Reservation Guest's Unique ID. This element is used usually to get negotiated rates.

ResAttachedProfiles ResAttachedProfileListType 0..1 Travel Agent, Company, and Source profiles associated with the Rate Availability request. This element is used usually to get negotiated rates.

InvBlock BlockCodeIDType 0..1 Inventory Block code whose Rate Availability is requested.

HotelReservation AvailHotelResType 0..1 Hotel Reservation ID and other details associated with a given reservation. Use this element when asking for availability when modifying an existing reservation.

FetchInstructions AvailRequestFetchInstructionsType 0..1 A collection response instructions regarding additional information.

15


MembershipIDNo integer 0..1 Membership ID Number of the guest.

MembershipLevel string 0..1 Membership level of the guest’s membership.

MembershipType string 0..1 Membership Type of the guest.

SmokingPreferences SmokingPreferenceListType 0..1 Smoking Preferences to search for reservations.

Complex Type: AvailResponseMasterInfoType

Description

Availability master info type

Content Model



1..1

RoomTypes RoomTypeMasterInfoType 0..1 Collection of room type information.

RatePlans AvailRatePlanInfoType 0..1 Collection of rate plan information.

Complex Type: AvailResponseSegmentType

Attributes


RatePlanSet CodeType No Rate Plan Set whose Rate Plans are returned in the response.

HotelCode CodeType No Hotel Code whose Rate Plans are returned in the response.

Closed boolean No If the availability response has a house level restriction, this flag will be true.

Redemption boolean No Indicates if the Room Rates returned are calculated based on points.

AllRowsFetched boolean No Indicates if all the records are included in the response. Absence of the attribute values should be considered as all rows fetched in the response.

TotalRows integer No Total number of rows queried.

Content Model



1..1

RoomStays anyType (restriction) 0..1

MasterInfo AvailResponseMasterInfoType 0..1

HotelAlert StringLength2000 0..1 Hotel Alert Message.

16

Complex Type: AwardVouchersType

Content Model



1..1

AwardVoucher anyType (restriction) 0..5 Stores the Membership Awards code applied on the reservation.

Complex Type: BedTaxReportingType

Description

Stores the information for Bed Tax Reporting. Mainly used in Maldives.

Attributes


TaxRegistrationNo double No Tax Registration Number for Maldives Bed Tax Reporting.

VisaNumber StringLength40 No Visa number used for Maldives Bed Tax Reporting

VisaIssueDate date No Visa Issue Date used for Maldives Bed Tax Reporting.

VisaExpiryDate date No Visa Expiration Date used for Maldives Bed Tax Reporting.

TaxableDays integer No Number of days for which the Maldives tax is applicable.

Complex Type: BillingPrivilegesType

Description

Stores the information for Bed Tax Reporting. Mainly used in Maldives.

Attributes


PostingRestriction boolean No Flag used by interface program during check in.

PreStayCharging boolean No Indicates if the reservation has charging privileges before arrival.

PostStayCharging boolean No Indicates if the reservation has charging privileges after check-out.

FolioCloseDate date No Date when folio was closed. This works with PostStayCharging flag.

ScheduledCheckout boolean No Indicates if the guest is scheduled for automatic check-out.

ScheduledCheckoutTime date No Time of automatic check-out if the guest is scheduled for automatic check-out.

DirectBillAuthorized boolean No If Direct bill is authorized, this will hold the ID of the user who authorized it.

VideoCheckout boolean No Indicates if the guest can do video check-out.

17


AllowAutoCheckin boolean No Indicates if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only.

AutoSettlement boolean No Indicates if the guest is a candidate for auto folio settlement.

AutoSettlementType StringLength40 No The folio settlement type for auto folio settlement.

AutoSettlementFreq integer No The interval of days between each auto folio settlement.

Complex Type: BlockCodeIDType

Attributes


Code CodeType No Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.

Name StringLength2000 No Used for Character Strings, length 0 to 2000.

Content Model



1..1

UniqueID UniqueID_Type 0..1

Complex Type: BookingChannelInfoType

Attributes


BookingChannelCode CodeType Yes Channel code that sends bookings. Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.

Name StringLength40 No Channel name. Used for Character Strings, length 0 to 40.

BookingChannelType StringLength240 No Channel type code. Used for Character Strings, length 0 to 240.

Content Model



1..1

HotelMappings anyType (restriction)

0..1 Collection of Hotel Code mapping for the Booking Channel.

ConfigurationParameters ParametersType 0..1

18

Complex Type: BookingChannelMappingType

Attributes


BookingChannelCode StringLength20 Yes Used for Character Strings, length 0 to 20.

Code StringLength20 Yes Used for Character Strings, length 0 to 20.


Description StringLength2000 No Used for Character Strings, length 0 to 2000.

Complex Type: CancelPenaltyType

Description

The CancelPenalty class defines the cancellation policy of the hotel facility.

Attributes


PolicyCode CodeType No Policy Class.

Manual boolean No Indicates if the cancellation policy is manual.

Content Model



1..1

Deadline PolicyDeadlineType 0..1 Cancellation deadline, absolute or relative.

AmountPercent PolicyAmountPercentType 0..1 Cancellation fee expressed as a fixed amount, or percentage of/or room nights.

PenaltyDescription StringLength2000 0..1 Text description of the Penalty in a given language.

Complex Type: ChangeHistoryType

Description

Creation date time, Creator ID, last modification date time, and last Modifier ID.

Attributes


CreateDateTime dateTime No Time stamp of the creation.

CreatorID StringLength200 No ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.

LastModifyDateTime dateTime No Time stamp of last modification.

LastModifierID StringLength200 No Identifies the last software system or person to modify a record.

PurgeDate date No Date an item will be purged from a database (for example, from a live database to an archive).

19

Complex Type: ChangeRelationsType

Description

Detailed information regarding the changes made to relationships for the profile.

Attributes


ID StringLength80 No Relationship identifier.

Relation CodeType No Indicates the type of relationship the current profile has with the related profile.

RelationDescription StringLength200 No Displays the description of relationship the current profile has with the related profile.

TargetRelation CodeType No Displays the type of relationship the Related profile has with the current profile.

TargetRelationDescription StringLength200 No Displays the description of the target relation.

Complex Type: CharacterUDFsType

Description

Holds the collection of user-defined fields of Character/String Type.

Content Model



1..1

UDF CharacterUDFType 0..*

Complex Type: CharacterUDFType

Description

Holds user-defined field of Character/String Type.

Attributes


Name string Yes Holds user-defined field of Character Type. It is highly recommended to use UDFC01, UDFC02 and so on up to UDFC40 (Total 40) as Character/String UDF names (commonly used on Reservation and Profile). Name is not restricted using enumeration, to provide flexibility of different name usage if required.

Value string No Value of user defined field.

Complex Type: ChildAgesType

Description

Defines Children's Ages.

Content Model


20


1..1

Child ChildAgeType 0..* Age of a child in years.

Complex Type: ChildAgeType

Description

Defines Child's Age.

Attributes


Age int Yes Age of a child in years.

Complex Type: ChildBucketsType

Description

Defines children counts with Age Qualifying Group(Child Bucket) classification.

Attributes


Bucket1Count int Yes Number of children classified under the first Age Qualifying Group(Child Bucket#1).

Bucket2Count int Yes Number of children classified under the second Age Qualifying Group(Child Bucket#2).

Bucket3Count int Yes Number of children classified under the third Age Qualifying Group(Child Bucket#3).

Bucket4Count int Yes Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).

Bucket5Count int Yes Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).

Complex Type: CodeDescriptionType

Description

Contains a generic code and description information.

Attributes


Code CodeType No Code.

Description StringLength2000 No Description.

Complex Type: CommentInfoType

Description

Comment related to the profile/reservation.

Content Model


21


1..1

UniqueID UniqueID_Type 0..1 Comment ID for the comment. It will be empty in case of new comment.

Comment CommentType 0..1 Comment details for the comment. It will be empty in case of delete comment.

Complex Type: CommentType

Description

Comment related to the profile/reservation.

Attributes


Type CodeType No Specifies type of the comment.

TypeDescription StringLength200 No Comment type Description.

Internal boolean No When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.

Confidential boolean No When true, the comment may be confidential.

OverrideInternal boolean No When true, the note internal can be modified.

ProtectDescription boolean No When true, the note title will be populated from the note type description and couldn't be modified.

HotelCode CodeType No If specified, the comment belongs to the Hotel; otherwise, it is a global comment.

ActionType CodeType No Specifies type of action described in the comments.

ActionDate date No Indicates the date on which an action described in the comment must be taken.


CreatorID StringLength200 No ID of the creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation.

LastModifyDateTime dateTime No Time stamp of the last modification.



Content Model



1..1

1..1

Image string 0..1 An image for this paragraph.

Text FormattedTextTextType 0..1 Formatted text content.

22


URL string 0..1 A URL for this paragraph.

CommentTitle StringLength4000 0..1 Specifies Comment's Title.

Complex Type: CompanyType

Attributes


CurrencyCode CodeType No The code specifying a monetary unit. Use ISO 4217, three alpha code.

CurrencySymbol StringLength10 No The symbol for the currency (for example, for currencyCode USD the symbol is $).

DecimalPlaces nonNegativeInteger No Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard "minor unit". Typically used when the amount provided includes the minor unit of currency without a decimal point (for example, USD 8500 needs DecimalPlaces="2" to represent $85).

Language language No Language identification.

Nationality CodeType No Nationality code identification.

NationalityDescription StringLength80 No Nationality code description.

commissionCode CodeType No Commission code of the company.

CreditRating CodeType No Credit rating of the company.

CorporateIdType CodeType No The type of corporate ID.

VIPStatus CodeType No VIP status of the company.

VIPDescription StringLength2000 No Description of the VIP status.

Content Model



1..1

CompanyName StringLength40 0..1 Name of the company.

CompanyName2 StringLength40 0..1 Second Name of the company.

CompanyName3 StringLength40 0..1 Third Name of the company.

AlternateName StringLength40 0..1 Alternate Name of the Company. Mainly, it's the name of the company written in the Alternate Language.

AlternateLanguage CodeType 0..1 Alternate Language of the company.

BusinessLocale StringLength40 0..1 A jurisdiction (territory) in which a company is authorized to do business.

Complex Type: CountryNameType

Description

The name or code of a country (for example, as used in an address or to specify citizenship of a traveler).

23

Attributes


Code CodeType No Code for a country or a nationality.

Complex Type: CurrencyAmountType

Description

A monetary value expressed with a currency code.

Attributes


Amount Money No A monetary amount.

CurrencyCode AlphaLength3 No Provides a currency code to reflect the currency in which an amount can be expressed.

Complex Type: CurrentRoomInfoType

Description

Room information of the reservation for the current day.

Content Model



1..1

RoomType CodeType 0..1 Current room type.

RoomNumber CodeType 0..1 Current room number.

Complex Type: CustomerType

Description

Contains basic data on the customer's identity, location, relationships, finances, and memberships.

Attributes


Gender NMTOKEN (restriction)

No Identifies the gender.

BirthDate date No Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format.

BirthDateMasked string No Indicates the date of birth as masked.



24




Nationality CodeType No Nationality identification code.


CustomerValue StringLength20 No The supplier's ranking of the customer (for example, VIP, numerical ranking).

CreditRating CodeType No Credit Rating of the customer.

VIPStatus CodeType No VIP status of the customer.


BirthPlace StringLength80 No Place of birth.

ProfilePrivate boolean No This element tells profile is property exclusive or not.

Content Model



1..1

PersonName PersonNameType 1..5 Detailed name information for the customer.

CitizenCountryName CountryNameType 0..1 Name of the (self-professed) country that is claimed for citizenship.

Identifications anyType (restriction) 0..1 List of identification of the customer.

Profession StringLength80 0..1 Profession of a person.

AlienInfo AlienInfoType 0..1 Immigration/visa information of a foreign person.

BirthCountry CountryNameType 0..1 Country of birth.

LegalCompany StringLength80 0..1 Name of the company the individual is associated with.

Complex Type: DateUDFsType

Description

Holds the collection of user-defined fields of Date Type.

Content Model



1..1

UDF DateUDFType 0..*

25

Complex Type: DateUDFType

Description

Holds user-defined field of Date Type.

Attributes


Name string Yes Holds user-defined field of Date Type. It is highly recommended to use UDFD01, UDFD02 and so on up to UDFN20 (Total 20) as Date UDF names (commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.

Value date No Value of user-defined field.

Complex Type: DepositPolicyType

Description

Defines the deposit policy, guarantees policy, and/or accepted forms of payment.

Attributes


PolicyCode CodeType No Deposit Policy Code.

Manual boolean No Flag to indicate if the cancellation policy is manual.

Content Model



1..1

AmountPercent PolicyAmountPercentType 0..1 Payment expressed as a fixed amount or a percentage of/or room nights.

Deadline PolicyDeadlineType 0..1 Payment deadline, absolute or relative.

Description StringLength2000 0..1 Text description of the Payment in a given language.

Complex Type: DirectBillingType

Description

This is the preconfigured routing instruction type.

Attributes


HotelCode CodeType No Hotel Code for which the details of direct billing is provided for a profile.

ARNumber CodeType No AR number for which the detail of direct billing is provided for profile.

26

Complex Type: DiscountType

Description

Identifies and provides details about the discount. This allows for both percentages and flat amounts. If

one field is used, the other should be zero/not specified since logically.

Attributes


Percent double No Percentage discount.


CurrencyCode AlphaLength3 No Provides a currency code to reflect the currency in which an amount may be expressed.

DiscountCode CodeType No Specifies the type of discount (for example, no condition, LOS, deposit or total amount spent).

Content Model



1..1

DiscountReason StringLength2000 0..1

Complex Type: EmailInfoType

Description

Information on an email for the customer.

Content Model



1..1

UniqueID UniqueID_Type 0..1 Unique ID for the email.

Email EmailType 0..1 Email details for the profile.

Complex Type: EmailType

Description

Information on an email for the customer.

Attributes


EmailAddress StringLength2000 No Defines the email address.

Type CodeType No Defines the type of the email address (for example, personal, business, list serve).

TypeDescription StringLength2000 No Describes the Type code.

EmailFormat NMTOKEN (restriction)

No Supported email format.

27



OrderSequence double No Display order sequence.

Complex Type: ErrorsType

Description

A collection of errors that occurred during the processing of a message.

Content Model



1..1

Error ErrorType 0..99 An error that occurred during the processing of a message.

Complex Type: ErrorType

Description

Standard way to indicate that an error occurred during the processing of an OpenTravel message. If the

message successfully processes, but there are business errors, those errors should be passed in the

warning element.

Attributes


Type CodeType Yes The Error element MUST contain the Type attribute that uses a recommended set of values to indicate the error type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". Refer to OpenTravel Code List Error Warning Type (EWT).

ShortText string No An abbreviated version of the error in text format.

Code CodeType No If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to OpenTravel Code List Error Codes (ERR).

DocURL string No If present, this URL refers to an online description of the error that occurred.

Status string No If present, recommended values are those enumerated in the OTA_ErrorRS, (NotProcessed | Incomplete | Complete | Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.

28


Tag string No If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing].

RecordID string No If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction.

NodeList string No An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional constraint which contains the data of the node. This will provide the offending data back to systems that cannot maintain the original message.

Complex Type: FacilityCodesType

Description

List of the facility codes.

Content Model



1..1

FacilityCode FacilityCodeType 0..*

Complex Type: FacilityCodeType

Description

Facility Housekeeping Code, its description, and quantity.

Attributes


Code CodeType No Facility code value.

Content Model



1..1

29


Description StringLength80 0..1 Facility Code.

Quantity integer 0..1 Signifies the quantity.

Complex Type: FacilityTaskType

Description

Information regarding facility task on a reservation.

Attributes


Date date No The date on which the task is applicable.

Content Model



1..1

Task HousekeepingTaskCodeType 0..1 The Task Code.

Supplies FacilityCodesType 0..1 Supplies associated with the task.

Complex Type: FolioTextsType

Description

Stores the information the type of tax calculation especially with tax exemption.

Content Model



1..1

FolioText anyType (restriction) 0..2 Stores the description for the type of tax calculation especially with tax exemption.

Complex Type: ForeignExchangeType

Description

Foreign exchange information.

Attributes


Type CodeType No Exchange Type for the postings.

EffectiveDate date No Effective Exchange date for the foreign currency posting.

Complex Type: FormattedTextTextType

Description

Provides text and indicates if it is formatted or not.

30

Attributes


Formatted boolean No Text information, which may be formatted as a line of information, or unformatted, as a paragraph of text.


TextFormat NMTOKEN (restriction)

No Indicates the format of text used in the description (for example, unformatted or html).

Complex Type: FreeTextType

Description

Textual information to provide descriptions and/or additional information.

Attributes



Complex Type: FutureListType

Description

A collection of reservation history details attached to Profiles.

Attributes


AllRowsFetched boolean No Indicates if all the records are included in the response. Absence of the attribute values should be consider as all rows fetched in the response.


Content Model



1..1

ReservationInfo ReservationInfoType 0..* Additional reservation information attached to the profile (for example, future reservation details).

Complex Type: GdsNegotiatedInfoType

Description

Provides information for a channel negotiated rate.

Attributes




Content Model

31



1..1

AccessCode CodeType 0..1 The GDS negotiated rate code.

Order integer 0..1 The sell order.

Inactive boolean 0..1 Represents the value for GDS Negotiated Rate as inactive or not

Complex Type: GdsNegotiatedType

Description

Holds a list of GdsNegotiatedInfoType.

Attributes


BookingChannelCode CodeType No Booking Channel Code.

HotelCode CodeType No Hotel Code.

ChannelRatePlanCode CodeType No Channel Rate Type code.

Content Model



1..1

GdsNegotiatedInfoList GdsNegotiatedInfoType 0..* List of channel negotiated rates for the profile.

Complex Type: GuaranteePoliciesType

Description

A collection of Guarantee Codes information with cancellation penalty and deposit policy information.

Content Model



1..1

ResGuarantee GuaranteePolicyType 0..* Guarantee Code information with cancellation penalty and deposit policy information.

Complex Type: GuaranteePolicyType

Description

Guarantee Code information with cancellation penalty and deposit policy information.

Attributes


GuaranteeCode CodeType No Code assigned to the reservation guarantee.

32


OnHold boolean No If true, indicates this Guarantee Code is used only to hold the inventory during reservation process.

ReserveInventory boolean No If true, indicates inventory will be reserved/deducted when reservation uses this Guarantee Code.

OrderSequence double No Display Order sequence.

Content Model



1..1

Description StringLength2000 0..1 Description of the Guarantee Code.

Requirements GuaranteeRequirementsType 0..1 Specifies various requirements for the guarantee code.

ShortDescription TranslationTextType80 0..1 Brief description of the Guarantee Code.

CancelPenalty ResCancelPenaltyType (extension)

0..1 Defines the cancellation penalty of the hotel facility.

DepositPolicy ResDepositPolicyType (extension)

0..1 Defines the deposit policy, guarantees policy, and/or accepted forms of payment.

Complex Type: GuaranteeRequirementsType

Description

Specifies various requirement for the guarantee code.

Attributes


PhoneNumber boolean No When true, indicates phone number on the reservation is required for this guarantee code.

Address boolean No When true, indicates address on the reservation is required for this guarantee code.

CreditCard boolean No When true, indicates the Credit Card on the reservation is required for this guarantee code.

ArrivalTime boolean No When true, indicates the arrival Time on the reservation is required for this guarantee code.

Deposit boolean No When true, indicates deposit is required for this guarantee code.

Complex Type: GuaranteeType

Description

Specifies Guarantee Code attributes.

Attributes


GuaranteeCode CodeType No Code assigned to the Guarantee.

33





Content Model



1..1




Complex Type: GuestCountsType

Description

A collection of GuestCount by age group.

Attributes


Adults int Yes Defines the number of Adults.

Children int Yes Defines the number of Children.

Content Model



1..1

ChildAges ChildAgesType 0..1 Defines Children's Ages. Number of children ages mentioned may not match children counts.

ChildBuckets ChildBucketsType 0..1 Defines children counts with Age Qualifying Group(Child Bucket#1) classification.

Complex Type: GuestLastStayInfoType

Description

Contains last stay-related details of the guest.

Content Model



1..1

LastStayDate date 0..1 Guest's last stay date.

LastStayRoom CodeType 0..1 Room Number where the guest stayed.

34


LastStayRate CurrencyAmountType 0..1 The Rate amount of the guest's last stay.

TotalStay integer 0..1 The total number of previous stay of the guest.

Complex Type: HistoryListType

Description

A collection of reservation history details attached to Profiles.

Attributes




Content Model



1..1

ReservationInfo ReservationInfoType 0..* Additional reservation information attached to the profile (for example, history reservation details).

Complex Type: HotelChannelInfoType

Attributes


HotelCode StringLength20 Yes Hotel code. Character Strings used, length 0 to 20.

Name StringLength40 No Hotel name. Character Strings used, length 0 to 40.

Content Model



1..1

BookingChannelMappings anyType (restriction)

0..1 Collection of Booking Channels mapping for the Hotel Code.

Complex Type: HotelInterfaceType

Content Model



1..1

InterfaceId UniqueID_Type 1..1 Unique DB internal number of a Hotel Interface record.

35


HotelCode CodeType 1..1 Hotel code of the Hotel whose Rate Availability is requested.

InterfaceName StringLength40 1..1 Name of the Hotel Interface.

InterfaceType HotelInterfaceTypeType 1..1 Three letter code for each interface that identifies the interface.

Logo CodeType 1..1 Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore (_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.

MachineName StringLength80 0..1 Unique machine name of the running IFC.

Status HotelInterfaceStatusType 1..1 The current status of the IFC.

Complex Type: HotelMappingType

Attributes


HotelCode StringLength20 Yes Used for Character Strings, length 0 to 20.

Code StringLength20 Yes Used for Character Strings, length 0 to 20.



Complex Type: HousekeepingTaskCodeType

Description

Information related to a Task Code. Task Codes generate task sheets in Rooms Management.

Attributes


HotelCode CodeType No Hotel code where this task code is configured.

Code CodeType No The Code for the task.

Sequence integer No Ordering sequence for display.

Content Model



1..1

Description StringLength80 0..1 Description of the Task Code.

Instructions StringLength2000 0..1 Instructions for this Task Code.

FacilityDepartureTask boolean 0..1 Indicates if this task code is the default departure task for Facility Tasks. This requires

LinenChange boolean 0..1 Indicates if a linen change is necessary.

36

Complex Type: IdentificationInfoType

Description

Information on the identification of the customer.

Content Model



1..1

UniqueID UniqueID_Type 0..1 Unique ID of the identification.

Identification IdentificationType 0..1 Detailed information on the identification of the customer.

Complex Type: IdentificationType

Description

Identification information of the customer.

Attributes


RegisteredProperty CodeType No Property to which the identification belongs.

PrimaryInd boolean No When true, indicates primary information.


Content Model



1..1

IDType StringLength40 0..1 Identification Type (for example, passport, Driver's License).

IDNumber StringLength80 0..1 Identification Number.

IDNumberMasked StringLength80 0..1 Masked Identification Number.

IssuedCountry StringLength20 0..1 The country where Identification was issued.

IssuedDate date 0..1 Issued date of Identification.

IssuedPlace StringLength80 0..1 The place where Identification was issued.

Complex Type: IndicatorsType

Description

Collection of lamp indicators.

Content Model



1..1

Indicator IndicatorType 0..*

37

Complex Type: IndicatorType

Description

Lamp indicator Type.

Attributes


IndicatorName StringLength80 No Name of the indicator.

Count integer No Indicates number of occurrences of the indicator.

Complex Type: InterfaceRightsStatusType

Content Model



1..1

Right integer 1..1 Internal code for each allowed right of a Hotel Interface record.

StatusCode StringLength5 1..1 User defined code for an Interface Right.

Description StringLength80 0..1 User defined description for an Interface Right.

Category StringLength1 1..1 Category code of this interface right.

Complex Type: KeywordDetailType

Attributes


NewKeyword StringLength80 No The new keyword value.

Complex Type: KeywordType

Attributes


Type CodeType No The type of keyword.

Keyword StringLength80 No The keyword value.

Content Model



1..1

KeywordDetail KeywordDetailType 0..1 The keyword new value if the value is modified.

Complex Type: LastStayInfoType

Description

Contains last stay related details for the profile

Content Model

38



1..1

LastVisit date 0..1 Holds last stay information for the profile.

LastRoom string 0..1 Holds last room information for the profile.

LastRate CurrencyAmountType 0..1 Holds last rate information for the profile.

TotalStay integer 0..1 The total number of previous stay of the profile.

Complex Type: MailingActionsType

Description

Defines mailing action list for the profile.

Attributes


Active boolean No When true, indicates the profile has subscribed to the mailing list.



Content Model



1..1

MailingAction CodeDescriptionType 0..* Defines mailing action code and description.

Complex Type: MembershipInfoType

Description

The Membership object identifies the frequent customer reward program.

Attributes


ProgramCode CodeType No The code or name of the membership program ('Hertz', 'AAdvantage').

BonusCode CodeType No The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member).

MembershipTypeDesc StringLength2000 No The description of the ProgramCode (Delta Privilege for code DP).

MembershipLevelDesc StringLength2000 No The description of the Bonus Code (Platinum for code P).

AccountID StringLength50 No The account identification number for this particular member in this particular program.

39

Complex Type: MembershipType

Description

Detailed information of the memberships.

Attributes


MembershipID string No Card Number of the membership.

ProgramID string No Type of membership.

PrimaryMembershipYn StringLength1 No Indicator if Membership is a Primary Membership.

MembershipIDNo integer No Membership ID Number.

SignupDate date No Indicates when the member signed up for the loyalty program.

EffectiveDate date No Indicates the starting date.

ExpireDate date No Indicates the ending date.

ExpireDateExclusiveIndicator boolean No When true, indicates the ExpireDate is the first day after the applicable period (for example, when expire date is Oct 15 the last date of the period is Oct 14).


Content Model



1..1

Comment ParagraphType 0..1 Additional comments regarding to the membership.

NewMembershipID string 0..1 Card Number of the membership.

NameOnCard string 0..1 Name to be displayed on the membership card.

ProgramDescription string 0..1 Description of the membership program.

MembershipLevel string 0..1 Indicates the membership level.

MembershipLevelDescription StringLength200 0..1 Indicates the membership level description.

MembershipClass string 0..1 Indicates the membership class.

EarningPreference MembershipEarningPreferenceType 0..1 Earning preference to the membership.

Inactive boolean 0..1 Indicates whether membership is active or inactive.

40

Complex Type: NegotiatedInfoType

Description

Provides information for a profile negotiated rate.

Attributes




Content Model



1..1

CorporateAgreementId StringLength80 0..1 The master identifier for multiple offices/locations under the same company profile. This is optional.

ComissionCode CodeType 0..1 Commission code. Informational purposes only in numeric format.


Inactive boolean 0..1 Indicates if the Negotiated Rate is inactive.

Complex Type: NegotiatedType

Description

Holds a list of NegotiatedInfoType.

Attributes


HotelCode CodeType No Hotel code for the negotiated rate.

RateCode CodeType No Rate plan code for the negotiated rate.

Content Model



1..1

NegotiatedInfoList NegotiatedInfoType 0..*

Complex Type: NumericUDFsType

Description

Holds a collection of user defined fields of Numeric Type.

Content Model



1..1

41


UDF NumericUDFType 0..*

Complex Type: NumericUDFType

Description

Holds user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02 and so on

up to UDFN40 (Total 40) as Numeric UDF names (commonly used on Reservation, Profile). Name is not

restricted using enumeration, to provide flexibility of different name usage if required.

Attributes


Name string Yes Name of user defined field.

Value double No Value of user defined field.

Complex Type: OperaContextType

Description

Common instructions coming with all the messages to set certain context in OPERA Database before

serving message request.

Content Model



1..1

UserLanguage language 0..1 User's language code.

CROCode CodeType 0..1 Central Reservation office (CRO) code.

HotelCode CodeType 0..1 Hotel code.

Language CodeType 0..1 Hotel's language code.

RunningApplication StringLength3 0..1 Running Application. (Not supported)

TerminalId StringLength128 0..1 Terminal ID from where this request originated.

LogLevel LogLevelType 0..1 Log level to debug the code, such as FINE, FINER.

ExternalSystem StringLength80 1..1 External system code.

Override boolean 0..1 Opera context is derived internally by request but in case client wants to override the Opera Context it can send true and then the OperaContext will override settings such as HotelCode.

TargetExternalSystem StringLength80 0..1 This element carries ID of the External System that serves this request. It is needed only while making a call to External WebServices from the OPERA UI through integration.

UseLocal boolean 0..1 Determines if the local system should be used and the external system ignored.

Complex Type: OperaWebServiceRQBaseType

Description

42

This Request base type is used as a base for an extension for OPERA Web Services Requests to provide

uniform implementation.

Attributes


EchoToken StringLength128 No A reference for additional message identification assigned by the requesting host system. When a request message includes an echo token, the corresponding response message must include an echo token with an identical value.

TimeStamp dateTime No Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ssZ with time values using the 24 hour clock (for example, 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).

Version StringLength40 No For all OPERA versioned messages, the version of the message is indicated by an OPERA Version value.

CorrelationID StringLength80 No Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.

Content Model



1..1

OperaContext OperaContextType 0..1 Refer to Generic common types document.

Complex Type: OperaWebServiceRSBaseType

Description

This Response base type is used as a base for an extension for OPERA Web Services Responses to provide

uniform implementation.

Attributes




43



CorrelationID StringLength80 No Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.

Content Model



1..1

1..1

Errors ErrorsType 0..1 Refer to Generic common types document.

1..1

Success SuccessType 0..1 Refer to Generic common types document.

Warnings WarningsType 0..1 Refer to Generic common types document.

Complex Type: PackageElementType

Attributes


PackageCode string Yes

CalculationRule string No

PostingRhythm string No

Quantity int No

IncludedInRate boolean No

AddRateSeprateLine boolean No

AddRateCombinedLine boolean No

StartTime time No

EndTime time No

SellSeparate boolean No

Content Model



1..1

Amount CurrencyAmountType 0..1

Allowance CurrencyAmountType 0..1

Description StringLength2000 0..*

StartDate date 0..1

EndDate date 0..1

44

Complex Type: ParagraphType

Description

An indication of a new paragraph for a sub-section of a formatted text message.

Content Model



1..1

1..1




Complex Type: ParametersType

Description

List of Generic Name-Value-Pair Parameters.

Content Model



1..1

Parameter ParameterType 0..* Collection of generic Name-Value-Pair parameters.

Complex Type: ParameterType

Description

Name value pair type that will hold generic parameter information. Only use this type when the

parameters being passed are too dynamic to be defined.

Content Model



1..1

ParameterName string 0..1 Name of the parameter.

ParameterValue string 0..1 Value of the parameter.

Complex Type: PersonNameType

Description

Provides name information for a person.

Attributes


NameType PersonNameTypeType No Type of name of the individual, such as former, nickname, alternate or alias name.

45


Language CodeType No Language code associated with an alternate name.

ExternalSystem StringLength40 No When name type is external, indicates the external system to which the name belongs.

Content Model



1..1

NamePrefix StringLength40 0..1 Salutation of honorific (for example, Mr., Mrs., Ms., Miss, Dr.).

GivenName StringLength40 0..1 Given name, first name or names.

MiddleName StringLength40 0..1 The middle name of the person name.

Surname StringLength40 0..1 Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts (for example, the surname element may be used to pass the full name).

NameSuffix StringLength40 0..1 Holds various name suffixes and letters (for example, Jr., Sr., III, Ret., Esq.).

NameTitle StringLength80 0..1 Degree or honors (for example, Ph.D., M.D.).

NameTitleSuffix integer 0..1 Title Suffix. Must be populated if ADVANCED_TITLE is on.

EnvelopeGreeting string 0..1 Envelope Greeting of the profile.

Salutation string 0..1 Salutation of the profile.

Complex Type: PointsType

Description

The Redeem Points contains the number of points required to book a room type.

Attributes


AwardsType string No Awards type for the award type rate code.

Points integer No Number of points required to book this Room Stay.

Complex Type: PolicyAmountPercentType

Description

Defines the percentage basis for calculating the fee amount or the amount.

Attributes


BasisType PolicyBasisTypeType No Provides the basis for how the amount of the guarantee is calculated.

46


Nights integer No The number of nights of the hotel stay that are used to calculate the fee amount.

Percent Percentage No The percentage used to calculate the amount.



Complex Type: PolicyDeadlineType

Description

Cancellation deadline, absolute or relative.

Attributes


AbsoluteDeadline date No Defines the absolute deadline. Either this or the offset attributes may be used.

OffsetFromArrival integer No The number of days before arrival that allows cancellation without penalties.

OffsetDropTime dateTime No Time on offset day the cancellation penalties applies.

OffsetFromBookingDate integer No The number of days after booking deposit must be paid.

Complex Type: PreferenceType

Description

Guest Preference details for the profile.

Attributes


PreferenceId CodeType No Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.

Content Model



1..1

PrefValue StringLength200 0..1 Preference value for display purposes.

Description StringLength2000 0..1 Preference Description for display purposes.

Global boolean 0..1 Whether this preference is property specific or not.

Source StringLength40 0..1 Source of the preference.

Hotels CodeType 0..* If specified preference belongs to the Hotels listed; otherwise, it is a global preference.

47

Complex Type: PreferenceTypeType

Description

Preference details for the profile.

Attributes


PrefType CodeType No Preference group code.

PrefTypeDescription string No Preference group description.

OrderValue string No Preference Sequence.

MaxQuantity integer No Maximum quantity of preferences allowed per preference group.

AvailableQuantity integer No Available quantity of preferences (maximum quantity - Existing preferences) per preference group.

MaxResortUsedQuantity integer No Maximum quantity of preferences used by any resort per preference group.

ReservationPreference boolean No Whether this preference is reservation preference or not.

Content Model



1..1

Preference PreferenceType 0..* Collection of Preferences for the profile.

Complex Type: PrivacyInfoType

Description

Defines Privacy related information for the profile.

Attributes


MarketResearchParticipation boolean No Indicates if the profile participates in market research.

InfoFromThirdParty boolean No Indicates if the profile accepts information from third parties.

AutoEnrollLoyaltyProgram boolean No Indicates if the profile wants to be automatically enrolled in the property's loyalty program.

AllowPhone boolean No Indicates if the profile wants to allow phone calls.

AllowSMS boolean No Indicates if the profile wants to allow SMS.

AllowEmail boolean No Indicates if the profile wants to allow email.

OptInMailingList boolean No Indicates if the profile wants to opt in for Mailing List.

48


OptInMarketResearch boolean No Indicates if the profile wants to opt in for Market Research.

OptInThirdParty boolean No Indicates if the profile wants to opt in for Third Party.

OptInAutoEnrollmentMember boolean No Indicates if the profile wants to opt in for Auto Enrollment Member.

OptInPhone boolean No Indicates if the profile wants to opt in for Phone.

OptInSms boolean No Indicates if the profile wants to opt in for SMS.

OptInEmail boolean No Indicates if the profile wants to opt in for email.

Complex Type: ProfileAccessType

Attributes


SharedLevel ProfileSharedLevelType No Indicates if the profile is shared at the following levels: global/property/CRO.

Content Model



1..1

ChainCode StringLength200 0..1 Indicates the Chain code where the profile was created.

CROCode StringLength200 0..1 Indicates the CRO code where the profile was created.

HotelCode StringLength200 0..1 Indicates the Hotel code where the profile was created.

Complex Type: ProfileCashieringType

Description

Contains cashiering related details for the profile.

Attributes




49



Content Model



1..1

DirectBillingList anyType (restriction)

0..1 List of direct billing related information for the profile.

AutoFolioSettlementType StringLength40 0..1 Contains the auto folio settlement type for the profile.

PaymentDueDays integer 0..1 Ability to define on the account the number of days after which the invoice should be paid.

Complex Type: ProfileCommissionType

Description

This is the preconfigured routing instruction type.

Attributes


HotelCode CodeType No Hotel Code for the commission used for a profile.

CommissionCode CodeType No Commission Code for a profile.

BankAccount CodeType No Bank account used for the commission for a profile.




Complex Type: ProfileMembershipType

Description

Memberships related to the profile.

Attributes


MembershipID string No Card number of the membership.

50




MembershipIDNo integer No Membership ID number.




ExpireDateExclusiveIndicator boolean No When true, indicates that the ExpireDate is the first day after the applicable period (for example when expire date is Oct 15 the last date of the period is Oct 14).


Content Model



1..1

Comment ParagraphType 0..1 Additional comments regarding the membership.

NewMembershipID string 0..1 Card number of the membership.








Complex Type: ProfileRestrictions

Attributes


Restricted boolean Yes True value indicates there are restrictions associated with the current profile.

Content Model

51



1..1

Reason CodeType 0..1 Restriction reason associated with the current profile.

ReasonDescription StringLength2000 0..1 Description of restriction reason.

Complex Type: ProfileTaxInfoType

Description

Profile information related to tax.

Content Model



1..1

Tax1No StringLength40 0..1 The tax ID of this profile. Usually issued by a government agency. Used by 1099 printing.

Tax2No StringLength40 0..1 Tax 2 ID of this profile.

TaxOffice StringLength30 0..1 Tax Office name of this profile.

Complex Type: ProfileType

Description

Type provides the detailed information about the profile and its children.

Attributes


ProfileType ProfileTypeType No Type of profile such as Guest, Agent, Company, Group, Source, Employee, Hotel, Vendor or Contact.

StatusCode ProfileStatusType No Status of the profile—Active/Inactive.

RegisteredProperty CodeType No Hotel which this profile is registered with. This attribute is not used for configuration.

RequestForHotel CodeType No Hotel which this profile is to be registered. This attribute is only used during creation of profile.

ProtectedBy StringLength40 No What level this profile is protected.


CreatorID StringLength200 No ID of the creator. The creator could be a software system identifier or an identifier of an employee resposible for the creation.




52


MarkAsRecentlyAccessed boolean No Mark this profile as recently accessed.

MarkForHistory boolean No True value marks the profile to be kept from being purged once the profile is marked inactive.

hasCommission boolean No Populates true if the profile has commission configured false otherwise.

Content Model



1..1

1..1

Company CompanyType 0..1 Detailed company information for this profile.

Customer CustomerType 0..1 Detailed customer information for this profile.

Addresses anyType (restriction) 0..1 List of customer addresses.

BusinessSegments anyType (restriction) 0..1 Business/Market Segments associated with the profile.

Territory StringLength40 0..1 Territory associated to the profile.

TraceCode StringLength40 0..1 Trace Code associated to the profile.

InfluenceCode StringLength40 0..1 Influence Code associated to the profile.

Telephones anyType (restriction) 0..1 List of telephone number information.

Emails anyType (restriction) 0..1 List of email address for the customer.

URLs anyType (restriction) 0..1 List of Information on a URL for the customer.

Comments anyType (restriction) 0..1 List of Notes for the customer.

ProfileMemberships anyType (restriction) 0..1 List of loyalty program(s) the profile subscribes to.

PreferenceCollection anyType (restriction) 0..1 List of customer preferences.

Keywords anyType (restriction) 0..1 List of customer keywords.

NegotiatedRates anyType (restriction) 0..1 List of profile negotiated rates.

GdsNegotiatedRates anyType (restriction) 0..1 List of channel negotiated rates that this profile has been assigned to.

ProfileIndicators IndicatorsType 0..1 Indicators of additional information attached to the profile.

Relationships anyType (restriction) 0..1 Contains a collection of profiles that have a relationship with this profile.

ReservationInfoList ReservationHistoryFutureInfoType 0..1 Collection of Detailed information on history and future reservations associated with the profile.

LastStayInfo LastStayInfoType 0..1 Information on last stay of the profile.

53


ProfileAccessType ProfileAccessType 0..1 Detailed information on access type associated with the profile.

ProfileRestrictions ProfileRestrictions 0..1 Detailed information on restrictions associated with the profile.

MailingActions MailingActionsType 0..1 Contains collection of mailing action list associated with the profile

PrivacyInfo PrivacyInfoType 0..1 Contains privacy related information associated with the profile.

Cashiering ProfileCashieringType 0..1 Contains cashiering related details for the profile.

CommissionInfoList anyType (restriction) 0..1 List of commission details for the profile. Only available for account profiles such as Travel agent and source.

UserDefinedFields UserDefinedFieldsType 0..1 Collections of user defined fields.

WebUserAccounts WebUserAccountsType 0..1 List of Web User Accounts of the profile.

TaxInfo ProfileTaxInfoType 0..1 Profile information about tax.

SalesInfo SalesInfoType 0..1 Sales information of the profiles.

Complex Type: PromotionsType

Description

Collection of rate promotions. Usually attached to a reservation to indicate specific promotions applied to

the reservation.

Content Model



1..1

Promotion PromotionType 0..* Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.

Complex Type: PromotionType

Description

Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is

applied to the reservation.

Attributes


PromotionCode CodeType No Promotion code associated with the rate plan.

CouponCode StringLength40 No Promotion Coupon Code when promotion is set up to have a valid coupon code.

54

Complex Type: QualifyingProfileType

Description

Specifies Company or Travel Agent profile using IATA or Corp. Number.

Attributes


QualifyingProfileCategory StringLength20 No Used for Character Strings, length 0 to 20.

QualifyingProfileId StringLength20 No Used for Character Strings, length 0 to 20.

Complex Type: RatePlanCandidatesType

Attributes


RateCategory CodeType No Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.

RateClass CodeType No Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.

RateGroup CodeType No Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.

PrevailingRate boolean No

ElectronicCertificate StringLength40 No Used for Character Strings, length 0 to 40.

Content Model



1..1

RatePlanDescription StringLength2000 0..1 Rate Plan Description string to filter rate plans.

RatePlans anyType (restriction) 0..1

Promotions PromotionsType 0..1 Promotion Codes to fetch Rate Plans associated with the promotions.

Complex Type: RatePlanCommissionType

Content Model



1..1

CommissionCode CodeType 0..1 Commission code used by the rate plan.

CommissionPercentage double 0..1 Commission percentage used by the rate plan.

Complex Type: RatePlanInfoType

Attributes

55


RatePlanCode StringLength20 No Used for Character Strings, length 0 to 20.

HotelCode StringLength20 No Used for Character Strings, length 0 to 20.

RatePlanCategory StringLength20 No Used for Character Strings, length 0 to 20.

Content Model



1..1

ShortInfo StringLength2000 0..1 Brief Information of the Rate Code.

LongInfo StringLength2000 0..1 Detail Information of the Rate Code.

WebPage StringLength2000 0..1 URL providing more information about the Rate Code.

Description StringLength2000 0..1 Description of the Rate Code.

CurrencyCode CodeType 1..1 Currency Code of the rate code.


0..1 Collection of Booking Channels mapping for the Rate Plan Code.

Complex Type: RatesType

Description

Individual rate amount.

Content Model



1..1

Rate AmountType 0..* The Rate contains a collection of elements that define the amount of the rate, associated fees, additional occupant amounts. Taxes can be broken out or included within the various amounts. A currency can be associated to each amount.

Complex Type: RegionalParityGroupType

Description

Channels and Property Group wise Rates for Room Type and Rate Plan combination.

Attributes


HotelCode StringLength20 No The code that identifies a Hotel.

BookingChannelCode StringLength20 No The code that identifies a Booking Channel.

BookingChannelURL StringLength2000 No Used for Character Strings, length 0 to 2000.

BookingChannelIconURL StringLength2000 No Used for Character Strings, length 0 to 2000.

Content Model

56



1..1

RegionalParityRates anyType (restriction) 0..1 Collection of Minimum and Maximum Rates for different Arrival Dates.

Complex Type: RegionalParityRateType

Description

Rate on specific arrival date.

Attributes


ArrivalDate date Yes Arrival Date.

WeekendDay boolean No

CurrencyCode AlphaLength3 No Used for an Alpha String, length exactly 3.

StatusCode StringLength80 No Status Code related to functionality.

StatusDescription StringLength2000 No Description of Status Code.

Content Model



1..1

MinimumRate Money 0..1

MaximumRate Money 0..1

Complex Type: RegionalRateParityFilterType

Description

Filter to restrict the Rate Parity result to supplied codes.

Content Model



1..1

Hotels anyType (restriction) 0..1

BookingChannels anyType (restriction) 0..1


ChannelRatePlans anyType (restriction) 0..1

Cities anyType (restriction) 0..1

Regions anyType (restriction) 0..1

ChainCode StringLength20 0..1

RateAccessCode StringLength20 0..1

QualifyingProfile QualifyingProfileType 0..1

57

Complex Type: RegionalRateParitySearchType

Description

Search Criteria to fetch the Rate Parity.

Attributes


ComparisonType string Yes An enumerated type defining the Parity Comparison type. Values: FIRST_RATES, CHANNEL_RATES. CHANNEL_RATES requires HotelCode and BookingChannelCode as part of request.

CurrencyCode AlphaLength3 No Used for an Alpha String, length exactly 3.

NumberOfDays integer Yes


MaxFetchCount integer No Indicates maximum number of records a Web Service should return.

Content Model



1..1

HotelCode StringLength20 0..1

BookingChannelCode StringLength20 0..1

Arrival date 0..1

Adults integer 0..1

Nights integer 0..1

Children integer 0..1

RegionalRateParityFilter RegionalRateParityFilterType 0..1

Complex Type: RegionalRateParityType

Description

Information on Room Rate Parity among Channels/Property.

Attributes




Content Model



1..1

58


RegionalParityGroups anyType (restriction) 0..1 Collection of Channels and Property combinations.

HotelsInfo anyType (restriction) 0..1

BookingChannelsInfo anyType (restriction) 0..1

Complex Type: RelationshipInfoType

Description

Relationship Type contains information about the associations between and among individuals,

companies, travel agents, groups, sources, and contact profiles.

Attributes







Content Model



1..1

ChangeRelationship ChangeRelationsType 0..1 Information about the changes in relationship for the profile.

RelationshipProfile RelationshipProfileType 0..1 Refer to Relationship Profile type document.

Complex Type: RelationshipProfileType

Attributes


Primary CodeType No Indicates if this relationship is the primary relationship.




Content Model



1..1

59


1..1

Company CompanyType 0..1 Detailed information of the Company.

Customer CustomerType 0..1 Detailed information of the customer.

Telephone TelephoneInfoType 0..1 Information on telephone details for the customer/company.

Address AddressInfoType 0..1 Information on address details for the customer/company.

Email EmailInfoType 0..1 Information on email address for the customer/company.

URLs URLInfoType 0..1 Information on web URL/address for the customer/company.

ProfileIDList UniqueIDListType 0..1 Original profile details for which the relationships was created.

ChangeProfileIDList UniqueIDListType 0..1 Updated/changed profile details for the relationships created.

Complex Type: ResAccompanyGuestInfoType

Content Model



1..1

FirstName string 0..1 Given name, first name or names

LastName string 0..1 Family name, last name.

FullName string 0..1 String representation of the full name

RegistrationCardNo StringLength40 0..1 Unique identifier of the police registration card number.

ProfileIDList UniqueIDListType (extension)

0..1

Complex Type: ResAccompanyGuestListType

Description

Collection of accompany guests.

Content Model



1..1

AccompanyGuest ResAccompanyGuestInfoType 0..*

Complex Type: ResAttachedProfileListType

Content Model


60


1..1

AttachedProfile ResAttachedProfileType 0..*

Complex Type: ResAttachedProfileType

Attributes


ResProfileType ResProfileTypeType No

Content Model



1..1

Name string 0..1 Attached profile name.


0..1

Complex Type: ResAwardsType

Description

Membership Awards code applied on the reservation.

Attributes


OriginalRoomType CodeType No Room Type before the Upgrade Award.

UpgradeRoomType StringLength20 No Room Type after the Upgrade Award.

Content Model



1..1

MembershipNo UniqueID_Type 0..1 Membership program under which the award is applied.

AwardVouchers AwardVouchersType 0..1

Complex Type: ResCancelPenaltyType

Description

The CancelPenalty class defines the cancellation policy of the hotel facility.

Attributes


Effective boolean No Indicator if Cancellation Penalty is currently applicable or not.


61



Content Model



1..1


AmountPercent PolicyAmountPercentType 0..1 Cancellation fee expressed as a fixed amount or percentage of/or room nights.


Complex Type: ResCashieringType

Description

Cashiering Information for the reservation.

Attributes


FinanciallyResponsible boolean No The guest from whom payment has to be recovered (direct guest).

ProratedBilling boolean No In case of Apartment style billing, indicates if a prorated amount should be used for an Apartment Style Billing rate.

LastRoomAndTaxPostedDate date No Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing.

ReverseCheckInAllowed boolean No Verifies if reverse check-in is allowed for the reservation.

TransactionsPosted boolean No Specifies if the reservation has a financial transaction associated with it.

Content Model



1..1

RevenuesAndBalances ResRevenueBalanceType 0..1 Revenues and Balances Amount summary for the reservation.

BillingPrivileges BillingPrivilegesType 0..1 Billing privileges set on the reservation.

TaxType ReservationTaxTypeInfo 0..1 Stores the code for the type of tax calculation, especially with tax exemption.

62


BedTaxReporting BedTaxReportingType 0..1 Stores the information for Bed Tax Reporting. Mainly used in Maldives.

FolioTexts FolioTextsType 0..1 Additional text fields to display on the folio.

PeriodicFolio ResPeriodicFolioType 0..1 Information regarding periodic folios set on the reservation.

CompAccounting ResCompAccountingType 0..1 Information regarding comp accounting on the reservation.

ResPreConfiguredRoutingInstruction ResPreConfiguredRoutingInstrType 0..1 Information regarding the selected preconfigured routing instruction on the reservation.

Complex Type: ResCompAccountingType

Description

Information regarding comp accounting on the reservation.

Attributes


CompType CodeType No Code used to identify the casino comp type and ranking of a guest.

Authorizer StringLength40 No ID of the employee who will act as the host for this guest.

Complex Type: ResDepositPolicyType

Description

A deposit policy attached with the reservation.

Content Model



1..1

RevenueType DepositCancelRevenueType 0..1 Type of reservation.

Policy DepositPolicyType 0..1 Reservation deposit policy details.

Comments StringLength2000 0..1 Comments attached with a deposit.

AmountPaid CurrencyAmountType 0..1 Total amount paid against the reservation deposit.

AmountDue CurrencyAmountType 0..1 Total amount due against the reservation deposit.

PolicyID UniqueID_Type 0..1 Unique ID of the Reservation Policy.

63

Complex Type: ReservationAllowedActionsType

Content Model



1..1

AllowedAction ReservationAllowedActionType 0..11 Allowed action.

Complex Type: ReservationBlockType

Description

Key information about the block for a reservation.

Attributes


HotelCode CodeType No This is the HotelCode of the Block.

Content Model



1..1

BlockIDList UniqueIDListType (extension)

0..1

BlockName StringLength40 0..1 The Name of the block that is attached to the reservation.

Complex Type: ReservationDepositType

Description

Reservation Deposit Type.

Attributes


HasPaid boolean No Resolves whether reservation has paid deposit.

HasOutstanding boolean No Resolves whether reservation has outstanding deposit.

Content Model



1..1

AmountRequired Money 0..1 Deposit Amount Required.

AmountPaid Money 0..1 Deposit Amount Paid.

AmountOwed Money 0..1 Deposit Amount Owed.

DueDate date 0..1 Deposit Due Date.

PostingDate date 0..1 Deposit Posting Date.

64

Complex Type: ReservationHistoryFutureInfoType

Description

Information of History and Future Reservation details attached to Profiles.

Content Model



1..1

HistoryList HistoryListType 0..1 Refer to History list type document.

FutureList FutureListType 0..1 Refer to Future list type document.

Complex Type: ReservationInfoType

Description

The Reservation class contains the current reservation being created or altered.

Attributes



HotelName StringLength80 No Used for Character Strings, length 0 to 80.

RoomStayReservation boolean No Boolean True if this reservation is reserving rooms. False if it is only reserving services.






ResStatus PMS_ResStatusType No Indicates the status of the reservation.

ComputedResStatus PMS_ResStatusType No Indicates the status of the reservation.

WalkInIndicator boolean No When true, indicates the reservation is for a guest that walks in without a reservation. When false, the reservation is not a walk-in.

AccessRestriction ResAccessRestrictionType No Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation, or both.

CommissionPayoutTo CommissionPayoutToType No If not null, reservation is considered to pay out commission to either Travel Agent, Source or both.

65


PaymentMethod CodeType No Payment Method.

PreRegistered boolean No Defines if the reservation is pre-registered or not.

OpenFolio boolean No Returns true when reservation has an open folio.

AllowMobileCheckout boolean No Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device. Pass the ‘true’ or ‘false’ values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false.

AllowMobileViewFolio boolean No Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device.

Content Model



1..1

ReservationIDList UniqueIDListType (extension) 0..1

RoomStay StayInfoType 0..1 Collection of room stays.

ResGuest ResGuestInfoType 0..1 Collection of guests associated with the reservation.

SharedGuests ResSharedGuestListType 0..1 Collection of guests who share this reservation.

AttachedProfiles ResAttachedProfileListType 0..1 List of attached profiles.

ReservationPaymentMethod ReservationPaymentMethodType 0..1 Payment method used for this reservation.

Specials StringLength4000 0..1 Set of reservation preferences that belongs to the Specials group.

DisplayColor CodeType 0..1 Color setting of the reservation.

ReservationIndicators IndicatorsType 0..1 Indicators of additional information attached to the reservation.

RoomStatus HousekeepingRoomStatusType 0..1 Current room status.

SearchMatches SearchMatchesType 0..1 Super Search matching terms.

SourceOfSale SourceOfSaleType 0..1 Point of Sale of reservation. Identifies the entity/channel who made the reservation.

66


Waitlist WaitlistResType 0..1 Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore.

Queue ReservationQueueInformationType 0..1 Information about the time and duration this reservation was on Queue for Checkin.

Housekeeping ResHousekeepingType 0..1 Information regarding housekeeping for this reservation.

Cashiering ResCashieringType 0..1 Holds cashiering related information for the reservation.

TaxType TaxTypeType 0..1 Stores the code for the type of tax calculation, especially with tax exemption.

Deposit ReservationDepositType 0..1 Holds reservation deposit information.

AllowedActions ReservationAllowedActionsType 0..1 Collection of reservation allowed actions.


HotelInterfaceStatusList ReservationInterfaceStatusType 0..* Collection of Hotel Interfaces and rights. Populated only when fetching interface status for rooms.

GuestPreferredCurrency CodeType 0..1 Currency code preferred by guest.

TurndownInfo ReservationTurndownInfoType 0..1 Currency code preferred by guest.

LastPrivacyPromptDate date 0..1 Last Privacy Prompt Date.

Complex Type: ReservationInterfaceStatusType

Description

Hotel Interface Type for a reservation and status of the various services

Content Model



1..1

RoomExtension StringLength20 1..1 Identifier for the room extension.

HotelInterface HotelInterfaceType 1..1 Hotel interface information for the reservation.

67


InterfaceRights InterfaceRightsStatusType 0..* Contains a list of status/rights for the various services under this interface.

Complex Type: ReservationPaymentMethodType

Attributes


PaymentMethod CodeType No Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.


FolioView integer No

Content Model



1..1

PaymentCard ResPaymentCardType 0..1

Balance CurrencyAmountType 0..1

AuthorizationRule AuthorizationRuleType 0..1

EmailFolioInfo EmailInfoType (extension)

0..1 Information element for Email Folio functionality.

Complex Type: ReservationQueueInformationType

Description

Information regarding the Date, Duration and Priority of the reservation on Queue for Check-in.

Attributes


Priority integer No The Queue Priority given to this reservation.

AvgQueueTimeToCheckIn integer No The average time, in seconds, a reservation was on queue prior to Check-In.

AvgQueueTimeCurrentReservations integer No The average time, in seconds, of the reservations currently in queue.

QueueDate date No The Business date on which the reservation was due to arrive and is currently placed on Queue for Check-In.

Content Model



1..1

68


TimeSpan TimeSpanType (extension)

1..1 Start and End times on the Queue for the reservation.

Complex Type: ReservationTaxTypeInfo

Description

Stores the information the type of tax calculation, especially with tax exemption.

Attributes


TaxExemptNo StringLength20 No Tax exempt number on the profile.

Content Model



1..1

HotelCode CodeType 0..1 Code of the Hotel.

Code CodeType 0..1 Code of the Tax Type.

Description StringLength2000 0..1 Description of the Tax Type.

CollectingAgentTax boolean 1..1 A boolean flag for Collecting Agent Tax.

PrintAutoAdjust boolean 1..1 Print auto adjust information for this tax type on the tax exempt report.

ReportExemptDays integer 1..1 Number of days after which the guest will be tax exempt. Only used for tax exempt report.

ReportTaxPerc Percentage 1..1 Tax percentage. Only used for tax exempt report.

Complex Type: ReservationTurndownInfoType

Description

Turndown information for a reservation.

Content Model



1..1

Allowed boolean 0..1 Indicates if turndown is allowed.

Status TurndownStatusType 0..1 Indicates turndown status, values could be required, not required, completed.

Complex Type: ResExpectedTimesType

Description

Holds the Arrival and Departure Time Information.

Attributes

69


ResExpectedArrivalTime dateTime No Arrival Time.

ResExpectedDepartureTime dateTime No Departure Time.

Complex Type: ResGuaranteeType

Description

Validations type record returned after Validations are done.

Attributes


GuaranteeCode CodeType No Guarantee Code.

ShortDescription StringLength80 No Guarantee Code.

OnHold boolean No Guarantee Code.

Complex Type: ResGuestExternalInfoType

Description


Content Model



1..1

GivenName GivenNameType 0..1 Given name, first name or names.

Surname SurnameType 0..1 Family name, last name.

Complex Type: ResGuestInfoType

Description


Attributes


NameType NameTypeType No

Content Model



1..1

UniqueID UniqueID_Type 0..1 Unique identifier of this reservation guest.

Membership MembershipInfoType 0..1 The Membership object identifying the frequent customer reward program.

70


NamePrefix NamePrefixType 0..1 Salutation of honorific (for example, Mr. Mrs., Ms., Miss, Dr.).


AltGivenName StringLength40 0..1 Alternate given name, first name or names.


SurnamePrefix StringLength20 0..1 For example, "van der", "von", "de".


AltSurname StringLength40 0..1 Alternate family name, last name.

NameSuffix StringLength20 0..1 Hold various name suffixes and letters (for example, Jr., Sr., III, Ret., Esq.).


FullName string 0..1 Full display name.

AltFullName string 0..1 Altername full display name.

PhoneNumber PhoneNumberType 0..1 Phone number.

Email BasicEmailType 0..1 Email address.

BirthDate date 0..1 Date of birth.

Language LanguageType 0..1 Default language.

Nationality CountryNameType 0..1 Affiliation or ethnicity to a particular country.

VIP VIPType 0..1 The supplier's ranking of the customer (for example, VIP, numerical ranking).

Address AddressSearchType 0..1 Address information that is attached to the reservation guest.

AccompanyGuests ResAccompanyGuestListType 0..1 List of guest names that are accompanying the reservation guest.

ExternalInfo ResGuestExternalInfoType 0..1 External information about the guest associated with the reservation.

GuestLastStayInfo GuestLastStayInfoType 0..1 Contains information regarding the last stay of this guest.

GuestRestrictedCode string 1..1 Guest profile restricted reason code.

GuestRestrictedReasonDesc string 1..1 Guest profile restricted reason description.

GuestRestricted boolean 1..1 True indicates there are restrictions associated with the current profile.


71

Complex Type: ResHousekeepingType

Description

Holds housekeeping turndown service information for the room.

Attributes


TurndownRequested boolean No Indicates whether guest wants turndown facility or not.

ServiceTime date No This is the Turndown room service time.

ExpectedServiceTime time No Expected Start Time for housekeeping task(s).

RoomStatus HousekeepingRoomStatusType No Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house.

Content Model



1..1

Instructions string 0..1 Turndown instructions for the room.

FacilityTaskInfo FacilityTaskType 0..1 The facility task applicable for the current day. This will be information only and not used for any updates.


Complex Type: ResPaymentCardType

Description

Information on a credit card for the customer.

Attributes


CardType CardTypeType No Indicates the type of credit card.

CardNumber StringLength80 No Used for Character Strings, length 0 to 80.

CardNumberMasked StringLength80 No Used for Character Strings, length 0 to 80.

ExpirationDate date No Expiration date of the credit card.

ExpirationDateMasked StringLength20 No Masked Expiration date of the credit card.

ExpirationDateExpired boolean No

CardHolderName StringLength200 No Used for Character Strings, length 0 to 200.

AttachCreditCardToProfile boolean No Attach the credit card to profile.

Processing CardProcessingType No This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type.

72


Swiped boolean No

CardNumberType CardNumberTypeType No This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type.

Content Model



1..1

CardId UniqueID_Type 0..1 Credit card ID.

CurrentAuthorizedAmount CurrencyAmountType 0..1

ApprovalAmountNeeded CurrencyAmountType 0..1

Complex Type: ResPeriodicFolioType

Description

Information regarding periodic folios set on the reservation.

Attributes


LastSettlementDate date No Latest date when a direct bill settlement was automatically done using the "Direct Bill Batch Folios" option.

LastFolioDate date No Latest date when a folio was printed using the "Periodic Batch Folios" option.

Frequency integer No Frequency in number of days when folios should be printed for this reservation.

Complex Type: ResPreConfiguredRoutingInstrType

Description

Stores the rate plan code and profile type information of the preconfigured routing instruction.

Attributes


RatePlanCode CodeType No This denotes the rateCode attached with the routing instruction of rateCode type.

ProfileType ResProfileTypeType No This stores the profile type attached with the preconfigured routing instruction.

Complex Type: ResProfileType

Attributes


73


Content Model



1..1


0..1

Profile ProfileType 0..1 Provides detailed information regarding either a company or a customer profile.

Complex Type: ResRevenueBalanceType

Description

Revenue and Balance Amount summary for the reservation.

Content Model



1..1

TotalFixedCharge CurrencyAmountType 0..1 Total Fixed Charges on the reservation.

TotalPayment CurrencyAmountType 0..1 Total payment received for the reservation.

RoomRevenue CurrencyAmountType 0..1 Room Revenue generated by the reservation.

FoodAndBevRevenue CurrencyAmountType 0..1 Food and Beverage Revenue generated by the reservation.

OtherRevenue CurrencyAmountType 0..1 Other Revenue generated by the reservation.

NonRevenue CurrencyAmountType 0..1 Total Non Revenue posted on the reservation.

TotalRevenue CurrencyAmountType 0..1 Total Revenue generated by the reservation.

Balance CurrencyAmountType 0..1 Balance amount on the reservation.

Complex Type: ResSharedGuestInfoType

Content Model



1..1

ProfileID UniqueID_Type (extension)

0..1

FirstName string 0..1 Given name, first name or names.


FullName string 0..1 String representation of the full name.

Complex Type: ResSharedGuestListType

Description

74

Collection of shared guest reservations.

Content Model



1..1

SharedGuest ResSharedGuestInfoType 0..*

Complex Type: RoomFeaturesType

Description

A collection of Room Features.

Content Model



1..1

RoomFeature RoomFeatureType 0..* A recurring element that identifies the room features.

Complex Type: RoomFeatureType

Description

Room Feature Information.

Attributes


Code CodeType No A code representing a room feature.

Description StringLength2000 No A code representing a room feature.


Complex Type: RoomRateType

Attributes


RoomType CodeType Yes Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.

RatePlanCode CodeType No Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.



75


Availability RoomRateAvailReasonType No Specifies an availability status for the room rate. When available, the value could be either not specified or "Available".

SuppressRate boolean No

MarketCode CodeType No The code that relates to the market being sold to (for example, the corporate market, packages).

MarketCodeDescription StringLength4000 No Description of the market code.

SourceOfBusiness CodeType No To specify where the business came from (for example, radio, newspaper ad).

SourceOfBusinessDescription StringLength4000 No Description of the source of business.

NumberOfUnits integer No The number of rooms.

RoomID CodeType No A string value representing the unique identification of a room.

PseudoRoom boolean No True value indicates as pseudo room type. This is usually used for a posting master reservation.

RoomTypeCharged CodeType No Room Type used for the Rate calculation.

CommissionCode CodeType No Commission Code applicable for commission calculation for Travel Agent/Company.

Commissionable boolean No Indicates Commission is applicable for commission calculation for Travel Agent/Company.

HouseUseOnly boolean No Indicates this reservation is for House use.

Complimentary boolean No Indicates this reservation rate is complimentary.

InventoryLender string No Indicates whether the room type inventory was taken from the allotment or House availability.

FixedRate boolean No Fixed Rate Indicator.

BarRanking integer No Best Available rates ranking.

RateGroup CodeType No For RatePlanSet equals BESTAVAILABLERATE, in case Rate Groups are enabled the element provides the rate group for the rate plan code.

DiscountAllowed boolean No Indicates if the Rate Code is discountable i.e discounts are allowed on the rate code.

76


BOGODiscount boolean No Indicates if the Rate Code has BOGO (Bye one Get one) indicator.

Content Model



1..1

Total TotalType 0..1

TotalPoints PointsType 0..1

Rates RatesType 0..1

Packages anyType (restriction) 0..1

StayProfiles anyType (restriction) 0..1 Profile associated with the room Stay.

GuestCounts GuestCountsType 0..1 A collection of Guest Counts associated with the room rate.

TaxFreeGuestCounts GuestCountsType 0..1 A collection of Tax Free Guest Counts associated with the room rate. This list does not add to the guest count but just indicates number of tax free guests out of guest counts.

Awards ResAwardsType 0..1 Membership Awards code applied on the reservation.

ForeignExchange ForeignExchangeType 0..1 Exchange Type information for the postings.

ReservationBlock ReservationBlockType 0..1 Key information about the block for this reservation.

RoomRateInfo StringLength2000 0..1 Information about the Room Rate Combination.

Complex Type: RoomStayCandidatesType

Content Model



1..1

RoomTypes anyType (restriction) 0..1

RoomClasses anyType (restriction) 0..1

BedTypes anyType (restriction) 0..1

Features anyType (restriction) 0..1

Complex Type: RoomStaySearchType

Content Model



1..1

77


TimeSpan TimeSpanType 0..1

Quantity integer 0..1

GuestCounts GuestCountsType 0..1

Complex Type: RoomStayType

Attributes


RoomNumberLocked boolean No When true, indicates a room number cannot be changed. When false, indicates a room number may be changed.

PrintRate boolean No Controls if rate information will be printed in the confirmation letter.

OwnerResType OwnerResTypeType No Indicates if the reservation is for Unit/Room Owner or Authorized User. If this attribute is not defined, it is a regular/rental reservation.

PrimaryShareType PrimaryShareTypeType No This is populated in case of primary share scenario. This indicates whether this reservation is primary or non-primary. Changes or postings to the 'non-primary' share reservation is not allowed.

RemoteCheckInAllowed boolean No Indicates whether the reservation is pre-registered for internet check-in or not.

BookingMedium CodeType No Classifies the medium (Channel field on reservation screen) through which the reservation is made.

BookingMediumDescription StringLength2000 No Description of the booking medium.

Content Model



1..1

CurrentRoomInfo CurrentRoomInfoType 0..1 Room information of the reservation for the current day.

RoomRates anyType (restriction) 0..1 A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount.


TimeSpan TimeSpanType 1..1 The Time Span (Arrival, Departure) which covers the Room Stay.

ExpectedTimes ResExpectedTimesType 0..1 The Expected Arrival and Departure Times.

78


OriginalTimeSpan TimeSpanType 0..1 The Original Time Span (Arrival, Departure) which covers the Room Stay. In case of Rolling No Show TimeSpan's StratDate moves forward but OriginalTimeSpan's StratDate remains the same.

Guarantee ResGuaranteeType 0..1 The guarantee information associated to the Room Stay. A maximum of 5 occurrences are available for use depending on the context.

Promotion PromotionType 0..1 Promotions applied to the reservation to get the promotional rate.

SuiteWith StringLength200 0..1 Connecting Rooms.

Total TotalType 0..1 The total amount charged for the Room Stay.

TotalPoints PointsType 0..1 The total number of Points charged for the Room Stay.

MultiValueAttrs anyType (restriction) 0..1 Informative indicators indicating different values of an attribute exists over the stay.

Complex Type: RoomTypeAttributesType

Description

Attributes of property room type.

Content Model



1..1

DefaultOccupancy integer 0..1 Default occupancy of property room type.

MaxOccupancy integer 0..1 Max occupancy of property room type.

NoOfPhysicalRooms integer 0..1 Number of physical rooms of property room type.

Complex Type: RoomTypeInfoType

Attributes


RoomType StringLength20 Yes Used for Character Strings, length 0 to 20.

HotelCode StringLength20 Yes Used for Character Strings, length 0 to 20.

RoomClass StringLength20 No Used for Character Strings, length 0 to 20.


Content Model



1..1

LongDescription StringLength2000 0..1 Detail description of the Room Type.

79


WebPage StringLength2000 0..1 URL providing more information about the Room Type.

RoomFeatures RoomFeaturesType 0..1 Collection of room features.

RoomTypeAttributes RoomTypeAttributesType 0..1 Room type attributes.

BookingChannelMappings anyType (restriction) 0..1 Collection of Booking Channels mapping for the Room Type.

Complex Type: RoomTypeMasterInfoType

Description

A collection of Room Types.

Attributes



Content Model



1..1

RoomType RoomTypeInfoType 0..* Room type information

Complex Type: SalesInfoType

Description

Provides sales information about the profiles of the types company, travel agent, source, and contact.

Attributes


HotelCode CodeType No Hotel Code used to filter the sales information.

Content Model



1..1

Scope StringLength2000 0..1 Defines the scope.

ScopeCity StringLength2000 0..1 Defines the scope city.

AccountType StringLength20 0..1 Defines the account type.

AccountSource StringLength2000 0..1 Defines the account source.

IndustryCode StringLength2000 0..1 Defines the industry code.

BusinessSegments StringLength2000 0..1 Defines the Business segments.

Priority StringLength4000 0..1 Defines the priority.

80


RoomsPotential StringLength4000 0..1 Defines the rooms potential.

ActionCode StringLength4000 0..1 Defines the action code.

CompetitionCode StringLength4000 0..1 Defines the competition code.

Influence StringLength2000 0..1 Defines the influence for the contact profile.

PreferredRoom StringLength20 0..1 Defines the Preferred Room for profile.

Complex Type: SearchMatchesType

Description

List of Generic Name-Value-Pair Parameters used for super search matches.

Content Model



1..1

SearchMatch SearchMatchType 0..*

Complex Type: SearchMatchType

Description

Search match indicating attribute and the matching value.

Attributes


Attribute StringLength2000 No Search match attribute.

Value StringLength2000 No Search match value.

Complex Type: SmokingPreferenceListType

Description

The list of Smoking Preferences.

Content Model



1..1

SmokingPreference CodeType 0..* Smoking preference to search a reservation. This is compared to the preference on the guest profile of the reservation.

Complex Type: SourceOfSaleType

Description

Point of Sale of reservation. Identifies the entity/channel that made the reservation.

Attributes

81


SourceType StringLength40 No Type of entity/channel that made the reservation.

SourceCode CodeType No The entity/channel that made the reservation.

Complex Type: StayInfoType

Description

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

financial information related to the Room Stay, including Guarantee, Deposit and Payment and

Cancellation Penalties.

Attributes


ScheduledCheckoutTime date No Indicates this reservation is scheduled for automated check-out.


PseudoRoom boolean No True value indicates as pseudo room type. This is usually used for a posting master reservation.

Content Model



1..1

TimeSpan TimeSpanType 0..1 The Time Span which covers the Room Stay.

ExpectedTimes ResExpectedTimesType 0..1 The expected arrival and departure times of the guest.

AdultCount integer 0..1 A collection of Guest Counts associated with Room Stay.

ChildCount integer 0..1 A collection of Child Counts associated with Room Stay.

RoomClass CodeType 0..1 Room class code.

RoomType CodeType 0..1 Room type code.

NumberOfRooms integer 0..1 Room ID.

RoomNumber CodeType 0..1 Room ID.

RatePlanCode CodeType 0..1 Rate plan code.

RateAmount CurrencyAmountType 0..1 Rate amount.

82


Points PointsType 0..1 The Points contains the number of points used to book a particular room type.

RateSuppressed boolean 0..1 Whether this rate should be suppressed from view.


BookingChannelCode CodeType 0..1 Booking channel code.

PartyCode string 0..1 Party code.

FixedRate boolean 0..1 True if the rate is a fixed rate, otherwise false.

TotalAmount CurrencyAmountType 0..1 The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.


MarketCode CodeType 0..1 Market code.

SourceOfBusiness CodeType 0..1 Source of business.

SourceOfBusinessDescription StringLength4000 0..1 Description of the source of business.

Balance CurrencyAmountType 0..1 Balance amount.

CompBalance CurrencyAmountType 0..1 Comp Balance amount.

RoomTypeCharged CodeType 0..1 Room type code that was charged.

DepositPayments CurrencyAmountType 0..1 A collection of deposit and/or payments for the Room Stay.

GuestServiceStatus GuestHousekeepingServiceRequestType 0..1 Service Status of In House guest like DND or MUP.

Complex Type: SuccessType

Description

83

Returning an empty element of this type indicates the successful processing of an OpenTravel message.

This is used in conjunction with the Warning Type to report any warnings or business errors.

Complex Type: TaxesType

Description

A collection of taxes.

Attributes




Content Model



1..1

Tax TaxType 0..99 An individual tax.

Complex Type: TaxType

Description

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.

Attributes


Type AmountDeterminationType No Indicates if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).

Code CodeType No Code identifying the fee (for example, agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT).



Content Model



1..1

Description StringLength2000 0..1

84

Complex Type: TaxTypeType

Description

Provides information about the Tax Type.

Content Model



1..1








Complex Type: TelephoneInfoType

Description

Information on a telephone number for the customer.

Content Model



1..1

UniqueID UniqueID_Type 0..1 Unique ID for the phone.

Telephone TelephoneType 0..1 Phone details for the profile.

Complex Type: TelephoneType

Description

Information on a telephone number for the customer.

Attributes


PhoneTechType CodeType No Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT).

85


PhoneUseType CodeType No Describes the type of telephone number, in the context of its general use (for example, Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Refer to OpenTravel Code List Phone Use Type (PUT).

PhoneUseTypeDescription StringLength2000 No Description of the PhoneUseType code.

PhoneNumber StringLength40 Yes Telephone number assigned to a single location.

Extension StringLength20 No Extension to reach a specific party at the phone number.



Complex Type: TimeSpanType

Description

Measure of time from a StartDate to either specified EndDate or StartDate plus Duration.

Content Model



1..1

StartDate date 0..1

1..1

Duration duration 0..1

EndDate date 0..1

Complex Type: TotalType

Description

The total amount charged for the service including additional amounts and fees.

Attributes


AmountBeforeTax Money No The total amount not including any associated tax (for example, sales tax, VAT, GST or any associated tax).

AmountAfterTax Money No The total amount including all associated taxes (for example, sales tax, VAT, GST or any associated tax).



86



Code CodeType No Type of charge. Refer to OpenTravel Code List Charge Type (CHG).

RateOverride boolean No When true, indicates that the rate amount has been overridden.

Content Model



1..1

Taxes TaxesType 0..1 A collection of taxes.


Complex Type: TranslationsTextType

Description

Contains multiple translated texts and language codes.

Content Model



1..1

Text StringLength2000 (extension)

0..*

Complex Type: TranslationTextType80

Description

Contains multiple translated texts and language codes.

Content Model



1..1

DefaultText StringLength80 0..1 Default text with Character length from 0 to 80.

TranslatedTexts TranslationsTextType 0..1 List of translated text and language codes.

Complex Type: UniqueID_Type

Description

87

An identifier used to uniquely reference an object in a system (for example, an airline reservation

reference, customer profile reference, booking confirmation number, or a reference to a previous

availability quote).

Attributes


URL string No URL that identifies the location associated with the record identified by the UniqueID.

Type CodeType Yes A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).

Instance StringLength80 No The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated.

ID StringLength80 Yes A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation.

IDExtension integer No Additional identifying value assigned by the creating system.

ID_Context StringLength80 No Used to identify the source of the identifier (for example, IATA, ABTA).

Complex Type: UniqueIDListType

Description

Used to provide PMS and/or CRS identifiers.

Content Model



1..1

UniqueID UniqueID_Type 0..* Unique ID that references an object uniquely in the system.

Complex Type: URLInfoType

Description

Web site address.

Content Model



1..1

UniqueID UniqueID_Type 0..1 ID for the URL in the system.

88


URL URLType 0..1 Provides URL information.

Complex Type: URLType

Description

Web site address, in IETF (The Internet Engineering Task Force) specified format.

Attributes


Type StringLength20 No Defines the purpose of the URL address, such as personal, business, public.




Complex Type: UserDefinedFieldsType

Description

A common type used to hold user defined fields (UDFs). This type should be used to handle UDFs on

RReservation, Profiles.

Content Model



1..1

CharacterUDFs CharacterUDFsType 0..1 Collection of user defined fields of Character/String Type.

NumericUDFs NumericUDFsType 0..1 Collection of user defined fields of Numeric Type.

DateUDFs DateUDFsType 0..1 Collection of user defined fields of Date Type.

Complex Type: VIPType

Description

The supplier's ranking of the customer.

Attributes


VIPCode CodeType No VIP Code.

VIPDescription StringLength80 No VIP Description.

Complex Type: WaitlistResType

Description

Information regarding why a reservation is being /has been waitlisted.

Attributes

89


ReasonCode CodeType No Waitlist Reason Code.

PriorityCode CodeType No Waitlist Priority Code.

Telephone StringLength40 No Guest telephone number.

Content Model



1..1

ReasonDescription StringLength2000 0..1 Waitlist Reason Description.

PriorityDescription StringLength2000 0..1 Waitlist priority Description.

Description StringLength2000 0..1 Description why the reservation is being /has been waitlisted.

Complex Type: WarningsType

Description

Collection of warnings.

Content Model



1..1

Warning WarningType 0..* Used in conjunction with the Success element to define a business error.

Complex Type: WarningType

Description

Used when a message has been successfully processed to report any warnings or business errors that

occurred.

Attributes


Type CodeType Yes The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". Refer to OpenTravel Code List Error Warning Type (EWT).


90




Status string No If present, recommended values are those enumerated in the OTA_ErrorRS, (NotProcessed | Incomplete | Complete | Unknown); however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.



RPH RPH_Type No Reference Place Holder used as an index for this warning.

Complex Type: WebUserAccountsType

Description

List of web user accounts associated with the requesting Profile.

Content Model



1..1

WebUserAccounts WebUserAccountType 0..* Web User Accounts List.

Complex Type: WebUserAccountType

Description

Web User Account of the guest.

Attributes

91


LoginName StringLength80 No Login Name of the guest.

DomainCode CodeType No Domain code.

Locked boolean No Boolean flag that indicates whether the web account is locked or not.

Inactive boolean No Boolean flag that indicates whether the web account is inactive or not.

Content Model



1..1

SecQuestion CodeDescriptionType 0..1 Security Question and its Code associated with the account to verify the user.

SecAnswer StringLength4000 0..1 Answer to the Security Question.

Comments StringLength4000 0..1 Comments.

History WebUserHistoryType 0..1 Web User Account History.

NewLoginName StringLength80 0..1 New Login Name of the guest.

NewPassword StringLength2000 0..1 Login Password.

AutoGeneratePassword boolean 0..1 A flag which determines if the password is auto generated.

Complex Type: WebUserHistoryType

Description

History of the Web User Account.

Attributes







Content Model



1..1

LastLogin date 0..1 Last login date.

92


LastPasswordChange date 0..1 Last Password change date.

InactiveDate date 0..1 Inactive date.

93

Elements: AvailabilityService

Element: AccessCode [type GdsNegotiatedInfoType]

Description

The GDS negotiated rate code.

Element: AccompanyGuest [type ResAccompanyGuestListType]

Content Model



1..1






0..1

Element: AccompanyGuests [type ResGuestInfoType]

Description

List of guest names that are accompanying the reservation guest.

Content Model



1..1

AccompanyGuest ResAccompanyGuestInfoType 0..*

Element: AccountSource [type SalesInfoType]

Description

Defines the account source.

Element: AccountType [type SalesInfoType]

Description

Defines the account type.

Element: ActionCode [type SalesInfoType]

Description

Defines the action code.

Element: AdditionalGuestAmount [type AmountType/AdditionalGuestAmounts]

Description

94

Collection of incremental charges per age qualifying code for additional guests. Amount charged for

additional occupant is with respect to age group of the base guests.

Attributes


AgeQualifyingCode AgeQualifyingCodeType Yes

Content Model



1..1

Amount TotalType 0..1

Element: AdditionalGuestAmounts [type AmountType]

Description

A collection of charges that apply to additional occupants, guests or service users (over and above the

rate's MaxGuest Applicable).

Content Model



1..1

AdditionalGuestAmount AdditionalGuestAmountType 0..* Collection of incremental charges per age qualifying code for additional guests. Amount charged for additional occupant is with respect to age group of the base guests.

Element: Address [type AddressInfoType]

Description

Address details for the profile.

Attributes


Type CodeType No Defines the type of address (for example, home, business, other). Refer to OpenTravel Code List Communication Location Type (CLT).

TypeDescription string No Describes the type code.


UpdateReservations boolean No Indicates whether to update the reservations or not. If true and the address is primary, all associated active reservations will be updated with the new primary address.

Content Model


95


1..1

AddressLine StringLength80 0..4 When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.



CityExtension StringLength20 0..1 Post Office City Extension Code number. City Extension mainly used for UK addresses.

County StringLength20 0..1 County or District Name (for example, Fairfax). This is read only.



Language CodeType 0..1 Language code associated with the address.

Element: Address [type RelationshipProfileType]

Description

Information on address details for the customer/company

Content Model



1..1



Element: Address [type ResGuestInfoType]

Description

Address information attached to the reservation guest.

Attributes


ExcludeNoCity boolean No When true, indicates that only profiles with city will be fetched.

Content Model



1..1

96






StreetAddress StringLength80 0..1 First Line of Street Address. For profile search it matches the first Address line.

Element: Addresses [type ProfileType]

Description

List of customer addresses.

Attributes


AllRowsFetched boolean No Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.


Content Model



1..1

AddressInfo AddressInfoType 0..* Collection of Detailed information on an address for the customer.

Element: AddressInfo [type ProfileType/Addresses]

Description

Collection of Detailed information on an address for the customer.

Content Model



1..1



Element: AddressLine [type AddressType]

Description

When the address is unformatted (FormattedInd="false"), these lines will contain free form address

details. When the address is formatted and street number and street name must be sent independently,

97

the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine

occurrence.

Element: AdultCount [type StayInfoType]

Description

A collection of Guest Counts associated with Room Stay.

Element: Adults [type RegionalRateParitySearchType]

Element: AlienInfo [type CustomerType]

Description

Immigration/visa information of a foreign person.

Content Model



1..1

AlienRegistrationNo string 0..1 Alien Registration Number.

ImmigrationStatus StringLength40 0..1 Immigration Status on an Alien.

VisaValidityType StringLength40 0..1 Visa Type of an Alien.

Element: AlienRegistrationNo [type AlienInfoType]

Description

Alien Registration Number.

Element: Allowance [type PackageElementType]

Attributes




Element: Allowed [type ReservationTurndownInfoType]

Description

Indicates if turndown is allowed or not.

Element: AllowedAction [type ReservationAllowedActionsType]

Description

Allowed action.

Enumeration

Value

Cancel

98

Value

Move

PreCharge

PostCharge

FacilitySchedule

Upsell

PreCheckIn

PostToNoShowCancel

NoShow

NameChange

Discount

Element: AllowedActions [type ReservationInfoType]

Description

Collection of reservation allowed actions.

Content Model



1..1

AllowedAction ReservationAllowedActionType 0..11 Allowed action.

Element: AlternateLanguage [type CompanyType]

Description

Alternate Language of the company.

Element: AlternateName [type CompanyType]

Description

Alternate Name of the Company. Mainly, it's the name of the company written in the Alternate

Language.

Element: AltFullName [type ResGuestInfoType]

Description

Alternate full display name.

Element: AltGivenName [type ResGuestInfoType]

Description

Alternate given name, first name or names.

Element: AltSurname [type ResGuestInfoType]

Description

Alternate family name, last name.

99

Element: Amount [type AdditionalGuestAmountType]

Attributes









Content Model



1..1



Element: Amount [type AuthorizationRuleType]

Description

The amount applicable to the authorization rule.

Attributes




Element: Amount [type PackageElementType]

Attributes

100




Element: AmountDue [type ResDepositPolicyType]

Description

Total amount due against the reservation deposit.

Attributes




Element: AmountOwed [type ReservationDepositType]

Description

Deposit Amount Owed.

Element: AmountPaid [type ResDepositPolicyType]

Description

Total amount paid against the reservation deposit.

Attributes




Element: AmountPaid [type ReservationDepositType]

Description

Deposit Amount Paid.

Element: AmountPercent [type CancelPenaltyType]

Description

Cancellation fee expressed as a fixed amount, or percentage of/or room nights.

Attributes





101




Element: AmountPercent [type DepositPolicyType]

Description

Payment expressed as a fixed amount, or a percentage of/or room nights.

Attributes







Element: AmountRequired [type ReservationDepositType]

Description

Deposit Amount Required.

Element: ApprovalAmountNeeded [type ResPaymentCardType]

Attributes




Element: Arrival [type RegionalRateParitySearchType]

Element: AttachedProfile [type ResAttachedProfileListType]

Attributes



Content Model



1..1

Name string 0..1 Attached profile name.

102



0..1

Element: AttachedProfiles [type ReservationInfoType]

Description

List of attached profiles

Content Model



1..1


Element: AttrName [type RoomStayType/MultiValueAttrs]

Element: AuthorizationRule [type ReservationPaymentMethodType]

Content Model



1..1

Code integer 0..1 The authorization rule code.

1..1

Amount CurrencyAmountType 0..1 The amount applicable to the authorization rule.

Percent double 0..1 A percentage value if the authorization rule is percentage based.

Element: AutoFolioSettlementType [type ProfileCashieringType]

Description

Contains the auto folio settlement type for the profile.

Element: AutoGeneratePassword [type WebUserAccountType]

Description

A flag which determines if the password is auto generated.

Element: AvailRequestSegment [element FetchHotelAvailabilityRQ/AvailRequestSegments]

Description

Availability Request Segment includes a collection of criteria that requests a Room Rate. At least one

availability request criteria is required.

Attributes

103


CRO CodeType No Central reservation office Code who is requesting Rate Availability.

ChainCode CodeType No Chain code of the Hotel whose Rate Availability is requested.

HotelCode CodeType No Hotel code of the Hotel whose Rate Availability is requested.

InitialRatePlanSet boolean No If InitialRatePlanSet is set to true, the response will return most relevant Rate Plan Set (for example, NEGOTIATED if profiles has Negotiated Rates) depending on the request. If the request does not require special Rate Plan Set, it will return default Rate Plan Set if RatePlanSet value is not set.

RatePlanSet CodeType No Rate Plan Set code to filter Rate Plans based on the predefined set. If not specified, it will not filter any Rate Plans by Rate Plan Set. When InitialRatePlanSet is true response may not always return Rate Plans for the supplied Rate Plan Set (See InitialRatePlanSet documentation).


PagePointerKey string No Specifies fetched record's key as pointer to fetch additional records from. If key is composite, use a comma separated string.

PageBack boolean No If true, fetch records that are prior to the key pointer provided.

IncludeClosedRates boolean No Used to indicate if closed rates are to be included in the Rate Plan set.

IncludeDefaultRatePlanSet boolean No Used to indicate if the configured default rate plan set will be included.

RedeemAwards boolean No Used to indicate if the awards are to be redeemed.

Content Model



1..1

RoomStay RoomStaySearchType (extension) 0..1 Room Stay detail for the Availability Request. It includes availability request time span, number of rooms requested and persons staying. Date range can also be specified by using start dates and number of nights.

MinRate CurrencyAmountType 0..1 Minimum rate amount to filter Rates for the Rate Availability Request.

104


MaxRate CurrencyAmountType 0..1 Minimum rate amount to filter Rates for the Rate Availability Request.

RatePlanCandidates RatePlanCandidatesType 0..1 Contains rate Plan and its classification related filters for the Rate Availability Request.

RoomStayCandidates RoomStayCandidatesType 0..1 Contains Room and its classification related filters for the Rate Availability Request.

ResGuestID UniqueID_Type 0..1 Reservation Guest's Unique ID. This element is used usually to get negotiated rates.

ResAttachedProfiles ResAttachedProfileListType 0..1 Travel Agent, Company, or Source profiles associated with the Rate Availability request. This element is used usually to get negotiated rates.

InvBlock BlockCodeIDType 0..1 Inventory Block code whose Rate Availability is requested.

HotelReservation AvailHotelResType 0..1 Hotel Reservation ID and other detail associated with a given reservation. Used when asking for availability for the purpose of modifying an existing reservation.

FetchInstructions AvailRequestFetchInstructionsType 0..1 A collection response instructions regarding additional information.

MembershipIDNo integer 0..1 Membership ID number of the guest.

MembershipLevel string 0..1 Membership ID number of the guest.

MembershipType string 0..1 Membership ID number of the guest.

SmokingPreferences SmokingPreferenceListType 0..1 List of Smoking Preferences to search for reservations.

Element: AvailRequestSegments [element FetchHotelAvailabilityRQ]

Content Model



1..1

AvailRequestSegment AvailRequestSegmentType 0..* Availability Request Segment includes a collection of criteria that requests a Room Rate.

Element: AvailResponseSegment [element FetchHotelAvailabilityRS/AvailResponseSegments]

Attributes

105


RatePlanSet CodeType No Rate Plan Set whose Rate Plans are returned in the response.

HotelCode CodeType No Hotel Code whose Rate Plans are returned in the response.

Closed boolean No If the availability response has a house level restriction, this flag will be true.

Redemption boolean No Indicates if the Room Rates returned are calculated based on points.



Content Model



1..1

RoomStays anyType (restriction) 0..1

MasterInfo AvailResponseMasterInfoType 0..1

HotelAlert StringLength2000 0..1 Hotel Alert Message.

Element: AvailResponseSegments [element FetchHotelAvailabilityRS]

Content Model



1..1

AvailResponseSegment AvailResponseSegmentType 0..*

Element: Awards [type RoomRateType]

Description

Membership Awards code applied on the reservation.

Attributes


OriginalRoomType CodeType No Room Type before the Upgrade Award.

UpgradeRoomType StringLength20 No Room Type after the Upgrade Award.

Content Model



1..1

106


MembershipNo UniqueID_Type 0..1 Membership program under which the award is applied.

AwardVouchers AwardVouchersType 0..1

Element: AwardVoucher [type AwardVouchersType]

Description

Stores the Membership Awards code applied on the reservation.

Attributes


AwardCode CodeType No Membership Award code applied on the reservation.

VoucherNo StringLength80 No Membership Award number.

Element: AwardVouchers [type ResAwardsType]

Content Model



1..1

AwardVoucher anyType (restriction) 0..5 This stores the Membership Awards code applied on the reservation.

Element: Balance [type ReservationPaymentMethodType]

Attributes




Element: Balance [type ResRevenueBalanceType]

Description

Balance amount on the reservation.

Attributes




Element: Balance [type StayInfoType]

Description

Balance amount

107

Attributes




Element: Base [type AmountType]

Description

The base amount charged for the accommodation or service per unit of time (for example, Nightly or

Weekly). If TaxInclusive is set to True, taxes are included in the base amount. Any additional charges

should be itemized in the other elements.

Attributes









Content Model



1..1



Element: BedTaxReporting [type ResCashieringType]

Description

This stores the information for Bed Tax Reporting. Mainly used in Maldives.

108

Attributes


TaxRegistrationNo double No Tax Registration number for Maldives Bed Tax Reporting.

VisaNumber StringLength40 No Visa number used for Maldives Bed Tax Reporting.

VisaIssueDate date No Visa Issue Date used for Maldives Bed Tax Reporting.

VisaExpiryDate date No Visa Expiration Date used for Maldives Bed Tax Reporting.

TaxableDays integer No Number of days for which the Maldives tax is applicable.

Element: BedType [type RoomStayCandidatesType/BedTypes]

Element: BedTypes [type RoomStayCandidatesType]

Content Model



1..1

BedType CodeType 0..*

Element: BillingPrivileges [type ResCashieringType]

Description

Billing privileges set on the reservation.

Attributes


PostingRestriction boolean No Flag used by interface program during check-in.

PreStayCharging boolean No Indicates if the reservation has charging privileges before arrival.

PostStayCharging boolean No Indicates if the reservation has charging privileges after check-out.

FolioCloseDate date No Date when folio was closed. This works with PostStayCharging flag.

ScheduledCheckout boolean No Indicates if the guest is scheduled for automatic check-out.

ScheduledCheckoutTime date No Time of automatic check-out if guest is schedule for automatic check out.

DirectBillAuthorized boolean No If Direct bill is authorized this will hold User ID who authorized it.

VideoCheckout boolean No Indicates if the guest can do video check-out.

AllowAutoCheckin boolean No Indicates if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only.

109


AutoSettlement boolean No Indicates if the is a candidate for auto folio settlement.

AutoSettlementType StringLength40 No The folio settlement type for auto folio settlement.

AutoSettlementFreq integer No The interval of days between each auto folio settlement.

Element: BirthCountry [type CustomerType]

Description

Country of birth.

Attributes



Element: BirthDate [type ResGuestInfoType]

Description

Date of birth.

Element: BlockIDList

Content Model



1..1


Element: BlockName [type ReservationBlockType]

Description

The Name of the block that is attached to the reservation.

Element: BookingChannelCode [type RegionalRateParityFilterType/BookingChannels]

Element: BookingChannelCode [type RegionalRateParitySearchType]

Element: BookingChannelCode [type StayInfoType]

Description

Booking channel code.

Element: BookingChannelInfo [type RegionalRateParityType/BookingChannelsInfo]

Attributes


BookingChannelCode CodeType Yes

110


Name StringLength40 No

BookingChannelType StringLength240 No

Content Model



1..1

HotelMappings anyType (restriction)

0..1 Collection of Hotel Code mapping for the Booking Channel.

ConfigurationParameters ParametersType 0..1

Element: BookingChannelMapping [type HotelChannelInfoType/BookingChannelMappings]

Description

Booking Channels mapping for the Hotel Code.

Attributes


BookingChannelCode StringLength20 Yes

Code StringLength20 Yes


Description StringLength2000 No

Element: BookingChannelMapping [type RatePlanInfoType/BookingChannelMappings]

Description

Booking Channel mapping for the Rate Plan Code.

Attributes






Element: BookingChannelMapping [type RoomTypeInfoType/BookingChannelMappings]

Description

Booking Channels mapping for the Room Type.

Attributes




111




Element: BookingChannelMappings [type HotelChannelInfoType]

Description

Collection of Booking Channels mapping for the Hotel Code.

Content Model



1..1

BookingChannelMapping BookingChannelMappingType 1..* Booking Channels mapping for the Hotel Code.

Element: BookingChannelMappings [type RatePlanInfoType]

Description

Collection of Booking Channels mapping for the Rate Plan Code.

Content Model



1..1

BookingChannelMapping BookingChannelMappingType 1..* Booking Channel mapping for the Rate Plan Code.

Element: BookingChannelMappings [type RoomTypeInfoType]

Description

Collection of Booking Channels mapping for the Room Type.

Content Model



1..1

BookingChannelMapping BookingChannelMappingType 1..* Booking Channels mapping for the Room Type.

Element: BookingChannels [type RegionalRateParityFilterType]

Content Model



1..1

BookingChannelCode StringLength20 0..*

112

Element: BookingChannelsInfo [type RegionalRateParityType]

Content Model



1..1

BookingChannelInfo BookingChannelInfoType 0..*

Element: BusinessLocale [type CompanyType]

Description

A jurisdiction (Territory) in which a company is authorized to do business.

Element: BusinessSegment [type ProfileType/BusinessSegments]

Description

Business/Market Segment associated to the profile.

Element: BusinessSegments [type ProfileType]

Description

Business/Market Segments associated to the profile.

Content Model



1..1

BusinessSegment CodeType 0..* Business/Market Segment associated to the profile.

Element: BusinessSegments [type SalesInfoType]

Description

Defines the Business segments.

Element: CancelPenalty [type GuaranteePolicyType]

Description

Defines the cancellation penalty of the hotel facility.

Attributes


Effective boolean No Indicator if Cancellation Penalty is currently applicable or not.



Content Model


113


1..1


AmountPercent PolicyAmountPercentType 0..1 Cancellation fee expressed as a fixed amount or percentage of/or room nights.


EstimatedAmount Money 0..1 Message.

Element: CardId [type ResPaymentCardType]

Description

Credit card ID

Attributes








Element: Cashiering [type ProfileType]

Description

Contains cashiering related details for the profile

Attributes




114



Content Model



1..1

DirectBillingList anyType (restriction)

0..1 List of direct billing related information for the profile.

AutoFolioSettlementType StringLength40 0..1 Contains the auto folio settlement type for the profile.

PaymentDueDays integer 0..1 Ability to define on the account, the number of days after which the invoice should be paid.

Element: Cashiering [type ReservationInfoType]

Description

Holds cashiering related information for the reservation.

Attributes


FinanciallyResponsible boolean No The guest from whom payment has to be recovered (direct guest).

ProratedBilling boolean No In case of Apartment style billing, indicates if a prorated amount should be used for an Apartment Style Billing rate.

LastRoomAndTaxPostedDate date No Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing.

ReverseCheckInAllowed boolean No Verifies if reverse check-in is allowed for the reservation.

TransactionsPosted boolean No Specifies if the reservation has a financial transaction associated with it.

Content Model



1..1


115


BillingPrivileges BillingPrivilegesType 0..1 Billing privileges set on the reservation.

TaxType ReservationTaxTypeInfo 0..1 Stores the code for the type of tax calculation, especially with tax exemption.

BedTaxReporting BedTaxReportingType 0..1 Stores the information for Bed Tax Reporting. Mainly used in Maldives.

FolioTexts FolioTextsType 0..1 Additional text fields to display on the folio.

PeriodicFolio ResPeriodicFolioType 0..1 Information regarding periodic folios set on the reservation.

CompAccounting ResCompAccountingType 0..1 Information regarding comp accounting on the reservation.

ResPreConfiguredRoutingInstruction ResPreConfiguredRoutingInstrType 0..1 Information regarding the selected preconfigured routing instruction on the reservation.

Element: Category [type InterfaceRightsStatusType]

Description

Category code of this interface right.

Element: ChainCode [type ProfileAccessType]

Description

Indicates the Chain code where the profile was created.

Element: ChainCode [type RegionalRateParityFilterType]

Element: ChangeProfileIDList [type RelationshipProfileType]

Description

Updated/changed profile details for the relationships created.

Content Model



1..1


116

Element: ChangeRelationship [type RelationshipInfoType]

Description

Information about the changes in relationship for the profile.

Attributes







Element: ChannelRatePlanCode [type RegionalRateParityFilterType/ChannelRatePlans]

Element: ChannelRatePlans [type RegionalRateParityFilterType]

Content Model



1..1

ChannelRatePlanCode StringLength20 0..*

Element: CharacterUDFs [type UserDefinedFieldsType]

Description

Collection of user defined fields of Character/String Type.

Content Model



1..1

UDF CharacterUDFType 0..*

Element: Child [type ChildAgesType]

Description

Age of a child in years.

Attributes


Age int Yes Age of a child in years.

117

Element: ChildAges [type GuestCountsType]

Description

Defines Children's Ages. Number of ages may not match with children counts.

Content Model



1..1

Child ChildAgeType 0..* Age of a child in years.

Element: ChildBuckets [type GuestCountsType]

Description

Defines children counts with Age Qualifying Group(Child Bucket#1) classification.

Attributes


Bucket1Count int Yes Number of children classified under the first Age Qualifying Group(Child Bucket#1).

Bucket2Count int Yes Number of children classified under the second Age Qualifying Group(Child Bucket#2).

Bucket3Count int Yes Number of children classified under the third Age Qualifying Group(Child Bucket#3).

Bucket4Count int Yes Number of children classified under the fourth Age Qualifying Group(Child Bucket#4).

Bucket5Count int Yes Number of children classified under the fifth Age Qualifying Group(Child Bucket#5).

Element: ChildCount [type StayInfoType]

Description

A collection of Child Counts associated with Room Stay.

Element: Children [type RegionalRateParitySearchType]

Element: Cities [type RegionalRateParityFilterType]

Content Model



1..1

CityCode StringLength40 0..*

Element: CitizenCountryName [type CustomerType]

Description

Name of the (self-professed) country that is claimed for citizenship.

118

Attributes



Element: CityCode [type RegionalRateParityFilterType/Cities]

Element: CityExtension [type AddressType]

Description

Post Office City Extension Code number. City Extension mainly used for UK addresses.

Element: CityName [type AddressSearchType]

Description

City (for example, Dublin), town, or postal station (that is, a postal service territory, often used in a

military address).

Element: CityName [type AddressType]

Description

City (for example, Dublin), town, or postal station (that is, a postal service territory, often used in a

military address).

Element: Code [type AuthorizationRuleType]

Description

The authorization rule code.

Element: Code [type TaxTypeType]

Description

Code of the Tax Type.

Element: CollectingAgentTax [type TaxTypeType]

Description

A boolean flag for Collecting Agent Tax.

Element: ComissionCode [type NegotiatedInfoType]

Description

Informational purposes only in numeric format.

Element: Comment [type CommentInfoType]

Description

Comment details for the comment. It will be empty in the case of delete comment.

Attributes


Type CodeType No Specifies type of the comment.

119


TypeDescription StringLength200 No Comment type Description.

Internal boolean No When true, the comment may not be shown to the consumer. When false, the comment may be shown to the consumer.

Confidential boolean No When true, the comment may be confidential.

OverrideInternal boolean No When true, the note internal could be modified.

ProtectDescription boolean No When true, the note title will be populated from the note type description and can't be modified.

HotelCode CodeType No If specified, the comment belongs to the Hotel; otherwise, it is a global comment.

ActionType CodeType No Specifies type of action described in the comments.

ActionDate date No Indicates on which date an action described in the comment must be taken.






Content Model



1..1

1..1




CommentTitle StringLength4000 0..1 Specifies Comment's Title.

Element: Comment [type MembershipType]

Description

Additional comments regarding to the membership.

Content Model



1..1

1..1

120





Element: CommentInfo [type ProfileType/Comments]

Description

Collection of Detailed information on comments for the customer.

Content Model



1..1

UniqueID UniqueID_Type 0..1 Comment ID for the comment. It will be empty in case of new comment.

Comment CommentType 0..1 Comment details for the comment. It will be empty in case of delete comment.

Element: Comments [type ProfileType]

Description

List of Notes for the customer.

Attributes




Content Model



1..1

CommentInfo CommentInfoType 0..* Collection of Detailed information on comments for the customer.

Element: Comments [type ResDepositPolicyType]

Description

Comments attached with a deposit.

Element: Comments [type WebUserAccountType]

Description

Comments.

121

Element: CommentTitle [type CommentType]

Description

Specifies Comment's Title.

Element: CommissionCode [type RatePlanCommissionType]

Description

Commission code used by the rate plan.

Element: CommissionInfo [type ProfileType/CommissionInfoList]

Description

Contains commission related details for the profile.

Attributes


HotelCode CodeType No Hotel Code for the commission being used for a profile.

CommissionCode CodeType No Commission Code for a profile.

BankAccount CodeType No Bank account used for the commission for a profile.




Element: CommissionInfoList [type ProfileType]

Description

List of commission details for the profile. Only available for account profiles such as Travel agent and

source.

Content Model



1..1

CommissionInfo ProfileCommissionType 0..* Contains commission related details for the profile.

Element: CommissionPercentage [type RatePlanCommissionType]

Description

Commission percentage used by the rate plan.

122

Element: CompAccounting [type ResCashieringType]

Description

Information regarding comp accounting on the reservation.

Attributes


CompType CodeType No Code used to identify the casino comp type and ranking of a guest.

Authorizer StringLength40 No ID of the employee who will act as the host for this guest.

Element: Company [type ProfileType]

Description

Detailed company information for this profile.

Attributes









CreditRating CodeType No Credit Rating of the company.




Content Model



1..1




123




BusinessLocale StringLength40 0..1 A jurisdiction (Territory) in which a company is authorized to do business.

Element: Company [type RelationshipProfileType]

Description

Detailed information of the Company.

Attributes






Nationality CodeType No Nationality code identification



CreditRating CodeType No Credit Rating of the company.




Content Model



1..1






124


BusinessLocale StringLength40 0..1 A jurisdiction (Territory) in which a company is authorized to do business.

Element: CompanyName [type CompanyType]

Description

Name of the company.

Element: CompanyName2 [type CompanyType]

Description

Second Name of the company.

Element: CompanyName3 [type CompanyType]

Description

Third Name of the company.

Element: CompBalance [type StayInfoType]

Description

Comp Balance amount.

Attributes




Element: CompetitionCode [type SalesInfoType]

Description

Defines the competition code.

Element: ConfigurationParameters [type BookingChannelInfoType]

Content Model



1..1

Parameter ParameterType 0..* Collection of generic Name-Value-Pair parameters.

Element: CorporateAgreementId [type NegotiatedInfoType]

Description

The master identifier for multiple offices/locations under the same company profile. This is optional

Element: CountryName [type AddressSearchType]

Description

125

Country name (for example, Ireland).

Attributes



Element: CountryName [type AddressType]

Description

Country name (for example, Ireland).

Attributes



Element: County [type AddressType]

Description

County or District Name (for example, Fairfax). This is read-only.

Element: CROCode [type OperaContextType]

Description

Central Reservation office (CRO) code.

Element: CROCode [type ProfileAccessType]

Description

Indicates the CRO code where the profile was created.

Element: CurrencyCode [type RatePlanInfoType]

Description

Currency Code of the rate code.

Element: CurrentAuthorizedAmount [type ResPaymentCardType]

Attributes




Element: CurrentRoomInfo [type RoomStayType]

Description

Room information of the reservation for the current day.

Content Model


126


1..1

RoomType CodeType 0..1 Current room type.

RoomNumber CodeType 0..1 Current room number.

Element: Customer [type ProfileType]

Description

Detailed customer information for this profile.

Attributes


















Content Model



1..1


127







LegalCompany StringLength80 0..1 Name Of the company the individual is associated with.

Element: Customer [type RelationshipProfileType]

Description

Detailed information of the customer

Attributes


















Content Model

128



1..1







LegalCompany StringLength80 0..1 Name of the company the individual is associated with.

Element: DateUDFs [type UserDefinedFieldsType]

Description

Collection of user defined fields of Date Type.

Content Model



1..1

UDF DateUDFType 0..*

Element: Deadline [type CancelPenaltyType]

Description

Cancellation deadline, absolute or relative.

Attributes






Element: Deadline [type DepositPolicyType]

Description

Payment deadline, absolute or relative.

Attributes

129






Element: DefaultOccupancy [type RoomTypeAttributesType]

Description

Default occupancy of property room type.

Element: DefaultText [type TranslationTextType80]

Description

Default text with Character length from 0 to 80.

Element: Deposit [type ReservationInfoType]

Description

Holds reservation deposit information.

Attributes


HasPaid boolean No Resolves whether reservation has paid deposit.

HasOutstanding boolean No Resolves whether reservation has outstanding deposit.

Content Model



1..1

AmountRequired Money 0..1 Deposit Amount Required.

AmountPaid Money 0..1 Deposit Amount Paid.

AmountOwed Money 0..1 Deposit Amount Owed.

DueDate date 0..1 Deposit Due Date.

PostingDate date 0..1 Deposit Posting Date.

Element: DepositPayments [type StayInfoType]

Description

A collection of deposit and/or payments for the Room Stay.

Attributes

130




Element: DepositPolicy [type GuaranteePolicyType]

Description

Defines the deposit policy, guarantees policy, and/or accepted forms of payment.

Content Model



1..1

RevenueType DepositCancelRevenueType 0..1 Type of reservation.

Policy DepositPolicyType 0..1 Reservation deposit policy details.

Comments StringLength2000 0..1 Comments attached with a deposit.

AmountPaid CurrencyAmountType 0..1 Total amount paid against the reservation deposit.

AmountDue CurrencyAmountType 0..1 Total amount due against the reservation deposit.

PolicyID UniqueID_Type 0..1 Unique ID of the Reservation Policy.

EstimatedAmount Money 0..1 Message.

Element: Description [type DepositPolicyType]

Description

Text description of the Payment in a given language.

Element: Description [type FacilityCodeType]

Description

Facility Code.

Element: Description [type GuaranteeType]

Description

Description of the Guarantee Code.

Element: Description [type HousekeepingTaskCodeType]

Description

Description of the Task Code.

Element: Description [type InterfaceRightsStatusType]

Description

User defined description for an Interface Right.

131

Element: Description [type PackageElementType]

Element: Description [type PreferenceType]

Description

Preference Description for display purposes.

Element: Description [type RatePlanInfoType]

Description

Description of the Rate Code.

Element: Description [type TaxType]

Element: Description [type TaxTypeType]

Description

Description of the Tax Type.

Element: Description [type TotalType]

Element: Description [type WaitlistResType]

Description

Description why the reservation is being /has been waitlisted.

Element: DirectBilling [type ProfileCashieringType/DirectBillingList]

Description

Contains the direct billing related information for the profile.

Attributes


HotelCode CodeType No Hotel Code for which the details of direct billing is provided for a profile.

ARNumber CodeType No Hotel Code for which the details of direct billing is provided for a profile.

Element: DirectBillingList [type ProfileCashieringType]

Description

List of direct billing related information for the profile.

Content Model



1..1

DirectBilling DirectBillingType 0..* Contains the direct billing related information for the profile.

132

Element: Discount [type AmountType]

Description

Discount percentage and/or Amount, code and textual reason for discount

Attributes


Percent double No Percentage discount.



DiscountCode CodeType No Specifies the type of discount (for example, No condition, LOS, Deposit or Total amount spent).

Content Model



1..1

DiscountReason StringLength2000 0..1

Element: DiscountReason [type DiscountType]

Element: DisplayColor [type ReservationInfoType]

Description

Color setting of the reservation.

Element: DueDate [type ReservationDepositType]

Description

Deposit Due Date.

Element: Duration [type TimeSpanType]

Element: EarningPreference [type MembershipType]

Description

Earning preference to the membership.

Enumeration

Value

Points

Miles

Element: Email [type EmailInfoType]

Description

Email details for the profile.

Attributes

133


EmailAddress StringLength2000 No Defines the email address.

Type CodeType No Defines the purpose of the email address (for example, personal, business, list serve).

TypeDescription StringLength2000 No Describes the Type code

EmailFormat NMTOKEN (restriction)

No Supported email format.



Element: Email [type RelationshipProfileType]

Description

Information on email address for the customer/company.

Content Model



1..1



Element: Email [type ResGuestInfoType]

Description

Email address.

Element: EmailFolioInfo [type ReservationPaymentMethodType]

Description

Information element for Email Folio functionality.

Attributes


EmailFolio boolean No

Content Model



1..1



Element: EmailInfo [type ProfileType/Emails]

Description

Collection of Detailed information on an email address for the customer.

134

Content Model



1..1



Element: Emails [type ProfileType]

Description

List of email addresses for the customer.

Attributes




Content Model



1..1

EmailInfo EmailInfoType 0..* Collection of Detailed information on an eMail address for the customer.

Element: EndDate [type PackageElementType]

Element: EndDate [type TimeSpanType]

Element: EnvelopeGreeting [type PersonNameType]

Description

Envelope greeting of the profile.

Element: Error [type ErrorsType]

Description

An error that occurred during the processing of a message.

Attributes

135


Type CodeType Yes The Error element MUST contain the Type attribute that uses a recommended set of values to indicate the error type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". Refer to OpenTravel Code List Error Warning Type (EWT).




Status string No If present, recommended values are those enumerated in the OTA_ErrorRS (NotProcessed | Incomplete | Complete | Unknown); however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.



NodeList string No An XPath expression that selects all the nodes whose data caused this error. Further, this expression should have an additional constraint which contains the data of the node. This will provide the offending data back to systems that cannot maintain the original message.

Element: Errors [type OperaWebServiceRSBaseType]

Description

Refer to Generic common types document.

136

Content Model



1..1

Error ErrorType 0..99 An error that occurred during the processing of a message.

Element: EstimatedAmount [type GuaranteePolicyType/CancelPenalty]

Description

Message.

Element: EstimatedAmount [type GuaranteePolicyType/DepositPolicy]

Description

Message.

Element: ExpectedTimes [type RoomStayType]

Description

The Expected Arrival and Departure Times.

Attributes




Element: ExpectedTimes [type StayInfoType]

Description

The expected arrival and departure times of the guest.

Attributes




Element: ExternalInfo [type ResGuestInfoType]

Description

External information about the guest associated with the reservation.

Content Model



1..1

GivenName GivenNameType 0..1 Given name, first name or names


137

Element: ExternalSystem [type OperaContextType]

Description

External system code.

Element: FacilityCode [type FacilityCodesType]

Attributes


Code CodeType No Facility code value.

Content Model



1..1

Description StringLength80 0..1 Facility Code.

Quantity integer 0..1 Signifies the quantity.

Element: FacilityDepartureTask [type HousekeepingTaskCodeType]

Description

Indicates if this task code is the default departure task for Facility Tasks. This requires

Element: FacilityTaskInfo [type ResHousekeepingType]

Description

The facility task applicable for the current day. This will be information only and not used for any

updates.

Attributes


Date date No The Date on which the task is applicable.

Content Model



1..1

Task HousekeepingTaskCodeType 0..1 The Task Code.

Supplies FacilityCodesType 0..1 Supplies associated with the task.

Element: Feature [type RoomStayCandidatesType/Features]

Element: Features [type RoomStayCandidatesType]

Content Model



1..1

138


Feature CodeType 0..*

Element: FetchHotelAvailabilityRQ

Description

Request object to fetch hotel availability based on request segment.

Attributes





CorrelationID StringLength80 No Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.

Content Model



1..1


AvailRequestSegments anyType (restriction) 0..1

Element: FetchHotelAvailabilityRS

Description

Response object to search hotel availability based on request segment.

Attributes


EchoToken StringLength128 No A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token, the corresponding response message must include an echo token with an identical value.

139





Content Model



1..1

1..1


1..1



AvailResponseSegments anyType (restriction)

0..1

Element: FetchInstructions [type AvailRequestSegmentType]

Description

A collection response instructions regarding additional information.

Attributes


RatePlanInfo boolean No If true, Rate Plan Code Master information will be included in the response.

RoomTypeInfo boolean No If true, Room Type Master information will be included in the response.

ResGuaranteeInfo boolean No If true, Guarantee Code information will be fetched with Rate Code Information. This attribute is only effective when RatePlanInfo is true.

Element: FirstName [type ResAccompanyGuestInfoType]

Description

Given name, first name or names.

140

Element: FirstName [type ResSharedGuestInfoType]

Description


Element: FixedRate [type StayInfoType]

Description

True if the rate is a fixed rate, otherwise false.

Element: FolioText [type FolioTextsType]

Description

Stores the description for the type of tax calculation, especially with tax exemption.

Attributes


Text StringLength50 No Additional text field to display on the folio.

Row integer No Row number of the additional text.

Element: FolioTexts [type ResCashieringType]

Description

Additional text fields to display on the folio.

Content Model



1..1

FolioText anyType (restriction) 0..2 Stores the description for the type of tax calculation, especially with tax exemption.

Element: FoodAndBevRevenue [type ResRevenueBalanceType]

Description

Food and Beverage Revenue generated by the reservation.

Attributes




Element: ForeignExchange [type RoomRateType]

Description

Exchange Type information for the postings.

Attributes

141


Type CodeType No Exchange Type for the postings.

EffectiveDate date No Effective Exchange date for the foreign currency posting.

Element: FullName [type ResAccompanyGuestInfoType]

Description

String representation of the full name.

Element: FullName [type ResGuestInfoType]

Description

Full display name.

Element: FullName [type ResSharedGuestInfoType]

Description

String representation of the full name.

Element: FullStayTimeSpan [type AvailRequestSegmentType/RoomStay]

Description

When FullStayTimeSpan element is present, it indicates —the availability request is to get different room

rates for the particular nights (defined by TimeSpan element) within the full stay. This is usually used to

for a Rate code changes during the reservation. This information allows House or Room Type level

restrictions to be based on full stay in case of a partial stay availability search.

Content Model



1..1

StartDate date 0..1

1..1


EndDate date 0..1

Element: FutureList [type ReservationHistoryFutureInfoType]

Description

Refer to Future list type document.

Attributes




142

Content Model



1..1

ReservationInfo ReservationInfoType 0..* Additional reservation information attached to the profile (for example, future reservation details).

Element: GdsNegotiatedInfoList [type GdsNegotiatedType]

Description

List of channel negotiated rates for the profile.

Attributes




Content Model



1..1

AccessCode CodeType 0..1 The GDS negotiated rate code.


Inactive boolean 0..1 The GDS Negotiated Rate is inactive or not.

Element: GdsNegotiatedRate [type ProfileType/GdsNegotiatedRates]

Description

Collection of Detailed information on channel negotiated rates for the profile.

Attributes


BookingChannelCode CodeType No Booking Channel Code.

HotelCode CodeType No Hotel Code.

ChannelRatePlanCode CodeType No Channel Room Type.

Content Model



1..1

GdsNegotiatedInfoList GdsNegotiatedInfoType 0..* List of channel negotiated rates for the profile.

Element: GdsNegotiatedRates [type ProfileType]

Description

List of channel negotiated rates that this profile has been assigned to.

143

Attributes




Content Model



1..1

GdsNegotiatedRate GdsNegotiatedType 0..* Collection of Detailed information on channel negotiated rates for the profile.

Element: GivenName [type PersonNameType]

Description


Element: GivenName [type ResGuestExternalInfoType]

Description


Element: GivenName [type ResGuestInfoType]

Description


Element: Global [type PreferenceType]

Description

Whether this preference is property specific or not.

Element: Guarantee [type RoomStayType]

Description

The guarantee information associated to the Room Stay. A maximum of 5 occurrences are available for

use depending on the context.

Attributes





Element: Guarantee [type StayInfoType]

Description

144

The guarantee information associated to the Room Stay. A maximum of 5 occurrences are available for

use depending on the context.

Attributes





Element: GuestCounts [type RoomRateType]

Description

A collection of Guest Counts associated with the room rate.

Attributes




Content Model



1..1

ChildAges ChildAgesType 0..1 Defines Children's Ages. Number of children ages mentioned may not match with children counts.


Element: GuestCounts [type RoomStaySearchType]

Attributes




Content Model



1..1



Element: GuestCounts [type RoomStayType]

Attributes

145




Content Model



1..1



Element: GuestLastStayInfo [type ResGuestInfoType]

Description

Contains information regarding the last stay of this guest.

Content Model



1..1

LastStayDate date 0..1 Guest's last stay date.

LastStayRoom CodeType 0..1 Room number where the guest stayed.

LastStayRate CurrencyAmountType 0..1 The Rate amount of the guest's last stay.

TotalStay integer 0..1 The total number of previous stay of the guest.

Element: GuestPreferredCurrency [type ReservationInfoType]

Description

Currency code preferred by guest.

Element: GuestRestricted [type ResGuestInfoType]

Description

True indicates there are restrictions associated with the current profile.

Element: GuestRestrictedCode [type ResGuestInfoType]

Description

Guest profile restricted reason code.

Element: GuestRestrictedReasonDesc [type ResGuestInfoType]

Description

Guest profile restricted reason description.

146

Element: GuestServiceStatus [type StayInfoType]

Description

Service Status of In House guest like DND or MUP.

Enumeration

Value

Do Not Disturb

Make Up Room

Element: History [type WebUserAccountType]

Description

Web User Account History.

Attributes







Content Model



1..1

LastLogin date 0..1 Last login date.

LastPasswordChange date 0..1 Last Password change date.

InactiveDate date 0..1 Inactive date.

Element: HistoryList [type ReservationHistoryFutureInfoType]

Description

Refer to History list type document.

Attributes




147

Content Model



1..1

ReservationInfo ReservationInfoType 0..* Additional reservation information attached to the profile (for example, history reservation details).

Element: HotelAlert [type AvailResponseSegmentType]

Description

Hotel Alert Message.

Element: HotelCode [type HotelInterfaceType]

Description

Hotel Code.

Element: HotelCode [type OperaContextType]

Description

Hotel code.

Element: HotelCode [type ProfileAccessType]

Description

Indicates the Hotel code where the profile was created.

Element: HotelCode [type RegionalRateParityFilterType/Hotels]

Element: HotelCode [type RegionalRateParitySearchType]

Element: HotelCode [type TaxTypeType]

Description

Code of the Hotel.

Element: HotelInfo [type RegionalRateParityType/HotelsInfo]

Attributes


HotelCode StringLength20 Yes


Content Model



1..1


0..1 Collection of Booking Channels mapping for the Hotel Code.

148

Element: HotelInterface [type ReservationInterfaceStatusType]

Description

Hotel interface information for the reservation.

Content Model



1..1

InterfaceId UniqueID_Type 1..1 Unique DB internal number of a Hotel Interface record.

HotelCode CodeType 1..1 Hotel Code.

InterfaceName StringLength40 1..1 Name of the Hotel Interface.

InterfaceType HotelInterfaceTypeType 1..1 Three letter code for each interface that identifies the interface.

Logo CodeType 1..1 Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore (_). This tells us which DBF files and log files with the prefix that IFC7 is going to create.

MachineName StringLength80 0..1 Unique machine name of the running IFC.

Status HotelInterfaceStatusType 1..1 The current status of the IFC.

Element: HotelInterfaceStatusList [type ReservationInfoType]

Description

Collection of Hotel Interfaces and rights populated only when fetching interface status for rooms.

Content Model



1..1

RoomExtension StringLength20 1..1 Identifier for the room extension.

HotelInterface HotelInterfaceType 1..1 Hotel interface information for the reservation.

InterfaceRights InterfaceRightsStatusType 0..* Contains a list of status/rights for the various services under this interface.

Element: HotelMapping [type BookingChannelInfoType/HotelMappings]

Description

Hotel Code mapping for the Booking Channel.

Attributes





149



Element: HotelMappings [type BookingChannelInfoType]

Description

Collection of Hotel Code mapping for the Booking Channel.

Content Model



1..1

HotelMapping HotelMappingType 1..* Hotel Code mapping for the Booking Channel.

Element: HotelReservation [type AvailRequestSegmentType]

Description

Hotel Reservation ID and other details associated with a given reservation. Used when asking for

availability when modifying an existing reservation.

Content Model



1..1

HotelReservationId UniqueID_Type 0..1 Hotel Reservation Unique ID to identify the reservation.

TimeSpan TimeSpanType 0..1 Current Arrival and Departure date of the reservation.

RatePlanCode CodeType 0..1 Reservation's Current Rate plan code that is of interest.

RoomType CodeType 0..1 Reservation's Current Room Type code that is of interest.

Element: HotelReservationId [type AvailHotelResType]

Description

Hotel Reservation Unique ID to identify the reservation.

Attributes




150






Element: Hotels [type PreferenceType]

Description

If specified, the preference belongs to the Hotels listed; otherwise, it is a global preference.

Element: Hotels [type RegionalRateParityFilterType]

Content Model



1..1

HotelCode StringLength20 0..*

Element: HotelsInfo [type RegionalRateParityType]

Content Model



1..1

HotelInfo HotelChannelInfoType 0..*

Element: Housekeeping [type ReservationInfoType]

Description

Information regarding housekeeping for this reservation.

Attributes


TurndownRequested boolean No Indicates if the guest wants turndown facility.

ServiceTime date No This is the Turndown room service time.

151


ExpectedServiceTime time No Expected Start Time for housekeeping task(s).

RoomStatus HousekeepingRoomStatusType No Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house.

Content Model



1..1

Instructions string 0..1 Turndown instructions for the room.

FacilityTaskInfo FacilityTaskType 0..1 The facility task applicable for the current day. This will be information only and not used for any updates.


Element: Identification [type IdentificationInfoType]

Description

Detailed information on the identification of the customer.

Attributes


RegisteredProperty CodeType No Property where the identification belongs.

PrimaryInd boolean No When true, indicates primary information.


Content Model



1..1

IDType StringLength40 0..1 Identification Type (for example, passport, driver's license).

IDNumber StringLength80 0..1 Identification number.

IDNumberMasked StringLength80 0..1 Masked Identification number.

IssuedCountry StringLength20 0..1 The country where Identification was issued.

IssuedDate date 0..1 Issued date of Identification.

IssuedPlace StringLength80 0..1 The place where Identification was issued.

Element: IdentificationInfo [type CustomerType/Identifications]

Description

Collection of detailed information on the identification of the customer.

Content Model

152



1..1

UniqueID UniqueID_Type 0..1 Unique ID of the identification.

Identification IdentificationType 0..1 Detailed information on the identification of the customer.

Element: Identifications [type CustomerType]

Description

List of identification of the customer.

Attributes




Content Model



1..1

IdentificationInfo IdentificationInfoType 0..* Collection of detailed information on the identification of the customer.

Element: IDNumber [type IdentificationType]

Description

Identification number.

Element: IDNumberMasked [type IdentificationType]

Description

Masked Identification number.

Element: IDType [type IdentificationType]

Description

Identification Type (for example, passport, driver's license).

Element: Image [type ParagraphType]

Description

An image for this paragraph.

Element: ImmigrationStatus [type AlienInfoType]

Description

Immigration Status on an Alien.

153

Element: Inactive [type GdsNegotiatedInfoType]

Description

The GDS Negotiated Rate is inactive or not.

Element: Inactive [type MembershipType]

Description

Indicates whether membership is active or inactive.

Element: Inactive [type NegotiatedInfoType]

Description

Negotiated Rate is inactive or not.

Element: InactiveDate [type WebUserHistoryType]

Description

Inactive date.

Element: Indicator [type IndicatorsType]

Attributes


IndicatorName StringLength80 No Name of the indicator.

Count integer No Indicates number of occurrences of the indicator.

Element: IndustryCode [type SalesInfoType]

Description

Defines the industry code.

Element: Influence [type SalesInfoType]

Description

Defines the influence for the contact profile.

Element: InfluenceCode [type ProfileType]

Description

Influence Code associated to the profile.

Element: Instructions [type HousekeepingTaskCodeType]

Description

Instructions for this Task Code.

Element: Instructions [type ResHousekeepingType]

Description

Turndown instructions for the room.

154

Element: InterfaceId [type HotelInterfaceType]

Description

Unique DB internal number of a Hotel Interface record.

Attributes








Element: InterfaceName [type HotelInterfaceType]

Description

Name of the Hotel Interface.

Element: InterfaceRights [type ReservationInterfaceStatusType]

Description

Contains a list of status/rights for the various services under this interface.

Content Model



1..1

Right integer 1..1 Internal code for each allowed right of a Hotel Interface record.

StatusCode StringLength5 1..1 User defined code for an Interface Right.

Description StringLength80 0..1 User defined description for an Interface Right.

Category StringLength1 1..1 Category code of this interface right.

155

Element: InterfaceType [type HotelInterfaceType]

Description

Three letter code for each interface that identifies the interface.

Enumeration

Value

BMS

CAS

CCW

DLS

EFT

EXP

MAK

MBS

MSC

PBX

POS

SVS

TIK

VID

VMS

WWW

XML

Element: InvBlock [type AvailRequestSegmentType]

Description

Inventory Block code whose Rate Availability is requested.

Attributes


Code CodeType No


Content Model



1..1

UniqueID UniqueID_Type 0..1

Element: IssuedCountry [type IdentificationType]

Description

156

The country where Identification was issued.

Element: IssuedDate [type IdentificationType]

Description

Issued date of Identification.

Element: IssuedPlace [type IdentificationType]

Description

The place where Identification was issued.

Element: Keyword [type ProfileType/Keywords]

Description

Collection of keywords attached to the profile.

Attributes


Type CodeType No The type of keyword.

Keyword StringLength80 No The keyword value.

Content Model



1..1

KeywordDetail KeywordDetailType 0..1 The new keyword value if the keyword value is modified.

Element: KeywordDetail [type KeywordType]

Description

The new keyword value if the keyword value is modified.

Attributes


NewKeyword StringLength80 No The new keyword value.

Element: Keywords [type ProfileType]

Description

List of customer keywords.

Attributes




157

Content Model



1..1

Keyword KeywordType 0..* Collection of keywords attached to the profile.

Element: Language [type AddressType]

Description

Language code associated with the address.

Element: Language [type OperaContextType]

Description

Hotel's language code.

Element: Language [type ResGuestInfoType]

Description

Default language.

Element: LastLogin [type WebUserHistoryType]

Description

Last login date.

Element: LastName [type ResAccompanyGuestInfoType]

Description

Family name, last name.

Element: LastName [type ResSharedGuestInfoType]

Description


Element: LastPasswordChange [type WebUserHistoryType]

Description

Last Password change date.

Element: LastPrivacyPromptDate [type ReservationInfoType]

Description

Last Privacy Prompt Date.

Element: LastRate [type LastStayInfoType]

Description

Used to hold last rate information for the profile.

Attributes

158




Element: LastRoom [type LastStayInfoType]

Description

Holds last room information for the profile.

Element: LastStayDate [type GuestLastStayInfoType]

Description

Guest's last stay date.

Element: LastStayInfo [type ProfileType]

Description

Information on last stay of the profile.

Content Model



1..1

LastVisit date 0..1 Holds last stay information for the profile.

LastRoom string 0..1 Holds last room information for the profile.

LastRate CurrencyAmountType 0..1 Holds last rate information for the profile.

TotalStay integer 0..1 The total number of previous stay of the profile.

Element: LastStayRate [type GuestLastStayInfoType]

Description

The Rate amount of the guest's last stay.

Attributes




Element: LastStayRoom [type GuestLastStayInfoType]

Description

Room number where the guest stayed.

Element: LastVisit [type LastStayInfoType]

Description

Used to hold last stay information for the profile.

159

Element: LegalCompany [type CustomerType]

Description

Name Of the company the individual is associated with.

Element: LinenChange [type HousekeepingTaskCodeType]

Description

Indicates if a linen change is necessary.

Element: LinenChange [type ResHousekeepingType]

Description

Indicates if a linen change is necessary.

Element: LogLevel [type OperaContextType]

Description

Log level to debug the code, such as FINE, FINER.

Enumeration

Value

SEVERE

WARNING

INFO

CONFIG

FINE

FINER

FINEST

ERROR

MESSAGE

DEBUG

TRACE

Element: Logo [type HotelInterfaceType]

Description

Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code

followed by an underscore (_). This tells us which DBF files and log files with the prefix that IFC7 is going

to create.

Element: LongDescription [type RoomTypeInfoType]

Description

Detail description of the Room Type.

Element: LongInfo [type RatePlanInfoType]

Description

160

Detail Information of the Rate Code.

Element: MachineName [type HotelInterfaceType]

Description

Unique machine name of the running IFC.

Element: MailingAction [type MailingActionsType]

Description

Defines mailing action code and description.

Attributes




Element: MailingActions [type ProfileType]

Description

Contains collection of mailing action list associated with the profile.

Attributes


Active boolean No When true, indicates the profile has subscribed to the mailing list.



Content Model



1..1

MailingAction CodeDescriptionType 0..* Defines mailing action code and description.

Element: MarketCode [type AvailRatePlanInfoType/RatePlan]

Description

Holds the market code.

Element: MarketCode [type StayInfoType]

Description

Market code.

Element: MasterInfo [type AvailResponseSegmentType]

Content Model

161



1..1

RoomTypes RoomTypeMasterInfoType 0..1 Collection of room type information.

RatePlans AvailRatePlanInfoType 0..1 Collection of rate plan information.

Element: MaximumRate [type RegionalParityRateType]

Element: MaxOccupancy [type RoomTypeAttributesType]

Description

Maximum occupancy of property room type.

Element: MaxRate [type AvailRequestSegmentType]

Description

Minimum rate amount to filter Rates for the Rate Availability Request.

Attributes




Element: Membership [type ResGuestInfoType]

Description

The Membership object identifying the frequent customer reward program.

Attributes


ProgramCode CodeType No The code or name of the membership program ('Hertz', 'AAdvantage').

BonusCode CodeType No The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member).

MembershipTypeDesc StringLength2000 No The description of the ProgramCode (Delta Privilege for code DP).

MembershipLevelDesc StringLength2000 No The description of the Bonus Code (Platinum for code P).

AccountID StringLength50 No The account identification number for this particular member in this particular program.

Element: MembershipClass [type MembershipType]

Description

Indicates the membership class.

162

Element: MembershipIDNo [type AvailRequestSegmentType]

Description

Membership ID number of the guest.

Element: MembershipLevel [type AvailRequestSegmentType]

Description


Element: MembershipLevel [type MembershipType]

Description

Indicates the membership level.

Element: MembershipLevelDescription [type MembershipType]

Description

Indicates the membership level description.

Element: MembershipNo [type ResAwardsType]

Description

Membership program under which the award is applied.

Attributes








Element: MembershipType [type AvailRequestSegmentType]

Description


163

Element: MiddleName [type PersonNameType]

Description

The middle name of the person name.

Element: MiddleName [type ResGuestInfoType]

Description

The middle name of the person name.

Element: MinimumRate [type RegionalParityRateType]

Element: MinRate [type AvailRequestSegmentType]

Description

Minimum rate amount to filter Rates for the Rate Availability Request.

Attributes




Element: MultiValueAttrs [type RoomStayType]

Description

Informative indicators indicating different values of an attribute exists over the stay.

Content Model



1..1

AttrName string 0..*

Element: Name [type ResAttachedProfileType]

Description

Attached profile name.

Element: NameOnCard [type MembershipType]

Description

Name to be displayed on the membership card.

Element: NamePrefix [type PersonNameType]

Description

Salutation of honorific (for example, Mr., Mrs., Ms., Miss, Dr.).

Element: NamePrefix [type ResGuestInfoType]

Description

164

Salutation of honorific (for example, Mr. Mrs., Ms., Miss, Dr.).

Element: NameSuffix [type PersonNameType]

Description

Hold various name suffixes and letters (for example, Jr., Sr., III, Ret., Esq.).

Element: NameSuffix [type ResGuestInfoType]

Description

Hold various name suffixes and letters (for example, Jr., Sr., III, Ret., Esq.).

Element: NameTitle [type PersonNameType]

Description

Degree or honors (for example, Ph.D., M.D.).

Element: NameTitle [type ResGuestInfoType]

Description

Degree or honors (for example, Ph.D., M.D.)

Element: NameTitleSuffix [type PersonNameType]

Description

Title Suffix. Must be populated if ADVANCED_TITLE is on.

Element: Nationality [type ResGuestInfoType]

Description

Affiliation or ethnicity to a particular country.

Attributes



Element: NegotiatedBy [type AvailRatePlanInfoType/RatePlan]

Description

If the Rate plan is negotiated by Guest or any attached profiles, this provides negotiation details.

Applicable values are Guest, Company, Agent, and Source.

Enumeration

Value

Guest

Agent

Company

Group

Source

Employee

165

Value

Hotel

Vendor

Contact

Purge

Business_Header

BillingAccount

Activity

Potential

Element: NegotiatedInfoList [type NegotiatedType]

Attributes




Content Model



1..1

CorporateAgreementId StringLength80 0..1 The master identifier for multiple offices/locations under the same company profile. This is optional.

ComissionCode CodeType 0..1 Informational purposes only in numeric format.


Inactive boolean 0..1 Negotiated Rate is inactive or not.

Element: NegotiatedRate [type ProfileType/NegotiatedRates]

Description

Collection of Detailed information on profile negotiated rates.

Attributes


HotelCode CodeType No Hotel code for the negotiated rate.

RateCode CodeType No Rate plan code for the negotiated rate.

Content Model



1..1

NegotiatedInfoList NegotiatedInfoType 0..*

166

Element: NegotiatedRates [type ProfileType]

Description

List of profile negotiated rates.

Attributes




Content Model



1..1

NegotiatedRate NegotiatedType 0..* Collection of Detailed information on profile negotiated rates.

Element: NewLoginName [type WebUserAccountType]

Description

New Login Name of the guest.

Element: NewMembershipID [type MembershipType]

Description

Card number of the membership.

Element: NewPassword [type WebUserAccountType]

Description

Login Password.

Element: Nights [type RegionalRateParitySearchType]

Element: NonRevenue [type ResRevenueBalanceType]

Description

Total Non Revenue posted on the reservation.

Attributes




Element: NoOfPhysicalRooms [type RoomTypeAttributesType]

Description

167

Number of physical rooms of property room type.

Element: NumberOfRooms [type StayInfoType]

Description

Room ID.

Element: NumericUDFs [type UserDefinedFieldsType]

Description

Collection of user defined fields of Numeric Type.

Content Model



1..1

UDF NumericUDFType 0..*

Element: OperaContext [type OperaWebServiceRQBaseType]

Description


Content Model



1..1

UserLanguage language 0..1 User's language code.

CROCode CodeType 0..1 Central Reservation office (CRO) code.

HotelCode CodeType 0..1 Hotel code.

Language CodeType 0..1 Hotel's language code.

RunningApplication StringLength3 0..1 Running Application. (Not supported)

TerminalId StringLength128 0..1 Terminal ID from where this request originated.

LogLevel LogLevelType 0..1 Log level to debug the code, such as FINE, FINER.

ExternalSystem StringLength80 1..1 External system code.

Override boolean 0..1 Opera context is derived internally by request but in case client wants to override the Opera Context it can send true and then the OperaContext will override the above settings such as HotelCode etc.

TargetExternalSystem StringLength80 0..1 This element carries ID of the External System that serves this request. It is needed only while making a call to External WebServices from OPERA UI through integration.

UseLocal boolean 0..1 Determines whether local system should be used and ignore the external system instead.

168

Element: OperaPingInput [element PingRQ]

Description

Optional Input for Ping operation.

Element: OperaVersion [element PingRS]

Description

OPERA version number.

Element: Order [type GdsNegotiatedInfoType]

Description

The sell order.

Element: Order [type NegotiatedInfoType]

Description

The sell order.

Element: OriginalTimeSpan [type RoomStayType]

Description

The Original Time Span (Arrival, Departure) that covers the Room Stay. In case of Rolling No Show

TimeSpan's StartDate moves forward but OriginalTimeSpan's StratDate remains the same.

Content Model



1..1

StartDate date 0..1

1..1


EndDate date 0..1

Element: OtherRevenue [type ResRevenueBalanceType]

Description

Other Revenue generated by the reservation.

Attributes




Element: Override [type OperaContextType]

Description

169

Opera context is derived internally by request. If the client wants to override the Opera Context, the client

can send true and then the OperaContext will override the above settings such as HotelCode.

Element: Package [type RoomRateType/Packages]

Attributes


PackageCode string Yes

CalculationRule string No

PostingRhythm string No

Quantity int No

IncludedInRate boolean No

AddRateSeprateLine boolean No

AddRateCombinedLine boolean No

StartTime time No

EndTime time No

SellSeparate boolean No

Content Model



1..1

Amount CurrencyAmountType 0..1

Allowance CurrencyAmountType 0..1

Description StringLength2000 0..*

StartDate date 0..1

EndDate date 0..1

Element: Packages [type RoomRateType]

Content Model



1..1

Package PackageElementType 0..*

Element: Parameter [type ParametersType]

Description

Collection of generic Name-Value-Pair parameters.

Content Model


170


1..1

ParameterName string 0..1 Name of the parameter.

ParameterValue string 0..1 Value of the parameter.

Element: ParameterName [type ParameterType]

Description

Name of the parameter.

Element: ParameterValue [type ParameterType]

Description

Value of the parameter.

Element: PartyCode [type StayInfoType]

Description

Party code.

Element: PaymentCard [type ReservationPaymentMethodType]

Attributes


CardType CardTypeType No Indicates the type of credit card.

CardNumber StringLength80 No

CardNumberMasked StringLength80 No

ExpirationDate date No Expiration date of the credit card.

ExpirationDateMasked StringLength20 No Masked Expiration date of the credit card.

ExpirationDateExpired boolean No

CardHolderName StringLength200 No

AttachCreditCardToProfile boolean No Attach the credit card to profile.

Processing CardProcessingType No This contains information on if EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type.

Swiped boolean No

CardNumberType CardNumberTypeType No This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type.

Content Model


171


1..1

CardId UniqueID_Type 0..1 Credit card ID.

CurrentAuthorizedAmount CurrencyAmountType 0..1

ApprovalAmountNeeded CurrencyAmountType 0..1

Element: PaymentDueDays [type ProfileCashieringType]

Description

Ability to define on the account, the number of days after which the invoice should be paid.

Element: PenaltyDescription [type CancelPenaltyType]

Description

Text description of the Penalty in a given language.

Element: Percent [type AuthorizationRuleType]

Description

A percentage value if the authorization rule is percentage based.

Element: PeriodicFolio [type ResCashieringType]

Description

Information regarding periodic folios set on the reservation.

Attributes


LastSettlementDate date No Latest date when a direct bill settlement was automatically done using the "Direct Bill Batch Folios" option.

LastFolioDate date No Latest date when a folio was printed using the "Periodic Batch Folios" option.

Frequency integer No Frequency in number of days when folios should be printed for this reservation.

Element: PersonName [type CustomerType]

Description

Detailed name information for the customer.

Attributes


NameType PersonNameTypeType No Type of name of the individual, such as former, nickname, alternate or alias name.

Language CodeType No Language code associated with an alternate name.

ExternalSystem StringLength40 No When name type is external, indicates the external system the name belongs to.

172

Content Model



1..1

NamePrefix StringLength40 0..1 Salutation of honorific (for example, Mr., Mrs., Ms., Miss, Dr.).

GivenName StringLength40 0..1 Given name, first name or names.


Surname StringLength40 0..1 Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts (for example, the surname element may be used to pass the full name).



NameTitleSuffix integer 0..1 Title Suffix. Must be populated if ADVANCED_TITLE is on.

EnvelopeGreeting string 0..1 Envelope Greeting of the profile.

Salutation string 0..1 Salutation of the profile.

Element: PhoneNumber [type ResGuestInfoType]

Description

Phone number.

Element: PingRQ

Description

Request for Ping operation.

Attributes


EchoToken StringLength128 No A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message MUST include an echo token with an identical value.



173



Content Model



1..1


OperaPingInput OperaPingRequestType 0..1 Optional Input for Ping operation.

Element: PingRS

Description

Response for Ping operation.

Attributes






Content Model



1..1

1..1


1..1



OperaVersion OperaVersionNumberType 0..1 OPERA version number.

174

Element: Points [type StayInfoType]

Description

The Points contains the number of points used to book a particular room type.

Attributes



Points integer No Number of points required to book this Room Stay.

Element: Policy [type ResDepositPolicyType]

Description

Reservation deposit policy details.

Attributes


PolicyCode CodeType No Deposit Policy Code.


Content Model



1..1

AmountPercent PolicyAmountPercentType 0..1 Payment expressed as a fixed amount or a percentage of/or room nights.

Deadline PolicyDeadlineType 0..1 Payment deadline, absolute or relative.

Description StringLength2000 0..1 Text description of the Payment in a given language.

Element: PolicyID [type ResDepositPolicyType]

Description

Unique ID of the Reservation Policy.

Attributes





175





Element: PostalCode [type AddressSearchType]

Description

Post Office Code number.

Element: PostalCode [type AddressType]

Description

Post Office Code number.

Element: PostingDate [type ReservationDepositType]

Description

Deposit Posting Date.

Element: Preference [type PreferenceTypeType]

Description

Collection of Preferences for the profile.

Attributes


PreferenceId CodeType No

Content Model



1..1

PrefValue StringLength200 0..1 Preference value for display purposes.

Description StringLength2000 0..1 Preference Description for display purposes.

Global boolean 0..1 Whether this preference is property specific or not.

Source StringLength40 0..1 Source of the preference.

Hotels CodeType 0..* If specified preference belongs to the Hotels listed; otherwise, it is a global preference.

Element: PreferenceCollection [type ProfileType]

Description

List of customer preferences.

176

Attributes


AllRowsFetched boolean No Indicates if all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response.


Content Model



1..1

PreferenceType PreferenceTypeType 0..* Collection of Detailed information on preferences of the customer.

Element: PreferenceType [type ProfileType/PreferenceCollection]

Description

Collection of Detailed information on preferences of the customer.

Attributes


PrefType CodeType No Preference group code.

PrefTypeDescription string No Preference group description.

OrderValue string No Preference Sequence.

MaxQuantity integer No Maximum quantity of preferences allowed per preference group.

AvailableQuantity integer No Available quantity of preferences (maximum quantity - Existing preferences) per preference group.

MaxResortUsedQuantity integer No Maximum quantity of preferences used by any resort per preference group.

ReservationPreference boolean No Whether this preference is reservation preference or not.

Content Model



1..1

Preference PreferenceType 0..* Collection of Preferences for the profile.

Element: PreferredRoom [type SalesInfoType]

Description

Defines the Preferred Room for profile.

177

Element: PrefValue [type PreferenceType]

Description

Preference value for display purposes.

Element: PrintAutoAdjust [type TaxTypeType]

Description

Print auto adjust information for this tax type on the tax exempt report.

Element: Priority [type SalesInfoType]

Description

Defines the priority.

Element: PriorityDescription [type WaitlistResType]

Description

Waitlist priority Description.

Element: PrivacyInfo [type ProfileType]

Description

Contains privacy related information associated with the profile.

Attributes


MarketResearchParticipation boolean No Indicates if the profile participates in market research.

InfoFromThirdParty boolean No Indicates if the profile accepts information from third parties.

AutoEnrollLoyaltyProgram boolean No Indicates if the profile wants to be automatically enrolled in the property's loyalty program.

AllowPhone boolean No Indicates if the profile wants to allow phone calls.

AllowSMS boolean No Indicates if the profile wants to allow SMS.

AllowEmail boolean No Indicates if the profile wants to allow email.

OptInMailingList boolean No Indicates if the profile wants to opt in for Mailing List.

OptInMarketResearch boolean No Indicates if the profile wants to opt in for Market Research.

OptInThirdParty boolean No Indicates if the profile wants to opt in for Third Party.

OptInAutoEnrollmentMember boolean No Indicates if the profile wants to opt in for Auto Enrollment Member.

OptInPhone boolean No Indicates if the profile wants to opt in for Phone.

OptInSms boolean No Indicates if the profile wants to opt in for SMS.

178


OptInEmail boolean No Indicates if the profile wants to opt in for email.

Element: Profession [type CustomerType]

Description

Profession of a person.

Element: Profile [type ResProfileType]

Description

Provides detailed information regarding either a company or a customer profile.

Attributes




RegisteredProperty CodeType No Hotel which this profile is registered with. This attribute is not used for configuration.

RequestForHotel CodeType No Hotel which this profile is to be registered. This attribute is only used during creation of profile.

ProtectedBy StringLength40 No What level this profile is protected.






MarkAsRecentlyAccessed boolean No Mark this profile as recently accessed.

MarkForHistory boolean No A value of true marks the profile to be kept from being purged, once the profile is marked inactive.

hasCommission boolean No Populates true if the profile has commission configured false otherwise.

Content Model



1..1

1..1

179


Company CompanyType 0..1 Detailed company information for this profile.

Customer CustomerType 0..1 Detailed customer information for this profile.

Addresses anyType (restriction) 0..1 List of customer addresses.

BusinessSegments anyType (restriction) 0..1 Business/Market Segments associated to the profile.

Territory StringLength40 0..1 Territory associated to the profile.

TraceCode StringLength40 0..1 Trace Code associated to the profile.

InfluenceCode StringLength40 0..1 Influence Code associated to the profile.

Telephones anyType (restriction) 0..1 List of telephone number information.

Emails anyType (restriction) 0..1 List of email addresses for the customer.

URLs anyType (restriction) 0..1 List of Information on a URL for the customer.

Comments anyType (restriction) 0..1 List of Notes for the customer.

ProfileMemberships anyType (restriction) 0..1 List of loyalty program(s) the profile subscribes to.

PreferenceCollection anyType (restriction) 0..1 List of customer preferences.

Keywords anyType (restriction) 0..1 List of customer keywords.

NegotiatedRates anyType (restriction) 0..1 List of profile negotiated rates.

GdsNegotiatedRates anyType (restriction) 0..1 List of channel negotiated rates that this profile has been assigned to.

ProfileIndicators IndicatorsType 0..1 Indicators of additional information attached to the profile.

Relationships anyType (restriction) 0..1 Contains a collection of profiles that have a relationship with this profile.

ReservationInfoList ReservationHistoryFutureInfoType 0..1 Collection of Detailed information on history and future reservations associated with the profile.

LastStayInfo LastStayInfoType 0..1 Information on last stay of the profile.

ProfileAccessType ProfileAccessType 0..1 Detailed information on access type associated with the profile.

ProfileRestrictions ProfileRestrictions 0..1 Detailed information on restrictions associated with the profile.

MailingActions MailingActionsType 0..1 Contains collection of mailing action list associated with the profile.

PrivacyInfo PrivacyInfoType 0..1 Contains privacy related information associated with the profile.

Cashiering ProfileCashieringType 0..1 Contains cashiering related details for the profile.

CommissionInfoList anyType (restriction) 0..1 List of commission details for the profile. Only available for account profiles such as Travel agent and source.

180


UserDefinedFields UserDefinedFieldsType 0..1 Collections of user defined fields.

WebUserAccounts WebUserAccountsType 0..1 List of Web User Accounts of the profile.

TaxInfo ProfileTaxInfoType 0..1 Profile information about tax.

SalesInfo SalesInfoType 0..1 Sales information of the profiles.

Element: ProfileAccessType [type ProfileType]

Description

Detailed information on access type associated with the profile.

Attributes


SharedLevel ProfileSharedLevelType No Indicates whether the profile is shared at the following levels: global/property/CRO.

Content Model



1..1

ChainCode StringLength200 0..1 Indicates the Chain code where the profile was created.

CROCode StringLength200 0..1 Indicates the CRO code where the profile was created.

HotelCode StringLength200 0..1 Indicates the Hotel code where the profile was created.

Element: ProfileID

Attributes






181




Element: ProfileIDList [type RelationshipProfileType]

Description

Original profile details for which the relationships was created

Content Model



1..1


Element: ProfileIDList

Content Model



1..1


Element: ProfileIndicators [type ProfileType]

Description

Indicators of additional information attached to the profile.

Content Model



1..1


Element: ProfileMembership [type ProfileType/ProfileMemberships]

Description

Collection of Detailed information on memberships for the customer.

Attributes


MembershipID string No Card number of the membership.


182



MembershipIDNo integer No Membership ID number.




ExpireDateExclusiveIndicator boolean No When true, indicates that the ExpireDate is the first day after the applicable period (for example, when expire date is Oct 15 the last date of the period is Oct 14).


Content Model



1..1

Comment ParagraphType 0..1 Additional comments regarding to the membership.

NewMembershipID string 0..1 Card number of the membership.








Element: ProfileMemberships [type ProfileType]

Description

List of loyalty program(s) the profile subscribes to.

Attributes

183




Content Model



1..1

ProfileMembership ProfileMembershipType 0..* Collection of Detailed information on memberships for the customer.

Element: ProfileRestrictions [type ProfileType]

Description

Detailed information on restrictions associated with the profile.

Attributes


Restricted boolean Yes True value indicates there are restrictions associated with the current profile.

Content Model



1..1

Reason CodeType 0..1 Restriction reason associated with the current profile.

ReasonDescription StringLength2000 0..1 Description of restriction reason.

Element: ProgramDescription [type MembershipType]

Description

Description of the membership program.

Element: Promotion [type PromotionsType]

Description

Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is

applied to the reservation.

Attributes



CouponCode StringLength40 No Promotion Coupon Code when promotion is setup to have a valid coupon code.

184

Element: Promotion [type RoomStayType]

Description

Promotions applied to the reservation to get the promotional rate.

Attributes



CouponCode StringLength40 No Promotion Coupon Code when promotion is setup to have a valid coupon code.

Element: Promotions [type RatePlanCandidatesType]

Description

Promotion Codes to fetch Rate Plans associated with the promotions.

Content Model



1..1

Promotion PromotionType 0..* Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.

Element: QualifyingProfile [type RegionalRateParityFilterType]

Attributes


QualifyingProfileCategory StringLength20 No

QualifyingProfileId StringLength20 No

Element: Quantity [type FacilityCodeType]

Description

Signifies the quantity.

Element: Quantity [type RoomStaySearchType]

Element: Queue [type ReservationInfoType]

Description

Information about the time and duration this reservation was on Queue for Check-in.

Attributes


Priority integer No The Queue Priority given to this reservation.

185


AvgQueueTimeToCheckIn integer No The average time, in seconds, a reservation was on queue prior to Check-in.

AvgQueueTimeCurrentReservations integer No The average time, in seconds, of the reservations currently in queue.

QueueDate date No The Business date on which the reservation was due to arrive and is currently placed on Queue for Check-in.

Content Model



1..1

TimeSpan TimeSpanType (extension)

1..1 Start and End times on the Queue for the reservation.

Element: Rate [type RatesType]

Description

The Rate contains a collection of elements that define the amount of the rate, associated fees, additional

occupant amounts. Taxes can be broken out or included within the various amounts. A currency can be

associated to each amount.

Attributes




Content Model



1..1

Base TotalType 0..1 The base amount charged for the accommodation or service per unit of time (for example, Nightly, Weekly). If TaxInclusive is set to True, taxes are included in the base amount. Additional charges should be itemized in the other elements.

AdditionalGuestAmounts anyType (restriction) 0..1 A collection of charges that applies to additional occupants, guests or service users (over and above the rate's MaxGuest Applicable).

Discount DiscountType 0..1 Discount percentage and/or Amount, code and textual reason for discount.

186


ShareRatePercentage Percentage 0..1 Indicates the share rate percentage for the reservation if set to CUSTOMSPLIT.

ShareDistributionInstruction ShareDistributionInstructionType 0..1 Last rate share distribution instruction applied on share reservation daily rate segment.

Total TotalType 0..1 The total amount charged for this rate including additional occupant amounts and fees.

RequiredPoints PointsType 0..1 The Points contains the number of points required to book a particular room type.

Element: RateAccessCode [type RegionalRateParityFilterType]

Element: RateAmount [type StayInfoType]

Description

Rate amount.

Attributes




Element: RateCommission [type AvailRatePlanInfoType/RatePlan]

Description

Commission details for Rate plan code.

Content Model



1..1

CommissionCode CodeType 0..1 Commission code used by the rate plan.

CommissionPercentage double 0..1 Commission percentage used by the rate plan.

Element: RatePlan [type AvailRatePlanInfoType]

Description

Rate plan information

Attributes


HotelUseOnly boolean No If true, indicates this rate is not allowed to be sold by CRO. For CRO, this is information only.

187


DiscountAllowed boolean No If true, indicates additional discount could be applied on the Rate.

RatePlanCode StringLength20 No

HotelCode StringLength20 No

RatePlanCategory StringLength20 No

Content Model



1..1

ShortInfo StringLength2000 0..1 Brief Information of the Rate Code.

LongInfo StringLength2000 0..1 Detail Information of the Rate Code.

WebPage StringLength2000 0..1 URL providing more information about the Rate Code.

Description StringLength2000 0..1 Description of the Rate Code.

CurrencyCode CodeType 1..1 Currency Code of the rate code.

BookingChannelMappings anyType (restriction) 0..1 Collection of Booking Channels mapping for the Rate Plan Code.

RateCommission RatePlanCommissionType 0..1 Commission details for Rate plan code.

ResGuarantees GuaranteePoliciesType 0..1 A collection of Guarantee Codes information with cancellation penalty and deposit policy information.

NegotiatedBy ProfileTypeType 0..1 If Rate plan is negotiated by Guest or any attached profiles, this indicates negotiation details. Applicable values are Guest, Company, Agent, and Source.

MarketCode CodeType 0..1 Holds the market code.

SourceOfBusiness CodeType 0..1 Holds the source code.

Element: RatePlanCandidates [type AvailRequestSegmentType]

Description

Contains rate Plan and its classification related filters for the Rate Availability Request.

Attributes


RateCategory CodeType No

RateClass CodeType No

RateGroup CodeType No

PrevailingRate boolean No

ElectronicCertificate StringLength40 No

Content Model

188



1..1

RatePlanDescription StringLength2000 0..1 Rate Plan Description string to filter rate plans.


Promotions PromotionsType 0..1 Promotion Codes to fetch Rate Plans associated with the promotions.

Element: RatePlanCode [type AvailHotelResType]

Description

Reservation's Current Rate plan code that is of interest.

Element: RatePlanCode [type RatePlanCandidatesType/RatePlans]

Element: RatePlanCode [type RegionalRateParityFilterType/RatePlans]

Element: RatePlanCode [type StayInfoType]

Description

Rate plan code.

Element: RatePlanDescription [type RatePlanCandidatesType]

Description

Rate Plan Description string to filter rate plans.

Element: RatePlans [type AvailResponseMasterInfoType]

Description

Collection of rate plan information.

Attributes


HotelCode CodeType No

Content Model



1..1

RatePlan RatePlanInfoType (extension)

0..* Rate plan information.

Element: RatePlans [type RatePlanCandidatesType]

Content Model



1..1

189


RatePlanCode CodeType 0..*

Element: RatePlans [type RegionalRateParityFilterType]

Content Model



1..1

RatePlanCode StringLength20 0..*

Element: Rates [type RoomRateType]

Content Model



1..1

Rate AmountType 0..* The Rate contains a collection of elements that define the amount of the rate, associated fees, additional occupant amounts. Taxes can be broken out or included within the various amounts. A currency can be associated to each amount.

Element: RateSuppressed [type StayInfoType]

Description

Whether this rate should be suppressed from view.

Element: Reason [type ProfileRestrictions]

Description

Restriction reason associated with the current profile.

Element: ReasonDescription [type ProfileRestrictions]

Description

Description of restriction reason.

Element: ReasonDescription [type WaitlistResType]

Description

Waitlist Reason Description.

Element: RegionalParityGroup [type RegionalRateParityType/RegionalParityGroups]

Description

Channels and Property combination.

Attributes

190


HotelCode StringLength20 No The code that identifies a Hotel.

BookingChannelCode StringLength20 No The code that identifies a Booking Channel.

BookingChannelURL StringLength2000 No

BookingChannelIconURL StringLength2000 No

Content Model



1..1

RegionalParityRates anyType (restriction) 0..1 Collection of Minimum and Maximum Rates for different Arrival Dates.

Element: RegionalParityGroups [type RegionalRateParityType]

Description

Collection of Channels and Property combinations.

Content Model



1..1

RegionalParityGroup RegionalParityGroupType 0..* Channels and Property combination.

Element: RegionalParityRate [type RegionalParityGroupType/RegionalParityRates]

Description

Minimum and Maximum Rate on specific arrival date.

Attributes


ArrivalDate date Yes Arrival Date.

WeekendDay boolean No

CurrencyCode AlphaLength3 No

StatusCode StringLength80 No Status Code related to functionality.

StatusDescription StringLength2000 No Description of Status Code.

Content Model



1..1

MinimumRate Money 0..1

MaximumRate Money 0..1

191

Element: RegionalParityRates [type RegionalParityGroupType]

Description

Collection of Minimum and Maximum Rates for different Arrival Dates.

Content Model



1..1

RegionalParityRate RegionalParityRateType 0..* Minimum and Maximum Rate on specific arrival date.

Element: RegionalRateParity [element RegionalRateParityRS]

Description

Information on Room rate parity among channels or hotels.

Attributes




Content Model



1..1

RegionalParityGroups anyType (restriction) 0..1 Collection of Channels and Property combinations.

HotelsInfo anyType (restriction) 0..1

BookingChannelsInfo anyType (restriction) 0..1

Element: RegionalRateParityFilter [type RegionalRateParitySearchType]

Content Model



1..1

Hotels anyType (restriction) 0..1

BookingChannels anyType (restriction) 0..1


ChannelRatePlans anyType (restriction) 0..1

Cities anyType (restriction) 0..1

Regions anyType (restriction) 0..1

ChainCode StringLength20 0..1

192


RateAccessCode StringLength20 0..1

QualifyingProfile QualifyingProfileType 0..1

Element: RegionalRateParityRQ

Description

Request object to fetch regional rate parity.

Attributes






Content Model



1..1


RegionalRateParitySearchCriteria RegionalRateParitySearchType 0..1 A collection of search criteria to fetch Rate Parity.

Element: RegionalRateParityRS

Description

Response object to fetch regional rate parity.

Attributes

193






Content Model



1..1

1..1


1..1



RegionalRateParity RegionalRateParityType 0..1 Information on Room rate parity among channels or hotels.

Element: RegionalRateParitySearchCriteria [element RegionalRateParityRQ]

Description

A collection of search criteria to fetch Rate Parity.

Attributes


ComparisonType string Yes An enumerated type defining the Parity Comparison type. Values: FIRST_RATES, CHANNEL_RATES. CHANNEL_RATES requires HotelCode and BookingChannelCode as part of request.

CurrencyCode AlphaLength3 No

NumberOfDays integer Yes



194

Content Model



1..1

HotelCode StringLength20 0..1

BookingChannelCode StringLength20 0..1

Arrival date 0..1

Adults integer 0..1

Nights integer 0..1

Children integer 0..1

RegionalRateParityFilter RegionalRateParityFilterType 0..1

Element: RegionCode [type RegionalRateParityFilterType/Regions]

Element: Regions [type RegionalRateParityFilterType]

Content Model



1..1

RegionCode StringLength40 0..*

Element: RegistrationCardNo [type ResAccompanyGuestInfoType]

Description

Unique identifier of the police registration card number.

Element: RegistrationCardNo [type ResGuestInfoType]

Description

Unique identifier of the police registration card number.

Element: Relationship [type ProfileType/Relationships]

Description

A collection of the profiles that have a relationship with this profile.

Attributes




RelationDescription StringLength200 No Displays the description of the relationship between the current profile and the related profile.


195



Content Model



1..1

ChangeRelationship ChangeRelationsType 0..1 Information about the changes in relationship for the profile

RelationshipProfile RelationshipProfileType 0..1 Refer to Relationship Profile type document.

Element: RelationshipProfile [type RelationshipInfoType]

Description

Refer to Relationship Profile type document.

Attributes


Primary CodeType No Indicates if this relationship is the primary relationship.




Content Model



1..1

1..1

Company CompanyType 0..1 Detailed information of the Company.

Customer CustomerType 0..1 Detailed information of the customer.

Telephone TelephoneInfoType 0..1 Information on telephone details for the customer/company.

Address AddressInfoType 0..1 Information on address details for the customer/company.

Email EmailInfoType 0..1 Information on email address for the customer/company.

URLs URLInfoType 0..1 Information on web URL/address for the customer/company.

ProfileIDList UniqueIDListType 0..1 Original profile details for which the relationships was created.

ChangeProfileIDList UniqueIDListType 0..1 Updated/changed profile details for the relationships created.

196

Element: Relationships [type ProfileType]

Description

Contains a collection of profiles that have a relationship with this profile.

Attributes




Content Model



1..1

Relationship RelationshipInfoType 0..* A collection of the profiles that have a relationship with this profile.

Element: ReportExemptDays [type TaxTypeType]

Description

Number of days after which the guest will be tax exempt. Only used for tax exempt report.

Element: ReportTaxPerc [type TaxTypeType]

Description

Tax percentage. Only used for tax exempt report.

Element: RequiredPoints [type AmountType]

Description

The Points contains the number of points required to book a particular room type.

Attributes



Points integer No Numbe of points required to book this Room Stay.

Element: Requirements [type GuaranteeType]

Description

Specifies various requirements for the guarantee code.

Attributes


PhoneNumber boolean No When true, indicates phone number on the reservation is required for this guarantee code.

197


Address boolean No When true, indicates address on the reservation is required for this guarantee code.

CreditCard boolean No When true, indicates Credit Card on the reservation is required for this guarantee code.

ArrivalTime boolean No When true, indicates arrival Time on the reservation is required for this guarantee code.

Deposit boolean No When true, indicates deposit is required for this guarantee code.

Element: ResAttachedProfiles [type AvailRequestSegmentType]

Description

Travel Agent, Company, or Source profiles associated with the Rate Availability request. This element is

used usually to get negotiated rates.

Content Model



1..1


Element: ReservationBlock [type RoomRateType]

Description

Key information about the block for this reservation.

Attributes



Content Model



1..1


0..1

BlockName StringLength40 0..1 The Name of the block attached to the reservation.

Element: ReservationBlock [type StayInfoType]

Description

Key information about the block for this reservation.

Attributes



198

Content Model



1..1


0..1

BlockName StringLength40 0..1 The Name of the block that is attached to the reservation.

Element: ReservationIDList

Content Model



1..1


Element: ReservationIndicators [type ReservationInfoType]

Description

Indicators of additional information attached to the reservation.

Content Model



1..1


Element: ReservationInfo [type FutureListType]

Description

Additional reservation information attached to the profile (for example, future reservation details).

Attributes



HotelName StringLength80 No





199







AccessRestriction ResAccessRestrictionType No Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both.







Content Model



1..1






200



Specials StringLength4000 0..1 Set of reservation preferences which belongs to the Specials group.







Queue ReservationQueueInformationType 0..1 Information about the time and duration this reservation was on Queue for Check-in.







HotelInterfaceStatusList ReservationInterfaceStatusType 0..* Collection of Hotel Interfaces and rights populated only when fetching interface status for rooms.



201



Element: ReservationInfo [type HistoryListType]

Description

Additional reservation information attached to the profile (for example, history reservation details).

Attributes



HotelName StringLength80 No










AccessRestriction ResAccessRestrictionType No Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both.





202




Content Model



1..1







Specials StringLength4000 0..1 Set of reservation preferences which belongs to the Specials group.







203


Queue ReservationQueueInformationType 0..1 Information about the time and duration this reservation was on Queue for Check-in.







HotelInterfaceStatusList ReservationInterfaceStatusType 0..* Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms.




Element: ReservationInfoList [type ProfileType]

Description

Collection of Detailed information on history and future reservations associated with the profile.

Content Model



1..1

HistoryList HistoryListType 0..1 Refer to History list type document.

FutureList FutureListType 0..1 Refer to Future list type document.

Element: ReservationPaymentMethod [type ReservationInfoType]

Description

Payment method used for this reservation

Attributes

204


PaymentMethod CodeType No


FolioView integer No

Content Model



1..1

PaymentCard ResPaymentCardType 0..1

Balance CurrencyAmountType 0..1

AuthorizationRule AuthorizationRuleType 0..1

EmailFolioInfo EmailInfoType (extension)

0..1 Information element for Email Folio functionality.

Element: ResGuarantee [type GuaranteePoliciesType]

Description

Guarantee Code information with cancellation penalty and deposit policy information.

Attributes


GuaranteeCode CodeType No Code assigned to the Guarantee.




Content Model



1..1




CancelPenalty ResCancelPenaltyType (extension)

0..1 Defines the cancellation penalty of the hotel facility.

DepositPolicy ResDepositPolicyType (extension)

0..1 Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.

Element: ResGuarantees [type AvailRatePlanInfoType/RatePlan]

Description

205

A collection of Guarantee Codes information with cancellation penalty and deposit policy information.

Content Model



1..1

ResGuarantee GuaranteePolicyType 0..* Guarantee Code information with cancellation penalty and deposit policy information.

Element: ResGuest [type ReservationInfoType]

Description

Collection of guests associated with the reservation.

Attributes


NameType NameTypeType No

Content Model



1..1

UniqueID UniqueID_Type 0..1 Unique identifier of this reservation guest.

Membership MembershipInfoType 0..1 The Membership object identifying the frequent customer reward program.

NamePrefix NamePrefixType 0..1 Salutation of honorific (for example, Mr. Mrs., Ms., Miss, Dr.).


AltGivenName StringLength40 0..1 Alternate given name, first name or names.


SurnamePrefix StringLength20 0..1 For example, "van der", "von", "de".


AltSurname StringLength40 0..1 Alternate family name, last name.



FullName string 0..1 Full display name.

AltFullName string 0..1 Altername full display name.

PhoneNumber PhoneNumberType 0..1 Phone number.

206


Email BasicEmailType 0..1 Email address.

BirthDate date 0..1 Date of birth.

Language LanguageType 0..1 Default language.

Nationality CountryNameType 0..1 Affiliation or ethnicity to a particular country.

VIP VIPType 0..1 The supplier's ranking of the customer (for example, VIP, numerical ranking).

Address AddressSearchType 0..1 Address information that is attached to the reservation guest.

AccompanyGuests ResAccompanyGuestListType 0..1 List of guest names that are accompanying the reservation guest.

ExternalInfo ResGuestExternalInfoType 0..1 External information about the guest associated with the reservation.

GuestLastStayInfo GuestLastStayInfoType 0..1 Contains information regarding the last stay of this guest.

GuestRestrictedCode string 1..1 Guest profile restricted reason code.

GuestRestrictedReasonDesc string 1..1 Guest profile restricted reason description.

GuestRestricted boolean 1..1 True indicates there are restrictions associated with the current profile.


Element: ResGuestID [type AvailRequestSegmentType]

Description

Reservation Guest's Unique ID. This element is used usually to get negotiated rates.

Attributes





207





Element: ResPreConfiguredRoutingInstruction [type ResCashieringType]

Description

Information regarding the selected preconfigured routing instruction on the reservation.

Attributes


RatePlanCode CodeType No This denotes the rateCode attached with the routing instruction of rateCode type.

ProfileType ResProfileTypeType No This stores the profile type attached with the preconfigured routing instruction.

Element: RevenuesAndBalances [type ResCashieringType]

Description

Revenues and Balances Amount summary for the reservation.

Content Model



1..1









Element: RevenuesAndBalances [type ReservationInfoType]

Description

Revenues and Balances Amount summary for the reservation.

Content Model

208



1..1









Element: RevenueType [type ResDepositPolicyType]

Description

Type of reservation.

Enumeration

Value

Rooms

Catering

All

Element: Right [type InterfaceRightsStatusType]

Description

Internal code for each allowed right of a Hotel Interface record.

Element: RoomClass [type RoomStayCandidatesType/RoomClasses]

Element: RoomClass [type StayInfoType]

Description

Room class code.

Element: RoomClasses [type RoomStayCandidatesType]

Content Model



1..1

RoomClass CodeType 0..*

Element: RoomExtension [type ReservationInterfaceStatusType]

Description

209

Identifier for the room extension.

Element: RoomFeature [type RoomFeaturesType]

Description

A recurring element that identifies the room features.

Attributes


Code CodeType No A code representing a room feature.

Description StringLength2000 No A code representing a room feature.


Element: RoomFeatures [type RoomTypeInfoType]

Description

Collection of room features.

Content Model



1..1

RoomFeature RoomFeatureType 0..* A recurring element that identifies the room features.

Element: RoomNumber [type CurrentRoomInfoType]

Description

Current room number.

Element: RoomNumber [type StayInfoType]

Description

Room ID.

Element: RoomRate [type RoomStayType/RoomRates]

Attributes


RoomType CodeType Yes

RatePlanCode CodeType No



Availability RoomRateAvailReasonType No Specifies an availability status for the room rate. When available, the value could be either not specified or "Available".

210


SuppressRate boolean No

MarketCode CodeType No The code that relates to the market being sold to (for example, the corporate market, packages).

MarketCodeDescription StringLength4000 No Description of the market code.

SourceOfBusiness CodeType No To specify where the business came from (for example, radio, newspaper ad).

SourceOfBusinessDescription StringLength4000 No Description of the source of business.

NumberOfUnits integer No The number of rooms.

RoomID CodeType No A string value representing the unique identification of a room.

PseudoRoom boolean No True indicates as pseudo room type. This is usually used for a posting master reservation.

RoomTypeCharged CodeType No Room Type used for the Rate calculation.

CommissionCode CodeType No Commission Code applicable for commission calculation for Travel Agent/Company.

Commissionable boolean No Indicates Commission is applicable for commission calculation for Travel Agent/Company.

HouseUseOnly boolean No Indicates this reservation is for House use.

Complimentary boolean No Indicates this reservation rate is complimentary.

InventoryLender string No Indicates whether the room type inventory was taken from the allotment or House availability.

FixedRate boolean No Fixed Rate Indicator.

BarRanking integer No Best Available rates ranking.

RateGroup CodeType No For RatePlanSet equals BESTAVAILABLERATE, in case Rate Groups are enabled the element provides the rate group for the rate plan code.

DiscountAllowed boolean No Indicates if the Rate Code is discountable; that is, discounts are allowed on the rate code.

BOGODiscount boolean No Indicates if the Rate Code has BOGO (Bye one Get one) indicator.

Content Model

211



1..1

Total TotalType 0..1

TotalPoints PointsType 0..1

Rates RatesType 0..1

Packages anyType (restriction) 0..1

StayProfiles anyType (restriction) 0..1 Profile associated with the room Stay.

GuestCounts GuestCountsType 0..1 A collection of Guest Counts associated with the room rate.

TaxFreeGuestCounts GuestCountsType 0..1 A collection of Tax Free Guest Counts associated with the room rate. This list does not add to the guest count but just indicates number of tax free guests out of guest counts.

Awards ResAwardsType 0..1 Membership Awards code applied on the reservation.

ForeignExchange ForeignExchangeType 0..1 Exchange Type information for the postings.


RoomRateInfo StringLength2000 0..1 Information about the Room Rate Combination.

Element: RoomRateInfo [type RoomRateType]

Description

Information about the Room Rate Combination.

Element: RoomRates [type RoomStayType]

Description

A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can

have multiple rates. Example: King room, Rack rate plan, Monday through Thursday, weekday amount,

Friday and Saturday, weekend amount.

Content Model



1..1

RoomRate RoomRateType 0..*

Element: RoomRevenue [type ResRevenueBalanceType]

Description

Room Revenue generated by the reservation.

Attributes

212




Element: RoomsPotential [type SalesInfoType]

Description

Defines the rooms potential.

Element: RoomStatus [type ReservationInfoType]

Description

Current room status.

Enumeration

Value

Clean

Dirty

Pickup

Inspected

Out Of Order

Out Of Service

Element: RoomStay [type AvailRequestSegmentType]

Description

Room Stay detail for the Availability Request. It includes availability request time span, number of rooms

requested, and persons staying. Date range can also be specified by using start dates and number of

nights.

Content Model



1..1

TimeSpan TimeSpanType 0..1

Quantity integer 0..1


FullStayTimeSpan TimeSpanType 0..1 When FullStayTimeSpan element is present, it indicates the availability request is to get different room rates for the particular nights (defined by TimeSpan element) within the full stay. This is usually used to for a Rate code changes during the reservation. This information allows House or Room Type level restrictions to be based on full stay in case of a partial stay availability search.

213

Element: RoomStay [type AvailResponseSegmentType/RoomStays]

Attributes



PrintRate boolean No This controls if the rate information will be printed in confirmation letter.

OwnerResType OwnerResTypeType No Indicates if the reservation is for Unit/Room Owner or Authorized User. If this attribute is not defined, it is a regular/rental reservation.

PrimaryShareType PrimaryShareTypeType No This is populated in case of primary share scenario. This indicates whether this reservation is primary or non primary. Changes or postings to the 'non-primary' share reservation is not allowed.

RemoteCheckInAllowed boolean No Indicates if the reservation is pre-registered for internet check-in.

BookingMedium CodeType No Classifies the medium (Channel field on reservation screen) through which the reservation is made.

BookingMediumDescription StringLength2000 No Description of the booking medium.

Content Model



1..1

CurrentRoomInfo CurrentRoomInfoType 0..1 Room information of the reservation for the current day.

RoomRates anyType (restriction) 0..1 A collection of Room Rates associated with a particular Room Stay. Each Room Rate combination can have multiple rates. Example: King room, Rack rate plan, Monday through Thursday, weekday amount, Friday and Saturday, weekend amount.


TimeSpan TimeSpanType 1..1 The Time Span (Arrival, Departure) which covers the Room Stay.

ExpectedTimes ResExpectedTimesType 0..1 The Expected Arrival and Departure Times.

OriginalTimeSpan TimeSpanType 0..1 The Original Time Span (Arrival, Departure) which covers the Room Stay. In case of Rolling No Show TimeSpan's StratDate moves forward but OriginalTimeSpan's StratDate remains the same.


214


Promotion PromotionType 0..1 Promotions applied to the reservation to get the promotional rate.

SuiteWith StringLength200 0..1 Connecting Rooms.

Total TotalType 0..1 The total amount charged for the Room Stay.

TotalPoints PointsType 0..1 The total number of Points charged for the Room Stay.

MultiValueAttrs anyType (restriction) 0..1 Informative indicators indicating different values of an attribute exists over the stay.

Element: RoomStay [type ReservationInfoType]

Description

Collection of room stays.

Attributes


ScheduledCheckoutTime date No Indicates this reservation is scheduled for automated check-out.


PseudoRoom boolean No True indicates as pseudo room type. This is usually used for a posting master reservation.

Content Model



1..1

TimeSpan TimeSpanType 0..1 The Time Span which covers the Room Stay.

ExpectedTimes ResExpectedTimesType 0..1 The expected arrival and departure times of the guest.

AdultCount integer 0..1 A collection of Guest Counts associated with Room Stay.

ChildCount integer 0..1 A collection of Child Counts associated with Room Stay.

RoomClass CodeType 0..1 Room class code.

RoomType CodeType 0..1 Room type code.

NumberOfRooms integer 0..1 Room ID.

RoomNumber CodeType 0..1 Room ID.

RatePlanCode CodeType 0..1 Rate plan code.

RateAmount CurrencyAmountType 0..1 Rate amount.

215


Points PointsType 0..1 The Points contains the number of points used to book a particular room type.

RateSuppressed boolean 0..1 Indicates if this rate should be suppressed from view.


BookingChannelCode CodeType 0..1 Booking channel code.

PartyCode string 0..1 Party code.

FixedRate boolean 0..1 True if the rate is a fixed rate, otherwise false.

TotalAmount CurrencyAmountType 0..1 The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount.


MarketCode CodeType 0..1 Market code.

SourceOfBusiness CodeType 0..1 Source of business.

SourceOfBusinessDescription StringLength4000 0..1 Description of the source of business.

Balance CurrencyAmountType 0..1 Balance amount.

CompBalance CurrencyAmountType 0..1 Comp Balance amount.

RoomTypeCharged CodeType 0..1 Room type code that was charged.

DepositPayments CurrencyAmountType 0..1 A collection of deposit and/or payments for the Room Stay.

GuestServiceStatus GuestHousekeepingServiceRequestType 0..1 Service Status of In House guest like DND or MUP.

Element: RoomStayCandidates [type AvailRequestSegmentType]

Description

216

Contains Room and its classification related filters for the Rate Availability Request.

Content Model



1..1

RoomTypes anyType (restriction) 0..1

RoomClasses anyType (restriction) 0..1

BedTypes anyType (restriction) 0..1

Features anyType (restriction) 0..1

Element: RoomStays [type AvailResponseSegmentType]

Content Model



1..1

RoomStay RoomStayType 0..*

Element: RoomType [type AvailHotelResType]

Description

Reservation's Current Room Type code that is of interest.

Element: RoomType [type CurrentRoomInfoType]

Description

Current room type.

Element: RoomType [type RoomStayCandidatesType/RoomTypes]

Element: RoomType [type RoomTypeMasterInfoType]

Description

Room type information.

Attributes


RoomType StringLength20 Yes


RoomClass StringLength20 No


Content Model



1..1

217


LongDescription StringLength2000 0..1 Detail description of the Room Type.

WebPage StringLength2000 0..1 URL providing more information about the Room Type.

RoomFeatures RoomFeaturesType 0..1 Collection of room features.

RoomTypeAttributes RoomTypeAttributesType 0..1 Room type attributes.

BookingChannelMappings anyType (restriction) 0..1 Collection of Booking Channels mapping for the Room Type.

Element: RoomType [type StayInfoType]

Description

Room type code.

Element: RoomTypeAttributes [type RoomTypeInfoType]

Description

Room type attributes.

Content Model



1..1

DefaultOccupancy integer 0..1 Default occupancy of property room type.

MaxOccupancy integer 0..1 Max occupancy of property room type.

NoOfPhysicalRooms integer 0..1 Number of physical rooms of property room type.

Element: RoomTypeCharged [type StayInfoType]

Description

Room type code that was charged

Element: RoomTypes [type AvailResponseMasterInfoType]

Description

Collection of room type information

Attributes



Content Model



1..1

RoomType RoomTypeInfoType 0..* Room type information

218

Element: RoomTypes [type RoomStayCandidatesType]

Content Model



1..1

RoomType CodeType 0..*

Element: RunningApplication [type OperaContextType]

Description

Running Application. (Not supported)

Element: SalesInfo [type ProfileType]

Description

Sales information of the profiles.

Attributes


HotelCode CodeType No Hotel Code used to filter the sales information.

Content Model



1..1

Scope StringLength2000 0..1 Defines the scope.

ScopeCity StringLength2000 0..1 Defines the scope city.

AccountType StringLength20 0..1 Defines the account type.

AccountSource StringLength2000 0..1 Defines the account source.

IndustryCode StringLength2000 0..1 Defines the industry code.

BusinessSegments StringLength2000 0..1 Defines the Business segments.

Priority StringLength4000 0..1 Defines the priority.

RoomsPotential StringLength4000 0..1 Defines the rooms potential.

ActionCode StringLength4000 0..1 Defines the action code.

CompetitionCode StringLength4000 0..1 Defines the competition code.

Influence StringLength2000 0..1 Defines the influence for the contact profile.

PreferredRoom StringLength20 0..1 Defines the Preferred Room for profile.

Element: Salutation [type PersonNameType]

Description

Salutation of the profile.

219

Element: Scope [type SalesInfoType]

Description

Defines the scope.

Element: ScopeCity [type SalesInfoType]

Description

Defines the scope city.

Element: SearchMatch [type SearchMatchesType]

Attributes


Attribute StringLength2000 No Search match attribute.

Value StringLength2000 No Search match value.

Element: SearchMatches [type ReservationInfoType]

Description

Super Search matching terms.

Content Model



1..1

SearchMatch SearchMatchType 0..*

Element: SecAnswer [type WebUserAccountType]

Description

Answer to the Security Question.

Element: SecQuestion [type WebUserAccountType]

Description

Security Question and its Code associated with the account to verify the user.

Attributes




Element: SharedGuest [type ResSharedGuestListType]

Content Model



1..1

220


ProfileID UniqueID_Type (extension)

0..1




Element: SharedGuests [type ReservationInfoType]

Description

Collection of guests who share this reservation.

Content Model



1..1

SharedGuest ResSharedGuestInfoType 0..*

Element: ShareDistributionInstruction [type AmountType]

Description

Last rate share distribution instruction applied on share reservation daily rate segment.

Enumeration

Value

Full

Entire

Split

CustomSplit

Element: ShareRatePercentage [type AmountType]

Description

Indicates the share rate percentage for the reservation if set to CUSTOMSPLIT.

Element: ShortDescription [type GuaranteeType]

Description

Brief description of the Guarantee Code.

Content Model



1..1

DefaultText StringLength80 0..1 Default text with Character length from 0 to 80.

TranslatedTexts TranslationsTextType 0..1 List of translated text and language codes.

221

Element: ShortInfo [type RatePlanInfoType]

Description

Brief Information of the Rate Code.

Element: SmokingPreference [type SmokingPreferenceListType]

Description

Smoking preference to search a reservation. This is compared to the preference on the guest profile of the

reservation.

Element: SmokingPreferences [type AvailRequestSegmentType]

Description

List of Smoking Preferences to search for reservations.

Content Model



1..1

SmokingPreference CodeType 0..* Smoking preference to search a reservation. This is compared to the preference on the guest profile of the reservation.

Element: Source [type PreferenceType]

Description

Source of the preference.

Element: SourceOfBusiness [type AvailRatePlanInfoType/RatePlan]

Description

Holds the source code.

Element: SourceOfBusiness [type StayInfoType]

Description

Source of business.

Element: SourceOfBusinessDescription [type StayInfoType]

Description

Description of the source of business.

Element: SourceOfSale [type ReservationInfoType]

Description

Point of Sale of reservation. Identifies the entity/channel who made the reservation.

Attributes

222


SourceType StringLength40 No Type of entity/channel who made the reservation.

SourceCode CodeType No The entity/channel who made the reservation.

Element: Specials [type ReservationInfoType]

Description

Set of reservation preferences which belongs to the Specials group.

Element: StartDate [type PackageElementType]

Element: StartDate [type TimeSpanType]

Element: State [type AddressSearchType]

Description

State or Province name (for example, Texas).

Element: State [type AddressType]

Description

State or Province name (for example, Texas).

Element: Status [type HotelInterfaceType]

Description

The current status of the IFC.

Enumeration

Value

STOPPED

RUNNING

WAITING

STOP INITIATED

START INITIATED

REBOOT INITIATED

OTHER

Element: Status [type ReservationTurndownInfoType]

Description

Indicates turndown status, values could be required, not required, completed.

Enumeration

Value

Required

Not Required

Completed

223

Element: StatusCode [type InterfaceRightsStatusType]

Description

User defined code for an Interface Right.

Element: StayProfile [type RoomRateType/StayProfiles]

Attributes



Content Model



1..1


0..1

Profile ProfileType 0..1 Provides detailed information regarding either a company or a customer profile.

Element: StayProfiles [type RoomRateType]

Description

Profile associated with the room Stay.

Content Model



1..1

StayProfile ResProfileType 0..*

Element: StreetAddress [type AddressSearchType]

Description

First Line of Street Address. For profile search it matches the first Address line.

Element: Success [type OperaWebServiceRSBaseType]

Description


Element: SuiteWith [type RoomStayType]

Description

Connecting Rooms.

Element: Supplies [type FacilityTaskType]

Description

Supplies associated with the task.

224

Content Model



1..1

FacilityCode FacilityCodeType 0..*

Element: Surname [type PersonNameType]

Description

Family name, last name. May also be used for full name if the sending system does not have the ability to

separate a full name into its parts (for example, the surname element may be used to pass the full name).

Element: Surname [type ResGuestExternalInfoType]

Description


Element: Surname [type ResGuestInfoType]

Description


Element: SurnamePrefix [type ResGuestInfoType]

Description

For example, "van der", "von", "de".

Element: TargetExternalSystem [type OperaContextType]

Description

This element carries ID of the External System that serves this request. It is needed only while making a

call to External WebServices from OPERA UI through integration.

Element: Task [type FacilityTaskType]

Description

The Task Code.

Attributes


HotelCode CodeType No Property where this task code is configured.

Code CodeType No The Code for the task.

Sequence integer No Ordering sequence for display.

Content Model



1..1

Description StringLength80 0..1 Description of the Task Code.

225


Instructions StringLength2000 0..1 Instructions for this Task Code.

FacilityDepartureTask boolean 0..1 Indicates if this task code is the default departure task for Facility Tasks. This requires


Element: Tax [type TaxesType]

Description

An individual tax.

Attributes


Type AmountDeterminationType No Indicates if the amount is inclusive or exclusive of other charges, such as taxes, or is cumulative (amounts have been added to each other).

Code CodeType No Code identifying the fee (for example, agency fee, municipality fee). Refer to OpenTravel Code List Fee Tax Type (FTT).



Content Model



1..1


Element: Tax1No [type ProfileTaxInfoType]

Description

The tax ID of this profile. Usually issued by a government agency. Used by 1099 printing.

Element: Tax2No [type ProfileTaxInfoType]

Description

Tax 2 ID of this profile.

Element: Taxes [type TotalType]

Description

A collection of taxes.

Attributes

226




Content Model



1..1

Tax TaxType 0..99 An individual tax.

Element: TaxFreeGuestCounts [type RoomRateType]

Description

A collection of Tax Free Guest Counts associated with the room rate. This list does not add to the guest

count. It indicates number of tax free guests out of guest counts.

Attributes




Content Model



1..1



Element: TaxInfo [type ProfileType]

Description

Profile information about tax.

Content Model



1..1

Tax1No StringLength40 0..1 The tax ID of this profile. Usually issued by a government agency. Used by 1099 printing.

Tax2No StringLength40 0..1 Tax 2 ID of this profile.

TaxOffice StringLength30 0..1 Tax Office name of this profile.

227

Element: TaxOffice [type ProfileTaxInfoType]

Description

Tax Office name of this profile.

Element: TaxType [type ResCashieringType]

Description

Stores the code for the type of tax calculation, especially with tax exemption.

Attributes


TaxExemptNo StringLength20 No Tax exempt number on the profile.

Content Model



1..1








Element: TaxType [type ReservationInfoType]

Description

Stores the code for the type of tax calculation, especially with tax exemption.

Content Model



1..1








228

Element: Telephone [type RelationshipProfileType]

Description

Information on telephone details for the customer/company.

Content Model



1..1



Element: Telephone [type TelephoneInfoType]

Description

Phone details for the profile.

Attributes


PhoneTechType CodeType No Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT).

PhoneUseType CodeType No Describes the type of telephone number, in the context of its general use (for example, Home, Business, Emergency Contact, Travel Arranger, Day, Evening). Refer to OpenTravel Code List Phone Use Type (PUT).

PhoneUseTypeDescription StringLength2000 No Description of the PhoneUseType code.

PhoneNumber StringLength40 Yes Telephone number assigned to a single location.

Extension StringLength20 No Extension to reach a specific party at the phone number.



Element: TelephoneInfo [type ProfileType/Telephones]

Description

Collection of Detailed information on telephone/fax for the customer.

Content Model



1..1


229



Element: Telephones [type ProfileType]

Description

List of telephone number information.

Attributes




Content Model



1..1

TelephoneInfo TelephoneInfoType 0..* Collection of Detailed information on telephone/fax for the customer.

Element: TerminalId [type OperaContextType]

Description

Terminal ID from where this request originated.

Element: Territory [type ProfileType]

Description

Territory associated to the profile.

Element: Text [type ParagraphType]

Description

Formatted text content.

Attributes


Formatted boolean No Textual information, which may be formatted as a line of information, or unformatted, as a paragraph of text.


TextFormat NMTOKEN (restriction)

No Indicates the format of text used in the description (for example, unformatted or html).

Element: Text [type TranslationsTextType]

Attributes

230


Lang CodeType Yes Language code for the translation.

Element: TimeSpan [type AvailHotelResType]

Description

Current Arrival and Departure date of the reservation.

Content Model



1..1

StartDate date 0..1

1..1


EndDate date 0..1

Element: TimeSpan [type ReservationQueueInformationType]

Description

Start and End times on the Queue for the reservation.

Attributes


DurationInSeconds integer No The total duration, in seconds, the reservation is on Queue.

Content Model



1..1

StartDate date 0..1

1..1


EndDate date 0..1

Element: TimeSpan [type RoomStaySearchType]

Content Model



1..1

StartDate date 0..1

1..1


231


EndDate date 0..1

Element: TimeSpan [type RoomStayType]

Description

The Time Span (Arrival, Departure) which covers the Room Stay.

Content Model



1..1

StartDate date 0..1

1..1


EndDate date 0..1

Element: TimeSpan [type StayInfoType]

Description

The Time Span which covers the Room Stay.

Content Model



1..1

StartDate date 0..1

1..1


EndDate date 0..1

Element: Total [type AmountType]

Description

The total amount charged for this rate including additional occupant amounts and fees.

Attributes





232






Content Model



1..1



Element: Total [type RoomRateType]

Attributes





CurrencySymbol StringLength10 No The symbol for the currency, e.g, for currencyCode USD the symbol is $.



RateOverride boolean No When true indicates that the rate amount has been overridden.

Content Model


233


1..1



Element: Total [type RoomStayType]

Description

The total amount charged for the Room Stay.

Attributes








RateOverride boolean No When true indicates that the rate amount has been overridden.

Content Model



1..1



Element: TotalAmount [type StayInfoType]

Description

The total amount charged for the Room Stay including additional occupant amounts and fees. If

TaxInclusive is set to True, taxes are included in the total amount.

Attributes

234




Element: TotalFixedCharge [type ResRevenueBalanceType]

Description

Total Fixed Charges on the reservation.

Attributes




Element: TotalPayment [type ResRevenueBalanceType]

Description

Total payment received for the reservation.

Attributes




Element: TotalPoints [type RoomRateType]

Attributes



Points integer No No of points required to book this Room Stay.

Element: TotalPoints [type RoomStayType]

Description

The total number of Points charged for the Room Stay.

Attributes



Points integer No No of points required to book this Room Stay.

Element: TotalRevenue [type ResRevenueBalanceType]

Description

Total Revenue generated by the reservation.

235

Attributes




Element: TotalStay [type GuestLastStayInfoType]

Description

The total number of previous stay of the guest.

Element: TotalStay [type LastStayInfoType]

Description

The total number of previous stay of the profile.

Element: TraceCode [type ProfileType]

Description

Trace Code associated to the profile.

Element: TranslatedTexts [type TranslationTextType80]

Description

List of translated text and language codes.

Content Model



1..1

Text StringLength2000 (extension)

0..*

Element: TurndownInfo [type ReservationInfoType]

Description

Currency code preferred by guest.

Content Model



1..1

Allowed boolean 0..1 Indicates if turndown is allowed.

Status TurndownStatusType 0..1 Indicates turndown status, values could be required, not required, completed.

Element: UDF [type CharacterUDFsType]

Attributes

236


Name string Yes Used to hold user defined field of Character Type. It is highly recommended to use UDFC01, UDFC02 and so on up to UDFC40 (Total 40) as Character/String UDF names (commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.

Value string No Value of user defined field.

Element: UDF [type DateUDFsType]

Attributes


Name string Yes Used to hold user defined field of Date Type. It is highly recommended to use UDFD01, UDFD02 and so on up to UDFN20 (Total 20) as Date UDF names (commonly used on Reservation, Profile etc.). Name is not restricted using enumeration, to provide flexibility of different name usage if required.

Value date No Value of user defined field.

Element: UDF [type NumericUDFsType]

Attributes


Name string Yes Name of user defined field.

Value double No Value of user defined field.

Element: UniqueID [type AddressInfoType]

Description

Address ID for the address.

Attributes





237




ID_Context StringLength80 No Identifies the source of the identifier (for example, IATA, ABTA).

Element: UniqueID [type BlockCodeIDType]

Attributes








Element: UniqueID [type CommentInfoType]

Description

Comment ID for the comment. It will be empty in case of new comment.

Attributes




238






Element: UniqueID [type EmailInfoType]

Description

Unique ID for the email.

Attributes








Element: UniqueID [type IdentificationInfoType]

Description

Unique ID of the identification.

Attributes

239








Element: UniqueID [type ResGuestInfoType]

Description

Unique identifier of this reservation guest

Attributes








240

Element: UniqueID [type TelephoneInfoType]

Description

Unique ID for the phone.

Attributes








Element: UniqueID [type UniqueIDListType]

Description

Unique ID that references an object uniquely in the system.

Attributes






241




Element: UniqueID [type URLInfoType]

Description

ID for the URL in the system.

Attributes








Element: URL [type ParagraphType]

Description

A URL for this paragraph.

Element: URL [type URLInfoType]

Description

Provides URL information.

Attributes


Type StringLength20 No Defines the purpose of the URL address, such as personal, business, public.



242



Element: URLInfo [type ProfileType/URLs]

Description

Collection of Detailed information on web URL/address for the customer.

Content Model



1..1



Element: URLs [type ProfileType]

Description

List of Information on a URL for the customer.

Attributes




Content Model



1..1

URLInfo URLInfoType 0..* Collection of Detailed information on web URL/address for the customer.

Element: URLs [type RelationshipProfileType]

Description

Information on web URL/address for the customer/company.

Content Model



1..1



243

Element: UseLocal [type OperaContextType]

Description

Determines whether local system should be used and ignore the external system instead.

Element: UserDefinedFields [type ProfileType]

Description

Collections of user defined fields.

Content Model



1..1

CharacterUDFs CharacterUDFsType 0..1 Collection of user defined fields of Character/String Type.

NumericUDFs NumericUDFsType 0..1 Collection of user defined fields of Numeric Type.

DateUDFs DateUDFsType 0..1 Collection of user defined fields of Date Type.

Element: UserLanguage [type OperaContextType]

Description

User's language code.

Element: VIP [type ResGuestInfoType]

Description

The supplier's ranking of the customer (for example, VIP, numerical ranking).

Attributes


VIPCode CodeType No VIP Code.

VIPDescription StringLength80 No VIP Description.

Element: VisaValidityType [type AlienInfoType]

Description

Visa Type of an Alien.

Element: Waitlist [type ReservationInfoType]

Description

Information regarding why reservation has been/was waitlisted. This could hold information as history

even if reservation is not in Waitlist status anymore.

Attributes


ReasonCode CodeType No Waitlist Reason Code.

PriorityCode CodeType No Waitlist Priority Code.

244


Telephone StringLength40 No Guest telephone number.

Content Model



1..1

ReasonDescription StringLength2000 0..1 Waitlist Reason Description.

PriorityDescription StringLength2000 0..1 Waitlist priority Description.

Description StringLength2000 0..1 Description why the reservation is being /has been waitlisted.

Element: Warning [type WarningsType]

Description

Used in conjunction with the Success

element to define a business error.

Attributes


Type CodeType Yes The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". Refer to OpenTravel Code List Error Warning Type (EWT).

ShortText string No An abbreviated version of the error in textual format.



Status string No If present, recommended values are those enumerated in the OTA_ErrorRS, (NotProcessed | Incomplete | Complete | Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.

245




RPH RPH_Type No Reference Place Holder used as an index for this warning.

Element: Warnings [type OperaWebServiceRSBaseType]

Description


Content Model



1..1

Warning WarningType 0..* Used in conjunction with the Success element to define a business error.

Element: WebPage [type RatePlanInfoType]

Description

URL providing more information about the Rate Code.

Element: WebPage [type RoomTypeInfoType]

Description

URL providing more information about the Room Type.

Element: WebUserAccounts [type ProfileType]

Description

List of Web User Accounts of the profile.

Content Model


246


1..1

WebUserAccounts WebUserAccountType 0..* Web User Accounts List.

Element: WebUserAccounts [type WebUserAccountsType]

Description

Web User Accounts List.

Attributes


LoginName StringLength80 No Login Name of the guest.

DomainCode CodeType No Domain code.

Locked boolean No Boolean flag that indicates whether the web account is locked or not.

Inactive boolean No Boolean flag that indicates whether the web account is inactive or not.

Content Model



1..1

SecQuestion CodeDescriptionType 0..1 Security Question and its Code associated with the account to verify the user.

SecAnswer StringLength4000 0..1 Answer to the Security Question.

Comments StringLength4000 0..1 Comments.

History WebUserHistoryType 0..1 Web User Account History.

NewLoginName StringLength80 0..1 New Login Name of the guest.

NewPassword StringLength2000 0..1 Login Password.

AutoGeneratePassword boolean 0..1 A flag which determines if the password is auto generated.

Date post:	10-Jul-2020
Category:	Documents
Upload:	others
View:	1 times
Download:	0 times

Oracle Hospitality OPERA Cloud Web Self-Service ... · PrimaryInd boolean No When true, indicates a...

Documents