opera cloud web self-service · pdf filea standard way to indicate that an error occurred...

Oracle® Hospitality OPERA Cloud Web Self-Service

Resource Config Service 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.

Contents

Preface ....................................................................................................... 4

Audience ............................................................................................................................................................................. 4

Customer Support ............................................................................................................................................................. 4

Documentation ................................................................................................................................................................... 4

Revision History ................................................................................................................................................................ 4

1 ResourceConfigService ........................................................................ 5

ResourceConfigService Web Service ............................................................................................................................... 6

Methods: ResourceConfigService ............................................................................................................................. 7

Complex Types: ResourceConfigService ................................................................................................................. 9

Elements: ResourceConfigService .......................................................................................................................... 20

4

Preface

This document describes the ResourceConfigService 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/

5

1 ResourceConfigService

Sources

Name Description

ResourceConfigService The Resource Config web service offers the capability to configure the Master Data needed for Hotel Resources, such as managing Inventory Items, Item Pools, and Item Classes.

6

ResourceConfigService Web Service

Name

ResourceConfigService

Description

The Resource Config web service offers the capability to configure the Master Data needed for Hotel Resources,

such as managing Inventory Items, Item Pools, and Item Classes.

See Also

Methods

Elements

Complex Types

7

Methods: ResourceConfigService

Methods

Name Description

FetchInventoryItems Fetches Inventory Items.

FetchItemClasses Fetches Item Classes.

Method: FetchInventoryItems

Description

Fetches Inventory Items.

Input

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

following table.

Name Type Required? Occurs Description

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

Criteria InventoryItemSearchType Yes 1..1 Search criteria to fetch Inventory Items Setup configurations

Output

The output of this method is the document element FetchInventoryItemsRS 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

Items InventoryItemsType Yes 1..1 Collection of Inventory Items Setup configurations

Method: FetchItemClasses

Description

Fetches Item Classes.

Input

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

following table.


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

Criteria ItemClassSearchType Yes 1..1 Search criteria to fetch item class.

Output

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

following table.

8


Yes 1..1

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

Yes 1..1

ItemClasses ItemClassesType Yes 1..1 Collection of item class.

9

Complex Types: ResourceConfigService

Complex Type: CodeListType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Code CodeType 0..*

Complex Type: CurrencyAmountType

Description

A monetary value expressed with a currency code.

Attributes

Name Type Required? Description

Amount Money No A monetary amount.

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

Complex Type: DateTimeSpanType

Description

A measure of time from a StartDateTime to either a specified EndDateTime or to a StartDateTime plus Duration.

Content Model



1..1

StartDateTime dateTime 0..1

EndDateTime dateTime 0..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.

Complex Type: ErrorType

Description

10

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

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.

11

Complex Type: FreeTextType

Description

Textual information to provide descriptions and/or additional information.

Attributes


Language language No Language identification.

Complex Type: GenericMultipleCodesSearchType

Description

List of codes to be searched or alternatively a wild card search for the code.

Content Model



1..1

Code CodeType 0..* Codes to be searched.

WildCard CodeType 0..1 Wildcard search on the code.

Complex Type: InventoryItemIDType

Description

Inventory Items identification details.

Content Model



1..1

HotelCode CodeType 1..1 The Hotel code to which the item belongs.

ItemID UniqueID_Type 1..1 The ID of the Item.

Complex Type: InventoryItemSearchType

Description

Search Criteria to fetch Inventory Items.

Content Model



1..1


ItemClassCode CodeType 1..1 The Item Class ID to which the item belongs.

ItemName StringLength200 0..1 The name of Inventory Item.

Complex Type: InventoryItemsType

Description

12

List of Inventory Items.

Content Model



1..1

Item InventoryItemType 0..*

Complex Type: InventoryItemType

Description

Details of Inventory Items.

Attributes


UsedForEvents boolean No If true, the item is used for events.

UsedForReservation boolean No If true, the item is used for reservation.

Content Model



1..1



ItemClassID UniqueID_Type 1..1 The Item Class ID to which the item belongs.

ItemClassCode CodeType 0..1 The Item Class Code to which the item belongs.

ItemName StringLength200 1..1 The Name of the Item.

ItemDescription StringLength2000 0..1 The Description of the Item.

ItemCode StringLength20 1..1 The Quick Insert of the Item.

RevenueType CodeType 0..1 The Revenue Type of the Item.

RevenueTypeEditable boolean 0..1 If true, the revenue could be changed.

ExternalOrder boolean 0..1 If true, Item is ordered externally.

Print boolean 0..1 If true, Item is printed in the BEO and Contract.

SellInfo anyType (restriction) 0..1 The Sell Information of the Item.

SetupTime double 0..1 Setup Time of the Item in minutes.

SetdownTime double 0..1 Set down time of the item in minutes.

TraceText StringLength2000 0..1 The Trace Text of the Item.

ItemPool StringLength200 0..1 The Item Pool description of the Item.

DisplaySequence double 0..1 The display sequence of the Item.

EventTypes CodeListType 0..1 List of Event Types for the Item.

Departments CodeListType 0..1 List of Departments for the Item.

Attributes ItemAttributesType 0..1 List of Attributes of the Item.

Rates ItemRatesType 0..1 List of Rates of the Item.

Vendors ItemVendorsType 0..1 List of Vendors of the Item.

13

Complex Type: ItemAttributesType

Description

List of Item Attributes.

Content Model



1..1

Attribute ItemAttributeType 0..*

Complex Type: ItemAttributeType

Description

Details of the Item Attribute.

Content Model



1..1

ItemAttributeID UniqueID_Type 1..1 The ID of the Item Attribute.

Name StringLength200 1..1 The Name of the Item Attribute.

SetupTime double 0..1 The Setup Time of the Item Attribute in minutes.

SetdownTime double 0..1 The Set down Time of the Item Attribute in minutes.

Default boolean 0..1 If true, it's the default Attribute for the Item.

Complex Type: ItemClassesType

Description

Collection of Item Class.

Content Model



1..1

ItemClass ItemClassType 0..* Holds Item Class details.

Complex Type: ItemClassSearchType

Description

Search criteria to fetch Hotels' Item Class configurations at fetch. The same type is reused to fetch the child

records as well while editing based on group type, which is specified in choice.

Content Model



1..1

1..1

14


1..1

ClassID double 0..1

1..1

Hotels CodeListType 1..1 List of hotel codes with the Item Class to be searched.

ItemClasses GenericMultipleCodesSearchType 0..1 List of Item Class to be searched.

Type ItemClassTypeType 0..1 Item Class Type to be searched.

Complex Type: ItemClassType

Description

Provides information about the Item Class.

Content Model



1..1

HotelCode CodeType 1..1 Code of the Hotel.

Code CodeType 1..1 Code of the Item Class.

Description StringLength200 1..1 Description of the Item Class.

Type ItemClassTypeType 1..1 Item Class Type. For example, Reservations, Events.

ClassID double 0..1 Class ID of the Item Class.

DisplaySequence double 0..1 Sequence of Item Class.

EventTypes CodeListType 0..1 Event Types of Item Class.

Departments CodeListType 0..1 Departments of Item Class.

Discountable boolean 0..1 Indicates if the Item Class is discountable.

WebBookable boolean 0..1 Indicates if the Item Class is BookableViaWebsite.

OverrideWarnings boolean 0..1 Indicates if warnings are overridden and all items are updated despite the warnings.

DiscountOverrideWarnings boolean 0..1 Indicates if warnings for discountable are overridden and all items are updated despite the warnings.

Complex Type: ItemRatesType

Description

List of Item Rates.

Content Model



1..1

Rate ItemRateType 0..*

15

Complex Type: ItemRateType

Description

Details of the Item Rate.

Content Model



1..1

ItemRateID UniqueID_Type 1..1 The ID of the Item Rate.

ItemRateCode CodeType 1..1 The Rate Code of the Item Rate.

Name StringLength200 0..1 The Name of the Item Rate.

Price CurrencyAmountType 0..1 The Price of the Item.

Hourly boolean 0..1 If true, it is an hourly rate.

Default boolean 0..1 If true, it is the default Rate for the Item.

Complex Type: ItemVendorsType

Description

List of Item Vendors.

Content Model



1..1

Vendor ItemVendorType 0..*

Complex Type: ItemVendorType

Description

Details of the Item Vendor.

Content Model



1..1

ProfileID UniqueID_Type (extension)

1..1

Name StringLength100 0..1 The Name of the vendor.

LeadTime StringLength200 0..1 Lead time for ordering.

Price CurrencyAmountType 0..1 Purchase Price.

Priority double 1..1 The Priority of the Vendor.

Phone StringLength2000 0..1 The phone number of the Vendor.

Fax StringLength2000 0..1 The fax number of the Vendor.

Email StringLength2000 0..1 The email address of the Vendor.

16

Complex Type: OperaContextType

Description

Common instructions included with all messages to set a certain context in the OPERA Database before serving

the 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, and so on.

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.

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.

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.

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

17


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.

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






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.

18

Complex Type: SuccessType

Description

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: UniqueID_Type

Description

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

19


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







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

20

Elements: ResourceConfigService

Element: Attribute [type ItemAttributesType]

Content Model



1..1

ItemAttributeID UniqueID_Type 1..1 The ID of the Item Attribute.

Name StringLength200 1..1 The Name of the Item Attribute.

SetupTime double 0..1 The Setup Time of the Item Attribute in minutes.

SetdownTime double 0..1 The Set down time of the Item Attribute in minutes.

Default boolean 0..1 If true, it's the default Attribute for the Item.

Element: Attributes [type InventoryItemType]

Description

List of Attributes of the Item.

Content Model



1..1

Attribute ItemAttributeType 0..*

Element: Available [type InventoryItemType/SellInfo]

Description

The available period of the Item.

Content Model



1..1

StartDateTime dateTime 0..1

EndDateTime dateTime 0..1

Element: ClassID [group ]

Element: ClassID [type ItemClassType]

Description

ClassID of the Item Class.

Element: Code [type CodeListType]

Element: Code [type GenericMultipleCodesSearchType]

Description

21

Codes to be searched.

Element: Code [type ItemClassType]

Description

Code of the Item Class.

Element: Criteria [element FetchInventoryItemsRQ]

Description

Search criteria to fetch Inventory Items Setup configurations

Content Model



1..1


ItemClassCode CodeType 1..1 The Item Class code to which the item belongs.

ItemName StringLength200 0..1 The name of Inventory Item.

Element: Criteria [element FetchItemClassesRQ]

Description

Search criteria to fetch item class

Content Model



1..1

1..1

1..1

Hotels CodeListType 1..1 List of hotel codes whose Item Class to be searched.

ItemClasses GenericMultipleCodesSearchType 0..1 List of Item Class to be searched.

Type ItemClassTypeType 0..1 Type whose Item Class to be searched.

1..1

ClassID double 0..1

Element: CriticalInventory [type InventoryItemType/SellInfo]

Description

If true, the Item watches stock.

Element: CROCode [type OperaContextType]

Description

Central Reservation office (CRO) code.

22

Element: Default [type ItemAttributeType]

Description

If true, the default Attribute for the Item.

Element: Default [type ItemRateType]

Description

If true, the default Rate for the Item.

Element: DefaultDuration [type InventoryItemType/SellInfo]

Description

Define the default duration days when booking the Item.

Element: DefaultQty [type InventoryItemType/SellInfo]

Description

Defines the default quantity when booking the Item.

Element: Departments [type InventoryItemType]

Description

List of Departments for the Item.

Content Model



1..1

Code CodeType 0..*

Element: Departments [type ItemClassType]

Description

Departments of Item Class.

Content Model



1..1

Code CodeType 0..*

Element: Description [type ItemClassType]

Description

Description of the Item Class.

Element: Discountable [type InventoryItemType/SellInfo]

Description

Specifies if a discount is allowed for this item.

23

Element: Discountable [type ItemClassType]

Description

Indicates whether the Item Class is discountable.

Element: DiscountOverrideWarnings [type ItemClassType]

Description

Indicates if all items are to be updated despite warnings for discountable.

Element: DisplaySequence [type InventoryItemType]

Description

The display sequence of the Item.

Element: DisplaySequence [type ItemClassType]

Description

Sequence of Item Class.

Element: Email [type ItemVendorType]

Description

The email address of the Vendor.

Element: EndDateTime [type DateTimeSpanType]

Element: Error [type ErrorsType]

Description

An error that occurred during the processing of a message.

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




24





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.

Content Model



1..1

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

Element: EventTypes [type InventoryItemType]

Description

List of Event Types for the Item.

Content Model



1..1

25


Code CodeType 0..*

Element: EventTypes [type ItemClassType]

Description

Event Types of Item Class.

Content Model



1..1

Code CodeType 0..*

Element: ExternalOrder [type InventoryItemType]

Description

If true, Item is ordered externally.

Element: ExternalSystem [type OperaContextType]

Description

External system code.

Element: Fax [type ItemVendorType]

Description

The fax number of the Vendor.

Element: FetchInventoryItemsRQ

Description

Request object to fetch Inventory Items Setup configuration

Attributes





26



Content Model



1..1


Criteria InventoryItemSearchType 1..1 Search criteria to fetch Inventory Items Setup configurations

Element: FetchInventoryItemsRS

Description

Response object to fetch Inventory Items Setup configuration

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

1..1


1..1



Items InventoryItemsType 1..1 Collection of Inventory Items Setup configurations.

27

Element: FetchItemClassesRQ

Description

Request object for fetching the item class.

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


Criteria ItemClassSearchType 1..1 Search criteria to fetch item class

Element: FetchItemClassesRS

Description

Response object for fetching item class.

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.


28




Content Model



1..1

1..1


1..1



ItemClasses ItemClassesType 1..1 Collection of item class.

Element: FixedCharge [type InventoryItemType/SellInfo]

Description

If true, the Fixed Charges screen automatically appears when this item is attached to a reservation.

Element: HotelCode [type InventoryItemIDType]

Description

The Hotel code to which the item belongs.

Element: HotelCode [type InventoryItemSearchType]

Description

The hotel code to which the item belongs..

Element: HotelCode [type ItemClassType]

Description

The code of the hotel.

Element: HotelCode [type OperaContextType]

Description

The hotel code.

Element: Hotels [group ]

Description

A list of hotel codes for the hotels to be searched along with the item classes for the hotels.

Content Model


29


1..1

Code CodeType 0..*

Element: Hourly [type ItemRateType]

Description

If true, an hourly rate.

Element: Item [type InventoryItemsType]

Attributes


UsedForEvents Boolean No If true, the item is used for events.

UsedForReservation Boolean No If true, the item is used for reservation.

Content Model



1..1



ItemClassID UniqueID_Type 1..1 The Item Class ID to which the item belongs.

ItemClassCode CodeType 0..1 The Item Class Code to which the item belongs.

ItemName StringLength200 1..1 The Name of the Item.

ItemDescription StringLength2000 0..1 The Description of the Item.

ItemCode StringLength20 1..1 The Quick Insert of the Item.

RevenueType CodeType 0..1 The Revenue Type of the Item.

RevenueTypeEditable boolean 0..1 If true, the revenue could be changed.

ExternalOrder boolean 0..1 If true, Item is ordered externally.

Print boolean 0..1 If true, Item will print in the BEO and Contract.

SellInfo anyType (restriction) 0..1 The Sell Information of the Item.

SetupTime double 0..1 Setup time of the Item in minutes.

SetdownTime double 0..1 Set down time of the Item in minutes.

TraceText StringLength2000 0..1 The Trace Text of the Item.

ItemPool StringLength200 0..1 The Item Pool description of the Item.

DisplaySequence double 0..1 The display sequence of the Item.

EventTypes CodeListType 0..1 List of Event Types for the Item.

Departments CodeListType 0..1 List of Departments for the Item.

Attributes ItemAttributesType 0..1 List of Attributes of the Item.

Rates ItemRatesType 0..1 List of Rates of the Item.

Vendors ItemVendorsType 0..1 List of Vendors of the Item.

30

Element: ItemAttributeID [type ItemAttributeType]

Description

The ID of the Item Attribute.

Attributes








Element: ItemClass [type ItemClassesType]

Description

Holds the Item Class details.

Content Model



1..1

HotelCode CodeType 1..1 Code of the Hotel.

Code CodeType 1..1 Code of the Item Class.

Description StringLength200 1..1 Description of the Item Class.

Type ItemClassTypeType 1..1 Item Class Type. For example, Reservations, Events.

ClassID double 0..1 ClassID of the Item Class.

DisplaySequence double 0..1 Sequence of Item Class.

EventTypes CodeListType 0..1 Event Types of Item Class.

Departments CodeListType 0..1 Departments of Item Class.

Discountable boolean 0..1 Indicates whether the Item Class is discountable or not.

WebBookable boolean 0..1 Indicates if the Item Class is bookable via the website.

31


OverrideWarnings boolean 0..1 Indicates if warnings are overridden and all items are to be updated despite the warnings.

DiscountOverrideWarnings boolean 0..1 Indicates if all items are to be updated despite the warnings for discountable.

Element: ItemClassCode [type InventoryItemSearchType]

Description

The Item Class ID to which the item belongs.

Element: ItemClassCode [type InventoryItemType]

Description

The Item Class Code to which the item belongs.

Element: ItemClassDiscountable [type InventoryItemType/SellInfo]

Description

Specifies if a discount is allowed for the Item Class.

Element: ItemClasses [element FetchItemClassesRS]

Description

A collection of item classes.

Content Model



1..1

ItemClass ItemClassType 0..* Holds Item Class details.

Element: ItemClasses [group ]

Description

A list of the item classes to be searched.

Content Model



1..1

Code CodeType 0..* Codes to be searched.

WildCard CodeType 0..1 Wildcard search on the code.

Element: ItemClassID [type InventoryItemType]

Description

The Item Class ID to which the item belongs.

Attributes

32








Element: ItemClassWebBookable [type InventoryItemType/SellInfo]

Description

Specifies if web booking is allowed for the Item Class.

Element: ItemCode [type InventoryItemType]

Description

The Quick Insert of the Item.

Element: ItemDescription [type InventoryItemType]

Description

The Description of the Item.

Element: ItemID [type InventoryItemIDType]

Description

The ID of the Item.

Attributes




33






Element: ItemName [type InventoryItemSearchType]

Description

The name of the Inventory Item.

Element: ItemName [type InventoryItemType]

Description

The Name of the Item.

Element: ItemPool [type InventoryItemType]

Description

The Item Pool description of the Item.

Element: ItemRateCode [type ItemRateType]

Description

The Rate Code of the Item Rate.

Element: ItemRateID [type ItemRateType]

Description

The ID of the Item Rate.

Attributes




34






Element: Items [element FetchInventoryItemsRS]

Description

A collection of setup configurations for Inventory Items.

Content Model



1..1

Item InventoryItemType 0..*

Element: Language [type OperaContextType]

Description

Hotel's language code.

Element: LeadTime [type ItemVendorType]

Description

Lead time for ordering.

Element: LogLevel [type OperaContextType]

Description

Log level to debug the code, such as FINE, FINER, and so on.

Enumeration

Value

SEVERE

WARNING

INFO

CONFIG

FINE

FINER

35

Value

FINEST

ERROR

MESSAGE

DEBUG

TRACE

Element: Name [type ItemAttributeType]

Description

The Name of the Item Attribute.

Element: Name [type ItemRateType]

Description

The Name of the Item Rate.

Element: Name [type ItemVendorType]

Description

The Name of the vendor.

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, and so on.

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.

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.

36


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

Element: OutsideStay [type InventoryItemType/SellInfo]

Description

Define if the Item could be held outside of the reservation stay days.

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.

Element: OverrideWarnings [type ItemClassType]

Description

Indicates whether the all items to be updated when there are warnings.

Element: Phone [type ItemVendorType]

Description

The phone number of the Vendor.

Element: Price [type InventoryItemType/SellInfo]

Description

The Cost of the Item.

Attributes




Element: Price [type ItemRateType]

Description

The Price of the Item.

Attributes




Element: Price [type ItemVendorType]

Description

Purchase Price.

37

Attributes




Element: Print [type InventoryItemType]

Description

The Revenue Type of the Item.

Element: Priority [type ItemVendorType]

Description

The Priority of the Vendor.

Element: ProfileID

Attributes








Element: QtyInStock [type InventoryItemType/SellInfo]

Description

Item quantity in Stock.

Element: Rate [type ItemRatesType]

Content Model



1..1

38


ItemRateID UniqueID_Type 1..1 The ID of the Item Rate.

ItemRateCode CodeType 1..1 The Rate Code of the Item Rate.

Name StringLength200 0..1 The Name of the Item Rate.

Price CurrencyAmountType 0..1 The Price of the Item.

Hourly boolean 0..1 If true, an hourly rate.

Default boolean 0..1 If true, the default Rate for the Item.

Element: Rates [type InventoryItemType]

Description

A list of rates for the Item.

Content Model



1..1

Rate ItemRateType 0..*

Element: RevenueType [type InventoryItemType]

Description

The Revenue Type of the Item.

Element: RevenueTypeEditable [type InventoryItemType]

Description

If true, the revenue can be changed.

Element: RunningApplication [type OperaContextType]

Description

Running Application. (Not supported)

Element: SellControl [type InventoryItemType/SellInfo]

Description

If true, item is mandatory for booking.

Element: SellInfo [type InventoryItemType]

Description

The Sell Information of the Item.

Content Model



1..1

Available DateTimeSpanType 0..1 The available period of the Item.

39


QtyInStock double 0..1 Item quantity in Stock.

DefaultQty double 0..1 Defines the default quantity when booking the Item.

SellSeparate boolean 0..1 If true, the item could be sold separately.

SellControl boolean 0..1 If true, item is mandatory for booking.

WebBookable boolean 0..1 If true, web booking is allowed.

ItemClassWebBookable boolean 0..1 Specifies if web booking is allowed for the Item Class.

OutsideStay boolean 0..1 Define if the Item could be held outside of the reservation stay days.

FixedCharge boolean 0..1 If true, the Fixed Charges screen will be automatically displayed when this item gets attached to a reservation.

Discountable boolean 0..1 Specifies if a discount is allowed for this item.

ItemClassDiscountable boolean 0..1 Specifies if a discount is allowed for the Item Class.

CriticalInventory boolean 0..1 If true, the Item watches stock.

Price CurrencyAmountType 0..1 The Cost of the Item.

DefaultDuration integer 0..1 Define the default duration days when booking the Item.

Element: SellSeparate [type InventoryItemType/SellInfo]

Description

If true, the item can be sold separately.

Element: SetdownTime [type InventoryItemType]

Description

Set down time of the Item in minutes.

Element: SetdownTime [type ItemAttributeType]

Description

The set down time of the Item Attribute in minutes.

Element: SetupTime [type InventoryItemType]

Description

The setup time of the Item in minutes.

Element: SetupTime [type ItemAttributeType]

Description

The setup time of the Item Attribute in minutes.

40

Element: StartDateTime [type DateTimeSpanType]

Element: Success [type OperaWebServiceRSBaseType]

Description


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 web services from OPERA UI through integration.

Element: TerminalId [type OperaContextType]

Description

Terminal ID from where this request originated.

Element: TraceText [type InventoryItemType]

Description

The Trace Text of the Item.

Element: Type [group ]

Description

Type with Item Class to be searched.

Enumeration

Value

Reservation

Events

ReservationAndEvents

Element: Type [type ItemClassType]

Description

Item Class Type. For example, Reservations, Events

Enumeration

Value

Reservation

Events

ReservationAndEvents

Element: UseLocal [type OperaContextType]

Description

Determines if the local system should be used and the external system ignored.

41

Element: UserLanguage [type OperaContextType]

Description

User's language code.

Element: Vendor [type ItemVendorsType]

Content Model



1..1

ProfileID UniqueID_Type (extension)

1..1

Name StringLength100 0..1 The name of the vendor.

LeadTime StringLength200 0..1 The lead time for ordering.

Price CurrencyAmountType 0..1 The purchase price.

Priority double 1..1 The Priority of the Vendor.

Phone StringLength2000 0..1 The phone number of the Vendor.

Fax StringLength2000 0..1 The fax number of the Vendor.

Email StringLength2000 0..1 The email address of the Vendor.

Element: Vendors [type InventoryItemType]

Description

List of Vendors of the Item.

Content Model



1..1

Vendor ItemVendorType 0..*

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


42







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: WebBookable [type InventoryItemType/SellInfo]

Description

If true, web booking is allowed.

Element: WebBookable [type ItemClassType]

Description

43

Indicates if the Item Class is bookable via the website.

Element: WildCard [type GenericMultipleCodesSearchType]

Description

Wildcard search on the code.

opera cloud web self-service · pdf filea standard way to indicate that an error occurred...

Documents