HousekeepingService Web Service Reference August 2019 · 2019. 8. 15. · August 2019 • Initial publication : 5 : HousekeepingService: Description: Sources. Name Description

Oracle® Hospitality OPERA Cloud Web Self-Service

HousekeepingService Web Service Reference

August 2019

2

Copyright © 2019, 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

Contents Contents ........................................................................................................................................... 3 Preface ............................................................................................................................................. 4

Audience ........................................................................................................................................ 4 Customer Support .......................................................................................................................... 4 Documentation ............................................................................................................................... 4 Revision History ............................................................................................................................. 4

HousekeepingService ..................................................................................................................... 5 HousekeepingService Web Service ............................................................................................... 6

Methods: HousekeepingService ................................................................................................. 7 Complex Types: HousekeepingService ...................................................................................... 9 Elements: HousekeepingService .............................................................................................. 34

Preface This document describes the HousekeepingService 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

August 2019 • Initial publication

https://support.oracle.com/

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

5

HousekeepingService Description

Sources

Name Description HousekeepingService The HousekeepingService web service offers the capability of

creating, managing, and retrieving the information of rooms with the information on housekeeping and front office statuses as well as the room status. Additionally, it offers capability to view room discrepancies between housekeeping and front office statuses.

6

HousekeepingService Web Service Name

HousekeepingService

See Also • Methods • Elements • Complex Types

7

Methods: HousekeepingService Methods

Name Description FetchOutOfOrderRooms Provides the ability to retrieve the out of order or out of service rooms

based on the request criteria. The starting room number and room type can be provided in the request criteria.

Ping Sends a response to a ping.

Method: FetchOutOfOrderRooms Description

Provides the ability to retrieve the out of order or out of service rooms based on the request criteria. The starting room number and room type can be provided in the request criteria.

Input

The input of this method is the document element FetchOutOfOrderRoomsRQ having the structure defined by the following table.

Name Type Required? Occurs Description OperaContext OperaContextType No 0..1 Refer to Generic common types

document. Criteria OutOfOrderRoomsSearchType No 0..1 Search criteria to obtain the out

of order or out of service room’s information.

Output

The output of this method is the document element FetchOutOfOrderRoomsRS having the structure defined by the following table.

Name Type Required? Occurs Description

Yes 1..1

Yes 1..1

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

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

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

HousekeepingRooms HotelRoomsType No 0..1 List of rooms and the room status.

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.

8

Name Type Required? Occurs Description OperaContext OperaContextType No 0..1 Refer to Generic common types

document. OperaPingInput OperaPingRequestType No 0..1 Optional Input for Ping operation.

Output

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

Name Type Required? Occurs Description

Yes 1..1

Yes 1..1

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

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

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

OperaVersion OperaVersionNumberType No 0..1 Opera version number.

9

Complex Types: HousekeepingService

Complex Type: AddressInfoType Description

Provides address information.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

UniqueID UniqueID_Type 0..1 Address id for the address. Address AddressType 0..1 Address details for the profile.

Complex Type: AddressType Description

Provides address information.

Attributes

Name Type Required? Description Type CodeType No Defines the type of address (e.g. 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.

BarCode StringLength100 No The postal barcode for the address. 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

(e.g., from a live database to an archive).

Content Model



1..1

10

Component Type Occurs Description 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.

CityName StringLength40 0..1 City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).

PostalCode StringLength15 0..1 Post Office Code number. 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 (e.g., Fairfax). This is read

only. State StringLength20 0..1 State or province name (e.g., Texas). CountryName CountryNameType 0..1 Country name (e.g., Ireland). Language CodeType 0..1 Language code associated with the address.

Complex Type: ApplicationUserType Content Model



1..1

Hotel CodeDescriptionType 0..1 Hotel where user belongs. AppUser StringLength60 1..1

LDAPUser StringLength60 1..1

ActAs StringLength20 1..1

ActAt StringLength20 1..1

UserDefaultLanguage StringLength20 0..1

AppUserId UniqueID_Type 1..1

CashierId integer 1..1

CashierTitle StringLength2000 0..1 Cashier title. Department StringLength60 1..1

DepartmentLocation StringLength60 1..1

SalesRepCode StringLength20 1..1

ExpiryDate date 0..1

DisabledUntil date 0..1

PasswordChangeDate date 0..1

UserInfo EmployeeInfoType 1..1

UserSessionInfo UserSessionInfoType 1..1 This is only used during log-in. AttendantInfo AttendantType 1..1

11

Complex Type: AttendantType Content Model



1..1

AttendantID CodeType 1..1

HotelCode CodeType 1..1

Complex Type: BaseRoomType Description

This type represents the primary room attributes.

Attributes

Name Type Required? Description RoomNumber CodeType No Code of the room.

Content Model



1..1

RoomType RoomTypeShortInfoType 0..1 Room type basic information of the room.

Floor CodeType 0..1 Floor of the Room. FloorDescription CodeType 0..1 Description for the Floor of the Room. RoomFeatures RoomFeaturesType 0..1 Room Features for the room. RoomDescription CodeType 0..1 Detail Long Description Of The Room. Description TranslationTextType2000 0..1 Description of the room. SmokingPreference CodeType 0..1 This indicates room smoking

preference. SmokingPreferenceDescription CodeType 0..1 This indicates the description of the

room smoking preference. Building CodeType 0..1 Building associated with the room. RoomAssignmentRating RatePlanRatingType 0..1 Assignment Rating associated with the

room.

Complex Type: CodeDescriptionType Description

This contains a generic code and description information.

Attributes

Name Type Required? Description Code CodeType No Generic code.

12

Name Type Required? Description Description StringLength2000 No Generic description.

Complex Type: CodeListType Content Model



1..1

Code CodeType 0..4000

Complex Type: CountryNameType Description

The name or code of a country (e.g. as used in an address or to specify citizenship of a traveler).

Attributes

Name Type Required? Description Code CodeType No Code for a country or a nationality.

Complex Type: CurrentServicingAttendantType Description

Information regarding the currently servicing attendants for a task sheet.

Attributes

Name Type Required? Description StartTime dateTime No The start time of the service. Status ServicingAttendantStatusType No Status of the respective Housekeeping

Attendant. AttendantID CodeType No Attendant's unique identifier. AttendantName StringLength80 Yes Attendant's name. HotelCode CodeType No Property where the attendant belongs. ActiveFlag StringLength1 No Indicates if the Attendant is active. Sunday boolean No

Monday boolean No

Tuesday boolean No

Wednesday boolean No

Thursday boolean No

Friday boolean No

Saturday boolean No

Content Model



13


1..1

Section HousekeepingSectionType 0..1 Section Code the attendant has been assigned. Floor CodeType 0..1 The Floor which is assigned to the attendant. AppUser ApplicationUserType 0..1 The App User Name and ID of the user who

started the service.

Complex Type: DateRangeType Description

Date Range with Start and End dates.

Attributes

Name Type Required? Description Start date No The starting value of the date range. End date No The ending value of the date range.

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

Name Type Required? Description EmailAddress StringLength2000 No Defines the e-mail address. Type CodeType No Defines the purpose of the e-mail address (e.g.

personal, business, listserve). TypeDescription StringLength2000 No Describes the Type code. EmailFormat NMTOKEN

(restriction) No Supported Email format.

PrimaryInd boolean No When true, indicates a primary information. OrderSequence double No Display Order sequence. CreateDateTime dateTime No Time stamp of the creation.

14

Name Type Required? Description CreatorID StringLength200 No ID of creator. The creator could be a





Complex Type: EmployeeInfoType Attributes

Name Type Required? Description 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.

Content Model



1..1

PersonName PersonNameType 1..1

ProfileId UniqueID_Type 1..1

AddressInfo AddressInfoType 1..1

EmailInfo EmailInfoType 1..1

PhoneInfo TelephoneInfoType 1..1

Department CodeDescriptionType 1..1

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.

15

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

Name Type Required? Description ShortText string No An abbreviated version of the error in

textual 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 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.

Tag string No 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. The tag name alone can be used to identify missing data [Type=ReqFieldMissing].

RecordID string No 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.

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).

Language language No Language identification.

16

Name Type Required? Description NodeList string No An XPath expression that selects all the

nodes whose data caused this error. 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: HotelRoomsType Description

Collection of room records that contain housekeeping and out of order information.

Attributes

Name Type Required? Description 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.

Content Model



1..1

Room RoomType 0..4000

Complex Type: HousekeepingAttendantsType Description

Information regarding housekeeping attendants.

Attributes

Name Type Required? Description AttendantID CodeType No Attendant's unique identifier. AttendantName StringLength80 Yes Attendant's name. HotelCode CodeType No Property where the attendant belongs. ActiveFlag StringLength1 No Indicates if the attendant is active. Sunday boolean No

Monday boolean No

Tuesday boolean No


Thursday boolean No

Friday boolean No

Saturday boolean No

Content Model


17


1..1

Section HousekeepingSectionType 0..1 Section code the attendant has been assigned. Floor CodeType 0..1 The floor which is assigned to the attendant.

Complex Type: HousekeepingSectionType Description

Information regarding Housekeeping Sections.

Attributes

Name Type Required? Description HotelCode CodeType Yes Property where this section is defined. Code CodeType Yes The housekeeping section code. Description StringLength80 Yes Description of the section. SectionGroup CodeType Yes Housekeeping section group. TargetCredits integer No Target credit for each task sheet created for this

section when auto task assignment is broken out by section.

Rooms integer No Rooms count for this section code. This is auto-populated while creating/fetching record.

RoomCredits integer No Number of housekeeping credits. This is auto-populated while creating/fetching record.

Sequence integer No Display sequence when task assignment is automatically broken out by Section Group.

Inactive boolean No Indicates if the section code is active.

Complex Type: HousekeepingType Description

Identifies the Housekeeping information.

Content Model



1..1

RoomStatus RoomStatusType 0..1 The room status information per the reservation and housekeeping.

RoomPersons RoomPersonsType 0..1 The room person information per the reservation and housekeeping.

GuestServiceRequest GuestHousekeepingServiceRequestType 0..1

CleaningPriority RoomCleaningPriorityType 0..1 Cleaning priority for the room, if a priority was set.

RoomCondition RoomConditionType 0..1 Condition of the room, if a condition was set.

18

Component Type Occurs Description LinenChange boolean 0..1 Indicates if a linen change is

necessary. FacilityTaskCode CodeListType 0..1 Facility task code assigned to

the room for the day.

Complex Type: OperaContextType Description

Common instructions coming with all the messages to set certain context in OPERA Database before serving a 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

etc. 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 opera context 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 web services from opera UI through integration.

UseLocal boolean 0..1 Determines whether local system should be used and ignore the external system instead.

ExternalData boolean 0..1 Determines whether the request with the current context is holding external data, pertaining to external system, or it has OPERA Data. If context has External Data (true) then system calls preconfigured Data value mapping in the exchange for the given external system before proceeding with the request. By default system considers Data provided is OPERA specific (false).

Complex Type: OperaWebServiceRQBaseType Description

This Request base type is used as a base for an extension for Opera Web Services Requests to provide uniform implementation.

19

Attributes

Name Type Required? Description 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 (e.g. 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 Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.

RequestCount integer No Indicates what number of retry attempt this request represents. If this is the original request, RetryCount should be set to 0.

Enforce boolean No Indicates if this request is to be forced through OPERA services in the case where the external system continues to fail.

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




20

Name Type Required? Description Version StringLength40 No For all Opera versioned messages, the version of

the message is indicated by an Opera Version value.


RetryAllowed boolean No Indicates if the operation supports the ability to retry the request.

EnforceAllowed boolean No Indicates if the operation supports the ability to force the retry request through OPERA services in the case where the external system continues to fail.

UseLocalAllowed boolean No This attribute carries the user selected confirmation value on confirmation popup.

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: OutOfOrderRoomsSearchType Content Model



1..1


RoomStatusFilter anyType (restriction)

0..1 Fetch instructions that should be used to get out of order rooms.

RoomNumber CodeType 0..1 Room number to be Fetched. HousekeepingDate date 0..1 The date for which the out of order rooms are to be

fetched. HousekeepingEndDate date 0..1 The end date for which the out of order rooms are

to be fetched. RoomTypeList anyType

(restriction) 0..1 The list of Room Types, based on which records

need to fetch. Floor CodeType 0..1 The floor of room to be fetched. RoomClassList CodeListType 0..1 The list of filtering Room Classes

Complex Type: ParametersType Description

21

List of Generic Name-Value-Pair Parameters.

Content Model



1..1

Parameter ParameterType 0..4000 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

This provides name information for a person.

Attributes

Name Type Required? Description 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.

Content Model



1..1

NamePrefix StringLength40 0..1 Salutation of honorific (e.g. 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.

22

Component Type Occurs Description 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, e.g. the surname element may be used to pass the full name.

NameSuffix StringLength40 0..1 Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)

NameTitle StringLength80 0..1 Degree or honors (e.g., 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: ReservationShortInfoType Content Model



1..1

GuestName StringLength80 0..1 Guest name that is registered for the reservation.

ReservationID UniqueID_Type (extension) 1..1

ReservationStatusInfo HousekeepingRoomReservationStatusType 0..1

StayDateInfo StayDateInfoType 0..1

VIPStatus VIPStatusType 0..1 VIP status of the guest. ProfileID UniqueID_Type 0..1 ProfileId of the guest.

Complex Type: ResExpectedTimesType Description

Holds the Arrival and Departure Time Information

Attributes

Name Type Required? Description ResExpectedArrivalTime dateTime No Arrival Time ResExpectedDepartureTime dateTime No Departure Time

Complex Type: RoomCleaningPriorityType Description

Type to indicate the cleaning priority for a room.

Attributes

Name Type Required? Description PrioritySequence integer No Priority sequence of the room for cleaning.

Complex Type: RoomConditionType

23

Description

Condition to be assigned on the room.

Content Model



1..1

RoomCondition CodeDescriptionType 0..1 Code and Description of Condition to be assigned on the room.

AssignmentType RoomConditionAssigmentType 0..1 Determine if room, after applying condition, is available or not in Room Assignment listing.

Remarks StringLength2000 0..1 Remarks on room condition assignment.

Complex Type: RoomDiscrepanciesType Description

Room Discrepancies between front office and housekeeping room status and number of persons in the room.

Content Model



1..1

RoomDiscrepancy RoomDiscrepancyType 0..4000

Complex Type: RoomFeaturesType Description

A collection of Room Features.

Content Model



1..1

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

Complex Type: RoomFeatureType Description

Room Feature Information.

Attributes

Name Type Required? Description Code CodeType No A code representing a room feature. Description StringLength2000 No A code representing a room feature.

24

Name Type Required? Description OrderSequence double No Display Order sequence. Quantity int No Indicates quantity.

Complex Type: RoomHoldType Content Model



1..1

HoldUntil dateTime 0..1 The date and time when hold will expire. HoldUser StringLength80 0..1 User who placed room on hold. Comments StringLength2000 0..1 Comments of the room hold.

Complex Type: RoomOutOfOrderType Attributes

Name Type Required? Description RoomStatus HousekeepingRoomStatusType No The out of order or out of service room

status OO/OS. Start date No The starting value of the date range. End date No The ending value of the date range.

Content Model



1..1

RepairRemarks StringLength2000 0..1 Notes or Remarks on the OO/OS room ReturnStatus HousekeepingRoomStatusType 0..1 Room Status which will be used on

completion of OO/OS. ReasonCode CodeType 0..1 Reason Code why the room is OO/OS. ReasonDesc StringLength80 0..1 Reason Description why the room is

OO/OS. NewDateRange DateRangeType 0..1 The new start date and end date, if the

dates were changed as part of an update. This would be blank for new OO/OS rooms.

Complex Type: RoomPersonsType Attributes

Name Type Required? Description FrontOfficePersons integer No

HouseKeepingPersons integer No

Complex Type: RoomRoomsType Description

25

Collection of rooms with code and description.

Content Model



1..1

Room RoomRoomType 1..4000 Collection of rooms.

Complex Type: RoomRoomType Description

Details of a room.

Attributes


Content Model



1..1





room.

Complex Type: RoomSectionType Attributes

Name Type Required? Description DaySectionCode CodeType No Used for codes in the OPERA Code tables. Possible

values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.

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

26

Complex Type: RoomsOutOfOrderType Description

Date Range and reasons for a room being Out of Order/Out Of Service (If the room is OO/OS).

Content Model



1..1

RoomOutOfOrder RoomOutOfOrderType 0..4000

Complex Type: RoomStatusType Attributes

Name Type Required? Description RoomStatus HousekeepingRoomStatusType No Status of the room

(Dirty/Clean/Inspected/Pickup). FrontOfficeStatus FrontOfficeRoomStatusType No Front office status ( Occupied / Vacant ). HousekeepingStatus FrontOfficeRoomStatusType No Housekeeping status ( Occupied /

Vacant ).

Content Model



1..1

ReservationStatusList anyType (restriction) 0..1

Complex Type: RoomType Description

This type represents the room attributes.

Attributes


Content Model



1..1


Floor CodeType 0..1 Floor of the Room. FloorDescription CodeType 0..1 Description for the Floor of the

Room. RoomFeatures RoomFeaturesType 0..1 Room Features for the room.

27

Component Type Occurs Description RoomDescription CodeType 0..1 Detail Long Description Of The

Room. Description TranslationTextType2000 0..1 Description of the room. SmokingPreference CodeType 0..1 This indicates room smoking

preference. SmokingPreferenceDescription CodeType 0..1 This indicates the description of

the room smoking preference. Building CodeType 0..1 Building associated with the

room. RoomAssignmentRating RatePlanRatingType 0..1 Assignment Rating associated

with the room. RoomSection RoomSectionType 0..1 Room sections of the room. Housekeeping HousekeepingType 0..1 Identifies the Housekeeping

information. OutOfOrder RoomsOutOfOrderType 0..1 Identifies the room Out of

Order/Out of Service information. Discrepancy RoomDiscrepanciesType 0..1 Identifies the room discrepancy

information. SitePlanSection SitePlanSectionType 0..1 Identifies the site plan location of

the room. ComponentRoomNumber CodeType 0..1 This flag indicates component

room. ConnectingRooms RoomRoomsType 0..1 This flag indicates connecting

rooms. ComponentRooms RoomRoomsType 0..1 This flag indicates component

rooms. Attendant CurrentServicingAttendantType 0..4000

Hold RoomHoldType 0..1 Hold attributes if any. TurndownInfo TurndownInfoType 0..1

ResvInfo ReservationShortInfoType 0..4000

Complex Type: RoomTypeShortInfoType Description

Basic information of room type.

Attributes

Name Type Required? Description RoomType CodeType No Room type of the room.

Content Model



1..1

Pseudo boolean 0..1 Indicates if room is a pseudo. This is read-only.

28

Component Type Occurs Description Suite boolean 0..1 Indicates if room is a suite. This is read-only. RoomClass CodeType 0..1 Room Class of the room. This is read-only. HouseKeeping boolean 0..1 Indicates if room type of the room is flagged as

housekeeping. This is read-only. SmokingPreference CodeType 0..1 Specifies the smoking preference for room type of

the room. Building CodeType 0..1 Building associated with the room. RoomAssignmentRating RatePlanRatingType 0..1 Assignment Rating associated with the room. MinOccupancy integer 0..1 Minimum occupancy for the room type. MaxOccupancy integer 0..1 Maximum occupancy for the room type. RoomFeatures RoomFeaturesType 0..1 Room Features for the room.

Complex Type: SitePlanSectionType Description

Represents the site plan section record.

Content Model



1..1

SectionCode CodeType 0..1 The site plan section code. SectionType CodeType 0..1 The section type. LinkCode CodeType 0..1 The link code for the section. Coordinates string 0..1 The coordinates for this section. Description string 0..1 The description of this section.

Complex Type: StayDateInfoType Description

Room attached with stay detail information

Content Model



1..1

TimeSpan TimeSpanType 0..1

ExpectedTimes ResExpectedTimesType 0..1

Complex Type: SuccessType Description

Returns an empty element of this type indicates the successful processing of an

29

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

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

Name Type Required? Description 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 (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, and 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. PrimaryInd boolean No When true, indicates a primary information. OrderSequence double No Display Order sequence. CreateDateTime dateTime No Time stamp of the creation. CreatorID StringLength200 No ID of creator. The creator could be a



person to modify a record.

30

Name Type Required? Description PurgeDate date No Date an item will be purged from a database


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: TranslationsTextType Description

Contains multiple translated texts and language codes.

Content Model



1..1

Text StringLength2000 (extension)

0..4000

Complex Type: TranslationTextType2000 Description

Contains multiple translated texts and language codes.

Content Model



1..1

DefaultText StringLength2000 0..1 Default text with Character length from 0 to 2000. TranslatedTexts TranslationsTextType 0..1 List of translated text and language codes.

Complex Type: TurndownInfoType Content Model


31


1..1

TurndownStatusInfo TurndownStatusType 0..1

Complex Type: UniqueID_Type Description

An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote).

Attributes

Name Type Required? Description 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 (e.g., IATA, ABTA).

Complex Type: UserSessionDefaultsType Content Model



1..1

DbDateFormat string 0..1

OracleDateFormat string 0..1

OracleTimeFormat string 0..1

JavaDateFormat string 0..1

JavaTimeFormat string 0..1

CurrencyCode CodeType 0..1

CurrencyFormat string 0..1

32

Component Type Occurs Description DefaultLanguage string 0..1

BaseLanguage CodeType 0..1

Complex Type: UserSessionInfoType Content Model



1..1

BusinessDate date 1..1

SystemDate date 1..1

Terminal string 0..1

RunningApp string 0..1

ShareProfiles boolean 0..1

Hotel CodeDescriptionType 0..1

CRO CodeDescriptionType 0..1

Chain CodeType 0..1

CROCountryCode CodeType 0..1

SessionDefaults UserSessionDefaultsType 0..1

Parameters ParametersType 0..1

Complex Type: VIPStatusType Description

VIP status of the customer.

Attributes

Name Type Required? Description Code CodeType No VIP status of the customer.

Complex Type: WarningsType Description

Collection of warnings.

Content Model



1..1

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

Complex Type: WarningType Description

33

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

Attributes




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


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. 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.

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).

Language language No Language identification. RPH RPH_Type No Reference Place Holder used as an index

for this warning.

34

Elements: HousekeepingService

Element: ActAs [type ApplicationUserType] Element: ActAt [type ApplicationUserType] Element: Address [type AddressInfoType] Description

Address details for the profile.

Attributes

Name Type Required? Description Type CodeType No Defines the type of address (e.g. 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.

BarCode StringLength100 No The postal barcode for the address. CreateDateTime dateTime No Time stamp of the creation. CreatorID StringLength200 No ID of creator. The creator could be a





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.

CityName StringLength40 0..1 City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).

PostalCode StringLength15 0..1 Post Office Code number.

35

Component Type Occurs Description 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 (e.g., Fairfax). This is read

only. State StringLength20 0..1 State or Province name (e.g., Texas). CountryName CountryNameType 0..1 Country name (e.g., Ireland). Language CodeType 0..1 Language code associated with the address

Element: AddressInfo [type EmployeeInfoType] Content Model



1..1

UniqueID UniqueID_Type 0..1 Address id for the address. Address AddressType 0..1 Address details for the profile.

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, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence.

Element: AppUser [type ApplicationUserType] Element: AppUser [type CurrentServicingAttendantType] Description

The App User Name and ID of the user who started the service.

Content Model



1..1

Hotel CodeDescriptionType 0..1 Hotel where user belongs. AppUser StringLength60 1..1

LDAPUser StringLength60 1..1

ActAs StringLength20 1..1

ActAt StringLength20 1..1

UserDefaultLanguage StringLength20 0..1

AppUserId UniqueID_Type 1..1

CashierId integer 1..1

CashierTitle StringLength2000 0..1 Cashier title.

36

Component Type Occurs Description Department StringLength60 1..1

DepartmentLocation StringLength60 1..1

SalesRepCode StringLength20 1..1

ExpiryDate date 0..1

DisabledUntil date 0..1

PasswordChangeDate date 0..1

UserInfo EmployeeInfoType 1..1

UserSessionInfo UserSessionInfoType 1..1 This is only used during log-in. AttendantInfo AttendantType 1..1

Element: AppUserId [type ApplicationUserType] Attributes








Element: AssignmentType [type RoomConditionType] Description

Determine if room, after applying condition, is available or not in Room Assignment listing.

Enumeration

Value Available Not Available

Element: Attendant [type RoomType] Attributes

37

Name Type Required? Description StartTime dateTime No The start time of the service. Status ServicingAttendantStatusType No Status of the respective Housekeeping

Attendant. AttendantID CodeType No Attendant's unique identifier. AttendantName StringLength80 Yes Attendant's name. HotelCode CodeType No Property where the attendant belongs. ActiveFlag StringLength1 No Indicates if the Attendant is active. Sunday boolean No

Monday boolean No

Tuesday boolean No


Thursday boolean No

Friday boolean No

Saturday boolean No

Content Model



1..1

Section HousekeepingSectionType 0..1 Section Code the attendant has been assigned. Floor CodeType 0..1 The Floor which is assigned to the attendant. AppUser ApplicationUserType 0..1 The App User Name and ID of the user who

started the service.

Element: AttendantID [type AttendantType]

Element: AttendantInfo [type ApplicationUserType] Content Model



1..1

AttendantID CodeType 1..1


Element: BaseLanguage [type UserSessionDefaultsType] Element: Building [type BaseRoomType] Description

Building associated with the room.

Element: Building [type RoomTypeShortInfoType]

38

Description

Building associated with the room.

Element: BusinessDate [type UserSessionInfoType] Element: CashierId [type ApplicationUserType] Element: CashierTitle [type ApplicationUserType] Description

Cashier title.

Element: Chain [type UserSessionInfoType] Element: CityExtension [type AddressType] Description

Post Office City Extension Code number. City Extension mainly used for UK addresses.

Element: CityName [type AddressType] Description

City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).

Element: CleaningPriority [type HousekeepingType] Description

Cleaning priority for the room, if a priority was set.

Attributes

Name Type Required? Description PrioritySequence integer No Priority sequence of the room for cleaning.

Element: Code [type CodeListType]

Element: Comments [type RoomHoldType] Description

Comments of the room hold.

Element: ComponentRoomNumber [type RoomType] Description

This flag indicates component room.

Element: ComponentRooms [type RoomType] Description

This flag indicates component rooms.

39

Content Model



1..1


Element: ConnectingRooms [type RoomType] Description

This flag indicates connecting rooms.

Content Model



1..1


Element: Coordinates [type SitePlanSectionType] Description

The coordinates for this section.

Element: CountryName [type AddressType] Description

Country name (e.g., Ireland).

Attributes

Name Type Required? Description Code CodeType No Code for a country or a nationality.

Element: County [type AddressType] Description

County or District Name (e.g., Fairfax). This is read only.

Element: Criteria [element FetchOutOfOrderRoomsRQ] Description

Search criteria to obtain the out of order or out of service room’s information.

Content Model



1..1


40

Component Type Occurs Description RoomStatusFilter anyType

(restriction) 0..1 Fetch instructions that should be used to get out of

order rooms. RoomNumber CodeType 0..1 Room number to be Fetched. HousekeepingDate date 0..1 The date for which the out of order rooms are to be

fetched. HousekeepingEndDate date 0..1 The end date for which the out of order rooms are

to be fetched. RoomTypeList anyType

(restriction) 0..1 The list of Room Types, based on which records

need to fetch. Floor CodeType 0..1 The floor of room to be fetched. RoomClassList CodeListType 0..1 The list of filtering Room Classes

Element: CRO [type UserSessionInfoType] Attributes

Name Type Required? Description Code CodeType No Code. Description StringLength2000 No Description.

Element: CROCode [type OperaContextType] Description

Central Reservation office (CRO) code.

Element: CROCountryCode [type UserSessionInfoType] Element: CurrencyCode [type UserSessionDefaultsType] Element: CurrencyFormat [type UserSessionDefaultsType]

Element: DbDateFormat [type UserSessionDefaultsType] Element: DefaultLanguage [type UserSessionDefaultsType] Element: DefaultText [type TranslationTextType2000] Description

Default text with Character length from 0 to 2000.

Element: Department [type ApplicationUserType] Element: Department [type EmployeeInfoType] Attributes


41

Element: DepartmentLocation [type ApplicationUserType] Element: Description [type BaseRoomType] Description

Description of the room.

Content Model



1..1

DefaultText StringLength2000 0..1 Default text with Character length from 0 to 2000. TranslatedTexts TranslationsTextType 0..1 List of translated text and language codes.

Element: Description [type SitePlanSectionType] Description

The description of this section.

Element: DisabledUntil [type ApplicationUserType] Element: Discrepancy [type RoomType] Description

Identifies the room discrepancy information.

Content Model



1..1

RoomDiscrepancy RoomDiscrepancyType 0..4000

Element: Duration [type TimeSpanType]

Element: Email [type EmailInfoType] Description

Email details for the profile.

Attributes

Name Type Required? Description EmailAddress StringLength2000 No Defines the e-mail address. Type CodeType No Defines the purpose of the e-mail address (e.g.

personal, business, listserve). TypeDescription StringLength2000 No Describes the Type code EmailFormat NMTOKEN

(restriction) No Supported Email format.

42

Name Type Required? Description PrimaryInd boolean No When true, indicates a primary information. OrderSequence double No Display Order sequence. CreateDateTime dateTime No Time stamp of the creation. CreatorID StringLength200 No ID of creator. The creator could be a





Element: EmailInfo [type EmployeeInfoType] Content Model



1..1

UniqueID UniqueID_Type 0..1 Unique id for the email. Email EmailType 0..1 Email details for the profile.

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





43

Name Type Required? Description 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.


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.

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).

Language language No Language identification. NodeList string No An XPath expression that selects all the

nodes whose data caused this error. Further, this expression should have an additional contraint 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.

Content Model



1..1

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

44

Element: ExpectedTimes [type StayDateInfoType] Attributes

Name Type Required? Description ResExpectedArrivalTime dateTime No Arrival Time ResExpectedDepartureTime dateTime No Departure Time

Element: ExpiryDate [type ApplicationUserType] Element: ExternalData [type OperaContextType] Description

Determines whether the request with the current context is holding external data, pertaining to external system, or it has OPERA Data. If context has External Data (true) then system calls preconfigured Data value mapping in the exchange for the given external system before proceeding with the request. By default system considers Data provided is OPERA specific (false).

Element: ExternalSystem [type OperaContextType] Description

External system code.

Element: FacilityTaskCode [type HousekeepingType] Description

Facility task Code/ Task Code assigned to the room for the day.

Content Model



1..1


Element: FetchOutOfOrderRoomsRQ Attributes





45

Name Type Required? Description 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.

RequestCount integer No Indicates what number of retry attempt this request represents. If this is the original request, RetryCount should be set to 0.


Content Model



1..1

OperaContext OperaContextType 0..1 Refer to Generic common types document. Criteria OutOfOrderRoomsSearchType 0..1 Search criteria to obtain the out of order or

out of service room’s information.

Element: FetchOutOfOrderRoomsRS Attributes









Content Model


46


1..1

1..1


1..1

Success SuccessType 0..1 Refer to Generic common types document. Warnings WarningsType 0..1 Refer to Generic common types document. HousekeepingRooms HotelRoomsType 0..1 List of rooms and the room status.

Element: Floor [type BaseRoomType] Description

Floor of the Room.

Element: Floor [type HousekeepingAttendantsType] Description

The Floor which is assigned to the attendant.

Element: Floor [type OutOfOrderRoomsSearchType] Description

The floor of room to be fetched.

Element: FloorDescription [type BaseRoomType] Description

Description for the Floor of the Room.

Element: GivenName [type PersonNameType] Description

Given name, first name or names.

Element: GuestName [type ReservationShortInfoType] Description

Guest name that is registered for the reservation.

Element: GuestServiceRequest [type HousekeepingType] Enumeration

Value Do Not Disturb Make Up Room No Status Selected

47

Element: Hold [type RoomType] Description

Hold attributes if any.

Content Model



1..1

HoldUntil dateTime 0..1 The date and time when hold will expire. HoldUser StringLength80 0..1 User who placed room on hold. Comments StringLength2000 0..1 Comments of the room hold.

Element: HoldUntil [type RoomHoldType] Description

The date and time when hold will expire.

Element: HoldUser [type RoomHoldType] Description

User who placed room on hold.

Element: Hotel [type ApplicationUserType] Description

Hotel where user belongs.

Attributes


Element: Hotel [type UserSessionInfoType] Attributes


Element: HotelCode [type AttendantType] Element: HotelCode [type OperaContextType] Description

Hotel code.

48

Element: HotelCode [type OutOfOrderRoomsSearchType] Element: Housekeeping [type RoomType] Description

Identifies the Housekeeping information.

Content Model



1..1

RoomStatus RoomStatusType 0..1 The Room status information per the reservation and housekeeping.

RoomPersons RoomPersonsType 0..1 The Room person information per the reservation and housekeeping.

GuestServiceRequest GuestHousekeepingServiceRequestType 0..1

CleaningPriority RoomCleaningPriorityType 0..1 Cleaning priority for the room, if a priority was set.

RoomCondition RoomConditionType 0..1 Condition of the room, if a condition was set.

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

FacilityTaskCode CodeListType 0..1 Facility task Code/ Task Code assigned to the room for the day.

Element: HouseKeeping [type RoomTypeShortInfoType] Description

Indicates if room type of the room is flagged as housekeeping. This is read-only.

Element: HousekeepingDate [type OutOfOrderRoomsSearchType] Description

The date for which the out of order rooms are to be fetched.

Element: HousekeepingEndDate [type OutOfOrderRoomsSearchType] Description

The end date for which the out of order rooms are to be fetched.

Element: HousekeepingRooms [element FetchOutOfOrderRoomsRS] Description

List of rooms and the room status.

Attributes

49

Name Type Required? Description HotelCode CodeType No

Content Model



1..1

Room RoomType 0..4000

Element: HousekeepingRoomStatus [type OutOfOrderRoomsSearchType/RoomStatusFilter/HousekeepingRoomStatusList] Enumeration

Value Clean Dirty Pickup Inspected Out Of Order Out Of Service

Element: HousekeepingRoomStatusList [type OutOfOrderRoomsSearchType/RoomStatusFilter] Content Model



1..1

HousekeepingRoomStatus HousekeepingRoomStatusType 0..4000

Element: JavaDateFormat [type UserSessionDefaultsType] Element: JavaTimeFormat [type UserSessionDefaultsType] Element: Language [type AddressType] Description

Language code associated with the address

Element: Language [type OperaContextType] Description

Hotel's language code.

Element: LDAPUser [type ApplicationUserType]

50

Element: LinenChange [type HousekeepingType] Description

Indicates if a linen change is necessary.

Element: LinkCode [type SitePlanSectionType] Description

The link code for the section.

Element: LogLevel [type OperaContextType] Description

Log level to debug the code such as FINE, FINER etc.

Enumeration

Value SEVERE WARNING INFO CONFIG FINE FINER FINEST ERROR MESSAGE DEBUG TRACE

Element: MaxOccupancy [type RoomTypeShortInfoType] Description

Maximum occupancy for the room type.

Element: MiddleName [type PersonNameType] Description

The middle name of the person name.

Element: MinOccupancy [type RoomTypeShortInfoType] Description

Minimum occupancy for the room type.

Element: NamePrefix [type PersonNameType] Description

51

Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.)

Element: NameSuffix [type PersonNameType] Description

Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)

Element: NameTitle [type PersonNameType] Description

Degree or honors (e.g., Ph.D., M.D.)

Element: NameTitleSuffix [type PersonNameType] Description

Title Suffix. Must be populated if ADVANCED_TITLE is on.

Element: NewDateRange [type RoomOutOfOrderType] Description

The new start date and end date, if the dates were changed as part of an update. This would be blank for new OO/OS rooms.

Attributes

Name Type Required? Description Start date No The starting value of the date range. End date No The ending value of the date range.

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

etc. ExternalSystem StringLength80 1..1 External system code.

52

Component Type Occurs Description 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.

ExternalData boolean 0..1 Determines whether the request with the current context is holding external data, pertaining to external system, or it has OPERA Data. If context has External Data (true) then system calls preconfigured Data value mapping in the exchange for the given external system before proceeding with the request. By default system considers Data provided is OPERA specific (false).

Element: OperaPingInput [element PingRQ] Description

Optional Input for Ping operation.

Element: OperaVersion [element PingRS] Description

Opera version number.

Element: OracleDateFormat [type UserSessionDefaultsType] Element: OracleTimeFormat [type UserSessionDefaultsType] Element: OutOfOrder [type RoomType] Description

Identifies the room Out of Order/Out of Service information.

Content Model



1..1

RoomOutOfOrder RoomOutOfOrderType 0..4000

Element: Override [type OperaContextType] Description

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.

53

Element: Parameter [type ParametersType] Description

Collection of generic Name-Value-Pair parameters.

Content Model



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: Parameters [type UserSessionInfoType] Content Model



1..1

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

Element: ParameterValue [type ParameterType] Description

Value of the parameter.

Element: PasswordChangeDate [type ApplicationUserType] Element: PersonName [type EmployeeInfoType] Attributes

Name Type Required? Description 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.

Content Model



1..1

54

Component Type Occurs Description NamePrefix StringLength40 0..1 Salutation of honorific (e.g. 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, e.g. the surname element may be used to pass the full name.

NameSuffix StringLength40 0..1 Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.)

NameTitle StringLength80 0..1 Degree or honors (e.g., 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

Element: PhoneInfo [type EmployeeInfoType] Content Model



1..1

UniqueID UniqueID_Type 0..1 Unique id for the phone. Telephone TelephoneType 0..1 Phone details for the profile.

Element: PingRQ Description

Request for Ping operation.

Attributes






55

Name Type Required? Description RequestCount integer No Indicates what number of retry attempt this request

represents. If this is the original request, RetryCount should be set to 0.


Content Model



1..1

OperaContext OperaContextType 0..1 Refer to Generic common types document. OperaPingInput OperaPingRequestType 0..1 Optional Input for Ping operation.

Element: PingRS Description

Response for Ping operation.

Attributes









Content Model



56


1..1

1..1


1..1

Success SuccessType 0..1 Refer to Generic common types document. Warnings WarningsType 0..1 Refer to Generic common types document. OperaVersion OperaVersionNumberType 0..1 Opera version number.

Element: PostalCode [type AddressType] Description

Post Office Code number.

Element: ProfileId [type EmployeeInfoType] Attributes








Element: ProfileID [type ReservationShortInfoType] Description

ProfileId of the guest.

Attributes


with the record identified by the UniqueID.

57

Name Type Required? Description Type CodeType Yes A reference to the type of object defined by






Element: Pseudo [type RoomTypeShortInfoType] Description

Indicates if room is a pseudo. This is read-only.

Element: ReasonCode [type RoomOutOfOrderType] Description

Reason Code why the room is OO/OS.

Element: ReasonDesc [type RoomOutOfOrderType] Description

Reason Description why the room is OO/OS.

Element: Remarks [type RoomConditionType] Description

Remarks on room condition assignment.

Element: RepairRemarks [type RoomOutOfOrderType] Description

Notes or Remarks on the OO/OS room

Element: ReservationID Attributes



58







Element: ReservationStatus [type RoomStatusType/ReservationStatusList] Enumeration

Value Arrival Arrived Day Use Due Out Departed Not Reserved StayOver

Element: ReservationStatusInfo [type ReservationShortInfoType] Enumeration

Value Arrival Arrived Day Use Due Out Departed Not Reserved StayOver

Element: ReservationStatusList [type RoomStatusType] Content Model


59


1..1

ReservationStatus HousekeepingRoomReservationStatusType 0..4000

Element: ResvInfo [type RoomType] Content Model



1..1

GuestName StringLength80 0..1 Guest name that is registered for the reservation.

ReservationID UniqueID_Type (extension) 1..1

ReservationStatusInfo HousekeepingRoomReservationStatusType 0..1

StayDateInfo StayDateInfoType 0..1

VIPStatus VIPStatusType 0..1 VIP status of the guest. ProfileID UniqueID_Type 0..1 ProfileId of the guest.

Element: ReturnStatus [type RoomOutOfOrderType] Description

Room Status which will be used on completion of OO/OS.

Enumeration

Value Clean Dirty Pickup Inspected Out Of Order Out Of Service

Element: Room [type HotelRoomsType] Attributes


Content Model



1..1


Floor CodeType 0..1 Floor of the Room.

60

Component Type Occurs Description FloorDescription CodeType 0..1 Description for the Floor of the

Room. RoomFeatures RoomFeaturesType 0..1 Room Features for the room. RoomDescription CodeType 0..1 Detail Long Description Of The

Room. Description TranslationTextType2000 0..1 Description of the room. SmokingPreference CodeType 0..1 This indicates room smoking

preference. SmokingPreferenceDescription CodeType 0..1 This indicates the description of

the room smoking preference. Building CodeType 0..1 Building associated with the

room. RoomAssignmentRating RatePlanRatingType 0..1 Assignment Rating associated

with the room. RoomSection RoomSectionType 0..1 Room sections of the room. Housekeeping HousekeepingType 0..1 Identifies the Housekeeping

information. OutOfOrder RoomsOutOfOrderType 0..1 Identifies the room Out of

Order/Out of Service information. Discrepancy RoomDiscrepanciesType 0..1 Identifies the room discrepancy

information. SitePlanSection SitePlanSectionType 0..1 Identifies the site plan location of

the room. ComponentRoomNumber CodeType 0..1 This flag indicates component

room. ConnectingRooms RoomRoomsType 0..1 This flag indicates connecting

rooms. ComponentRooms RoomRoomsType 0..1 This flag indicates component

rooms. Attendant CurrentServicingAttendantType 0..4000

Hold RoomHoldType 0..1 Hold attributes if any. TurndownInfo TurndownInfoType 0..1

ResvInfo ReservationShortInfoType 0..4000

Element: Room [type RoomRoomsType] Description

Collection of rooms.

Attributes


Content Model


61


1..1





room.

Element: RoomAssignmentRating [type BaseRoomType] Description

Assignment Rating associated with the room.

Enumeration

Value MostImportant Important SomewhatImportant LessImportant LeastImportant NoValueSet

Element: RoomAssignmentRating [type RoomTypeShortInfoType] Description

Assignment Rating associated with the room.

Enumeration

Value MostImportant Important SomewhatImportant LessImportant LeastImportant NoValueSet

62

Element: RoomClass [type RoomTypeShortInfoType] Description

Room Class of the room. This is read-only.

Element: RoomClassList [type OutOfOrderRoomsSearchType] Description

The list of filtering Room Classes

Content Model



1..1


Element: RoomCondition [type HousekeepingType] Description

Condition of the room, if a condition was set.

Content Model



1..1

RoomCondition CodeDescriptionType 0..1 Code and description of condition to be assigned on the room.

AssignmentType RoomConditionAssigmentType 0..1 Determine if room, after applying condition, is available or not in Room Assignment listing.

Remarks StringLength2000 0..1 Remarks on room condition assignment.

Element: RoomCondition [type RoomConditionType] Description

Code and description of condition to be assigned on the room.

Attributes


Element: RoomDescription [type BaseRoomType] Description

Long description of the room.

63

Element: RoomDiscrepancy [type RoomDiscrepanciesType] Enumeration

Value Sleep Skip Person Discrepancy

Element: RoomFeature [type RoomFeaturesType] Description

A recurring element that identifies the room features.

Attributes

Name Type Required? Description Code CodeType No A code representing a room feature. Description StringLength2000 No A code representing a room feature. OrderSequence double No Display Order sequence. Quantity int No Indicates quantity.

Element: RoomFeatures [type BaseRoomType] Description

Room features for the room.

Content Model



1..1


Element: RoomFeatures [type RoomTypeShortInfoType] Description

Room Features for the room.

Content Model



1..1


Element: RoomNumber [type OutOfOrderRoomsSearchType] Description

Room number to be fetched.

64

Element: RoomOutOfOrder [type RoomsOutOfOrderType] Attributes

Name Type Required? Description RoomStatus HousekeepingRoomStatusType No The out of order or out of service room

status OO/OS. Start date No The starting value of the date range. End date No The ending value of the date range.

Content Model



1..1

RepairRemarks StringLength2000 0..1 Notes or Remarks on the OO/OS room ReturnStatus HousekeepingRoomStatusType 0..1 Room Status which will be used on

completion of OO/OS. ReasonCode CodeType 0..1 Reason Code why the room is OO/OS. ReasonDesc StringLength80 0..1 Reason Description why the room is

OO/OS. NewDateRange DateRangeType 0..1 The new start date and end date, if the

dates were changed as part of an update. This would be blank for new OO/OS rooms.

Element: RoomPersons [type HousekeepingType] Description

The Room person information per the reservation and housekeeping.

Attributes

Name Type Required? Description FrontOfficePersons integer No

HouseKeepingPersons integer No

Element: RoomSection [type RoomType] Description

Room sections of the room.

Attributes

Name Type Required? Description DaySectionCode CodeType No

EveningSectionCode CodeType No

Element: RoomStatus [type HousekeepingType] Description

The Room status information per the reservation and housekeeping.

65

Attributes

Name Type Required? Description RoomStatus HousekeepingRoomStatusType No Status of the room

(Dirty/Clean/Inspected/Pickup). FrontOfficeStatus FrontOfficeRoomStatusType No Front office status (Occupied/Vacant). HousekeepingStatus FrontOfficeRoomStatusType No Housekeeping status (Occupied/Vacant).

Content Model



1..1

ReservationStatusList anyType (restriction) 0..1

Element: RoomStatusFilter [type OutOfOrderRoomsSearchType] Description

Fetch instructions that should be used to get out of order rooms.

Content Model



1..1

HousekeepingRoomStatusList anyType (restriction)

0..1

Element: RoomType [type BaseRoomType] Description

Room type basic information of the room.

Attributes

Name Type Required? Description RoomType CodeType No Room type of the room.

Content Model



1..1

Pseudo boolean 0..1 Indicates if room is a pseudo. This is read-only. Suite boolean 0..1 Indicates if room is a suite. This is read-only. RoomClass CodeType 0..1 Room Class of the room. This is read-only. HouseKeeping boolean 0..1 Indicates if room type of the room is flagged as

housekeeping. This is read-only. SmokingPreference CodeType 0..1 Specifies the smoking preference for room type of

the room.

66

Component Type Occurs Description Building CodeType 0..1 Building associated with the room. RoomAssignmentRating RatePlanRatingType 0..1 Assignment Rating associated with the room. MinOccupancy integer 0..1 Minimum occupancy for the room type. MaxOccupancy integer 0..1 Maximum occupancy for the room type. RoomFeatures RoomFeaturesType 0..1 Room Features for the room.

Element: RoomType [type OutOfOrderRoomsSearchType/RoomTypeList] Description

The room type of order rooms to be fetched.

Element: RoomTypeList [type OutOfOrderRoomsSearchType] Description

The list of Room Types, based on which records need to fetch.

Content Model



1..1

RoomType CodeType 0..4000 The room type of order rooms to be fetched.

Element: RunningApp [type UserSessionInfoType] Element: RunningApplication [type OperaContextType] Description

Running Application. (Not supported)

Element: SalesRepCode [type ApplicationUserType]

Element: Salutation [type PersonNameType] Description

Salutation of the profile

Element: Section [type HousekeepingAttendantsType] Description

Section Code the attendant has been assigned.

Attributes

Name Type Required? Description HotelCode CodeType Yes Property where this section is defined. Code CodeType Yes The Housekeeping Section Code. Description StringLength80 Yes Description of the Section.

67

Name Type Required? Description SectionGroup CodeType Yes Housekeeping Section Group. TargetCredits integer No Target Credit for each task sheet created for this

section when auto task assignment is broken out by section.

Rooms integer No Rooms count for this section code. This is auto populated while creating/fetching record.

RoomCredits integer No Number of housekeeping credits. This is auto populated while creating/fetching record.

Sequence integer No Display sequence when task assignment is automatically broken out by Section Group.

Inactive boolean No Indicates if the Section Code is active.

Element: SectionCode [type SitePlanSectionType] Description

The site plan section code.

Element: SectionType [type SitePlanSectionType] Description

The section type.

Element: SessionDefaults [type UserSessionInfoType] Content Model



1..1

DbDateFormat string 0..1

OracleDateFormat string 0..1

OracleTimeFormat string 0..1

JavaDateFormat string 0..1

JavaTimeFormat string 0..1

CurrencyCode CodeType 0..1

CurrencyFormat string 0..1

DefaultLanguage string 0..1

BaseLanguage CodeType 0..1

Element: ShareProfiles [type UserSessionInfoType] Element: SitePlanSection [type RoomType] Description

Identifies the site plan location of the room.

Content Model

68



1..1

SectionCode CodeType 0..1 The site plan section code. SectionType CodeType 0..1 The section type. LinkCode CodeType 0..1 The link code for the section. Coordinates string 0..1 The coordinates for this section. Description string 0..1 The description of this section.

Element: SmokingPreference [type BaseRoomType] Description

This indicates room smoking preference.

Element: SmokingPreference [type RoomTypeShortInfoType] Description

Specifies the smoking preference for room type of the room.

Element: SmokingPreferenceDescription [type BaseRoomType] Description

This indicates the description of the room smoking preference.

Element: StartDate [type TimeSpanType] Element: State [type AddressType] Description

State or Province name (e.g., Texas).

Element: StayDateInfo [type ReservationShortInfoType] Content Model



1..1

TimeSpan TimeSpanType 0..1

ExpectedTimes ResExpectedTimesType 0..1

Element: Success [type OperaWebServiceRSBaseType] Description


Element: Suite [type RoomTypeShortInfoType]

69

Description

Indicates if room is a suite. This is read-only.

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, e.g. the surname element may be used to pass the full name.

Element: SystemDate [type UserSessionInfoType] Element: TargetExternalSystem [type OperaContextType] Description

This element carries the 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: Telephone [type TelephoneInfoType] Description

Phone details for the profile.

Attributes

Name Type Required? Description 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 (e.g. 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. PrimaryInd boolean No When true, indicates a primary information. OrderSequence double No Display Order sequence. CreateDateTime dateTime No Time stamp of the creation. CreatorID StringLength200 No ID of creator. The creator could be a



person to modify a record.

70

Name Type Required? Description PurgeDate date No Date an item will be purged from a database


Element: Terminal [type UserSessionInfoType] Element: TerminalId [type OperaContextType] Description

Terminal ID from where this request originated.

Element: Text [type TranslationsTextType] Attributes

Name Type Required? Description Lang CodeType Yes Language code for the translation.

Element: TimeSpan [type StayDateInfoType] Content Model



1..1

StartDate date 0..1

1..1

Duration duration 0..1

EndDate date 0..1

Element: TranslatedTexts [type TranslationTextType2000] Description

List of translated text and language codes.

Content Model



1..1

Text StringLength2000 (extension)

0..4000

Element: TurndownInfo [type RoomType] Content Model



1..1

71

Component Type Occurs Description TurndownStatusInfo TurndownStatusType 0..1

Element: TurndownStatusInfo [type TurndownInfoType] Enumeration

Value Required Not Required Completed

Element: UniqueID [type AddressInfoType] Description

Address id for the address.

Attributes








Element: UniqueID [type EmailInfoType] Description

Unique id for the email.

Attributes



72







Element: UniqueID [type TelephoneInfoType] Description

Unique id for the phone.

Attributes








Element: UseLocal [type OperaContextType] Description

Determines whether local system should be used and ignore the external system instead.

73

Element: UserDefaultLanguage [type ApplicationUserType] Element: UserInfo [type ApplicationUserType] Attributes

Name Type Required? Description 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.

Content Model



1..1

PersonName PersonNameType 1..1

ProfileId UniqueID_Type 1..1

AddressInfo AddressInfoType 1..1

EmailInfo EmailInfoType 1..1

PhoneInfo TelephoneInfoType 1..1

Department CodeDescriptionType 1..1

Element: UserLanguage [type OperaContextType] Description

User's language code.

Element: UserSessionInfo [type ApplicationUserType] Description

This is only used during log-in.

Content Model



1..1

BusinessDate date 1..1

SystemDate date 1..1

Terminal string 0..1

RunningApp string 0..1

ShareProfiles boolean 0..1

Hotel CodeDescriptionType 0..1

CRO CodeDescriptionType 0..1

Chain CodeType 0..1

74

Component Type Occurs Description CROCountryCode CodeType 0..1

SessionDefaults UserSessionDefaultsType 0..1

Parameters ParametersType 0..1

Element: VIPStatus [type ReservationShortInfoType] Description

VIP status of the guest.

Attributes

Name Type Required? Description Code CodeType No VIP status of the customer.

Element: Warning [type WarningsType] Description

Used in conjunction with the Success element to define a business error.

Attributes







75

Name Type Required? Description 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.

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).

Language language No Language identification. RPH RPH_Type No Reference Place Holder used as an index

for this warning.

Element: Warnings [type OperaWebServiceRSBaseType] Description

Refer to generic common types document.

Content Model



1..1

Warning WarningType 0..4000 Used in conjunction with the success element to define a business error.

Documents

HousekeepingService Web Service Reference August 2019 · 2019. 8. 15. · August 2019 • Initial publication : 5 : HousekeepingService: Description: Sources. Name Description