OPERA Cloud Web Self-Service - Oracle Help Center · PDF fileRefer to OpenTravel Code List...
-
Upload
phungtuong -
Category
Documents
-
view
234 -
download
4
Transcript of OPERA Cloud Web Self-Service - Oracle Help Center · PDF fileRefer to OpenTravel Code List...
Oracle® Hospitality OPERA Cloud Web Self-Service
Inventory 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 InventoryService .................................................................................. 5
Inventory Web Service ...................................................................................................................................................... 6
Methods: Inventory .................................................................................................................................................... 7
Complex Types: Inventory ........................................................................................................................................ 8
Elements: Inventory ................................................................................................................................................. 18
4
Preface
This document describes the InventoryService 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
5
1 InventoryService
Sources
Name Description
Inventory The Inventory web service provides the ability to fetch Hotel Room Type Inventory in real time and manage Overbooking/Sell Limits at different levels. It also contains operations to fetch Item Inventory.
6
Inventory Web Service
Name
Inventory
Description
The Inventory web service provides the ability to fetch Hotel Room Type Inventory in real time and manage
Overbooking/Sell Limits at different levels. It also contains operations to fetch Item Inventory.
See Also
Methods
Elements
Complex Types
7
Methods: Inventory
Methods
Name Description
FetchItemInventory Fetches Item Inventories for a property. The Item Class, Item Code, and Item Pool can be passed along with the date range as part of the request to filter the Items in the inventory response.
Method: FetchItemInventory
Description
Fetches Item Inventories for a property. The Item Class, Item Code, and Item Pool can be passed along with the
date range as part of the request to filter the Items in the inventory response.
Input
The input of this method is the document element FetchItemInventoryRQ 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 ItemInventorySearchType No 0..1 Criteria for fetching items inventory/availability.
Output
The output of this method is the document element FetchItemInventoryRS having the structure defined by the
following table.
Name Type Required? Occurs Description
Yes 1..1
Errors ErrorsType No 0..1 Refer to Generic common types document.
Yes 1..1
ItemInventory PoolItemInventoryCountsListType No 0..1 Collection of Reservations returned/fetched as per the criteria in the fetch request.
8
Complex Types: Inventory
Complex Type: CodeListType
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
Code CodeType 0..*
Complex Type: DailyItemInventoryCountsListType
Description
Collection of Inventory counts for the given dates.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
Inventory DailyItemInventoryCountsType 0..* Inventory counts for the given date.
Complex Type: DailyItemInventoryCountsType
Description
Inventory counts for the given date.
Attributes
Name Type Required? Description
Date date Yes Date of the item inventory.
Total integer No Total Item count.
Available integer No Available Item count.
Complex Type: ErrorsType
Description
A collection of errors that occurred during the processing of a message.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
Error ErrorType 0..99 An error that occurred during the processing of a message.
Complex Type: ErrorType
Description
Standard way to indicate that an error occurred during the processing of an OpenTravel message. If the message
successfully processes, but there are business errors, those errors should be passed in the warning element.
9
Attributes
Name Type Required? Description
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.
Complex Type: FreeTextType
Description
Textual information to provide descriptions and/or additional information.
Attributes
10
Name Type Required? Description
Language language No Language identification.
Complex Type: ItemInfoType
Description
Basic information regarding an Item.
Attributes
Name Type Required? Description
Code CodeType Yes The item code.
Name StringLength200 Yes The name of an item.
ItemPool boolean No Indicates if this is an item pool. Not applicable for Item within the Item Pool.
SellSeparate boolean No Indicates if the item is allowed to be sold separately.
SellInReservation boolean No Indicates if the item can be sold in reservation.
SellInEvent boolean No Indicates if the item can be sold in an event.
RequiredForBooking boolean No Indicates if the item is required for the reservation.
FixedCharge boolean No Indicates if the item has a fixed charge when it is attached to a reservation.
OutsideStay boolean No Indicates if the item could be held outside of the reservation stay days.
DefaultDuration int No Define the default duration in days when booking the item.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
Description StringLength2000 0..1 Detail description of an item.
AvailabilityPeriod TimeWindowType 0..1 Defines a time period when the item is available.
Complex Type: ItemInventoryCountsListType
Description
Collection of items with brief information and its Inventory counts for the given dates.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
Item ItemInventoryCountsType 0..* Provides item's brief information and a collection of Inventory counts for the given dates for the item.
Complex Type: ItemInventoryCountsType
Description
11
Provides an item's brief information and a collection of inventory counts for the given dates for the item.
Attributes
Name Type Required? Description
Code CodeType Yes The item code.
Name StringLength200 Yes The name of an item.
ItemPool boolean No Indicates this is an item pool. Not applicable for Item within the Item Pool.
SellSeparate boolean No Indicates if the item is allowed to be sold separately.
SellInReservation boolean No Indicates if the item can be sold in reservation.
SellInEvent boolean No Indicates if the item can be sold in an event.
RequiredForBooking boolean No Indicates if the item is required for the reservation.
FixedCharge boolean No Indicates if the item has fixed charge when it is attached to a reservation.
OutsideStay boolean No Indicates if the item can be held outside of the reservation stay days.
DefaultDuration int No Define the default duration in days when booking the item.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
Description StringLength2000 0..1 Detail description of an item.
AvailabilityPeriod TimeWindowType 0..1 Defines a Time period when the item is available.
Inventories DailyItemInventoryCountsListType 0..1 Collection of Inventory counts for the given dates.
Complex Type: ItemInventorySearchType
Description
Search criteria to fetch items/item pool Inventory counts for the given dates.
Attributes
Name Type Required? Description
HotelCode CodeType Yes Hotel Code whose Item Inventory is being requested.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
TimeSpan TimeSpanType 0..1 Date Range to fetch the daily inventories of the items.
AvailabilityPeriod TimeWindowType 0..1 Start and End time to filter the items available during the defined time window/period.
12
Component Type Occurs Description
ItemClass CodeType 0..1 Item Class to filter the Items/Item Pools in the response.
ItemPools CodeListType 0..1 Collection of Item Pools to filter the Item Pools in the response.
Items CodeListType 0..1 Collection of Items to filter the Items in the response.
SellAttributes ItemSellAttributesType 0..1 Defines additional filtration on the items based its sell attributes. Multiple attributes are applied with an OR condition.
Complex Type: ItemSellAttributesType
Description
Defines attributes related to selling of an item.
Attributes
Name Type Required? Description
SellSeparate boolean No Indicates if the item is allowed to be sold separately.
SellInReservation boolean No Indicates if the item can be sold in reservation.
SellInEvent boolean No Indicates if the item can be sold in an event.
RequiredForBooking boolean No Indicates if the item is required for the reservation.
FixedCharge boolean No Indicates if the item has a fixed charge when it is attached to a reservation.
OutsideStay boolean No Indicates if the item could be held outside of the reservation stay days.
DefaultDuration int No Define the default duration in days when booking the item.
Complex Type: OperaContextType
Description
Instructions common to all messages to set a certain context in the OPERA Database before serving the message
request.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
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.
13
Component Type Occurs Description
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 if the local system should be used and the external system ignored.
Complex Type: OperaWebServiceRQBaseType
Description
This Request base type is used as an extension for OPERA Web Services Requests to provide a uniform
implementation.
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 (for example, 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).
Version StringLength40 No For all OPERA versioned messages, the version of the message is indicated by an OPERA Version value.
CorrelationID StringLength80 No Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
OperaContext OperaContextType 0..1 Refer to Generic common types document.
Complex Type: OperaWebServiceRSBaseType
Description
This Response base type is used as an extension for OPERA Web Services Responses to provide a uniform
implementation.
Attributes
14
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 (for example, 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).
Version StringLength40 No For all OPERA versioned messages, the version of the message is indicated by an OPERA Version value.
CorrelationID StringLength80 No Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
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: PoolItemInventoryCountsListType
Description
A collection of items/item pool with brief information and inventory counts for the given dates.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
Item PoolItemInventoryCountsType 0..* Items/Item pool with brief information and inventory counts for the given dates.
Complex Type: PoolItemInventoryCountsType
Description
Items/Item pool with brief information and inventory counts for the given dates.
Attributes
Name Type Required? Description
Code CodeType Yes The item code.
15
Name Type Required? Description
Name StringLength200 Yes The name of an item.
ItemPool boolean No Indicates this is an item pool. Not applicable for Item within the Item Pool.
SellSeparate boolean No Indicates the item is allowed to be sold separately.
SellInReservation boolean No Indicates the item can be sold in reservation.
SellInEvent boolean No Indicates the item can be sold in an event.
RequiredForBooking boolean No Indicates the item is required for the reservation.
FixedCharge boolean No Indicates the item has a fixed charge when it is attached to a reservation.
OutsideStay boolean No Indicates the item could be held outside of the reservation stay days.
DefaultDuration int No Define the default duration in days when booking the item.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
Description StringLength2000 0..1 Detail description of an item.
AvailabilityPeriod TimeWindowType 0..1 Defines a Time period when the item is available.
Inventories DailyItemInventoryCountsListType 0..1 Collection of Inventory counts for the given dates.
PoolItems ItemInventoryCountsListType 0..1 Collection of items in the pool with brief information and its Inventory counts for the given dates. If element is populated when the parent item is a pull (when ItemPool is true), ItemPool flag for this item, which is an item in the pool, cannot not be true.
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: TimeSpanType
Description
Measure of time from a StartDate to either the specified EndDate or StartDate plus Duration.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
StartDate date 0..1
16
Component Type Occurs Description
1..1
Duration duration 0..1
EndDate date 0..1
Complex Type: TimeWindowType
Description
Defines a time period with a start time and an end time.
Attributes
Name Type Required? Description
StartTime time No Start Time of the Time window.
EndTime time No End Time of the Time window.
Complex Type: WarningsType
Description
Collection of warnings.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
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
Name Type Required? Description
Type CodeType Yes The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". Refer to OpenTravel Code List Error Warning Type (EWT).
ShortText string No An abbreviated version of the error in textual format.
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.
17
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.
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.
RPH RPH_Type No Reference Place Holder used as an index for this warning.
18
Elements: Inventory
Element: AvailabilityPeriod [type ItemInfoType]
Description
Defines a Time period when the item is available.
Attributes
Name Type Required? Description
StartTime time No Start Time of the Time window.
EndTime time No End Time of the Time window.
Element: AvailabilityPeriod [type ItemInventorySearchType]
Description
Start and End time to filter the items available during the defined time window/period.
Attributes
Name Type Required? Description
StartTime time No Start Time of the Time window.
EndTime time No End Time of the Time window.
Element: Code [type CodeListType]
Element: Criteria [element FetchItemInventoryRQ]
Description
Criteria for fetching items inventory/availability.
Attributes
Name Type Required? Description
HotelCode CodeType Yes Hotel Code whose Item Inventory is being requested.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
TimeSpan TimeSpanType 0..1 Date Range to fetch the daily inventories of the items.
AvailabilityPeriod TimeWindowType 0..1 Start and End time to filter the items available during the defined time window/period.
ItemClass CodeType 0..1 Item Class to filter the Items/Item Pools in the response.
ItemPools CodeListType 0..1 Collection of Item Pools to filter the Item Pools in the response.
Items CodeListType 0..1 Collection of Items to filter the Items in the response.
19
Component Type Occurs Description
SellAttributes ItemSellAttributesType 0..1 Defines additional filtration on the items based on its sell attributes. Multiple attributes are applied with an OR condition.
Element: CROCode [type OperaContextType]
Description
Central Reservation office (CRO) code.
Element: Description [type ItemInfoType]
Description
Detail description of an item.
Element: Duration [type TimeSpanType]
Element: EndDate [type TimeSpanType]
Element: Error [type ErrorsType]
Description
An error that occurred during the processing of a message.
Attributes
Name Type Required? Description
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.
20
Name Type Required? Description
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.
Element: Errors [type OperaWebServiceRSBaseType]
Description
Refer to Generic common types document.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
Error ErrorType 0..99 An error that occurred during the processing of a message.
Element: ExternalSystem [type OperaContextType]
Description
External system code.
Element: FetchItemInventoryRQ
Description
Request object for retrieving information regarding an item’s inventory/availability.
Attributes
21
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 (for example, 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).
Version StringLength40 No For all OPERA versioned messages, the version of the message is indicated by an OPERA Version value.
CorrelationID StringLength80 No Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
OperaContext OperaContextType 0..1 Refer to Generic common types document.
Criteria ItemInventorySearchType 0..1 Criteria for fetching items inventory/availability.
Element: FetchItemInventoryRS
Description
Return object to the request for information regarding items inventory/availability.
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 (for example, 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38Z).
Version StringLength40 No For all OPERA versioned messages, the version of the message is indicated by an OPERA Version value.
CorrelationID StringLength80 No Allow end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
Content Model
22
Contains elements as defined in the following table.
Component Type Occurs Description
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.
ItemInventory PoolItemInventoryCountsListType 0..1 Collection of Reservations returned/fetched as per the criteria in the fetch request.
Element: HotelCode [type OperaContextType]
Description
Hotel code.
Element: Inventories [type ItemInventoryCountsType]
Description
Collection of Inventory counts for the given dates.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
Inventory DailyItemInventoryCountsType 0..* Inventory counts for the given date.
Element: Inventory [type DailyItemInventoryCountsListType]
Description
Inventory counts for the given date.
Attributes
Name Type Required? Description
Date date Yes Date of the item inventory.
Total integer No Total Item count.
Available integer No Available Item count.
Element: Item [type ItemInventoryCountsListType]
Description
Provides brief information and a collection of Inventory counts for the given dates for the item.
Attributes
Name Type Required? Description
Code CodeType Yes The item Code.
Name StringLength200 Yes The name of an item.
23
Name Type Required? Description
ItemPool boolean No Indicates this is an item pool. Not applicable for Item within the Item Pool.
SellSeparate boolean No Indicates an item is allowed to be sold separately.
SellInReservation boolean No Indicates an item can be sold in the reservation.
SellInEvent boolean No Indicates an item can be sold in the event.
RequiredForBooking boolean No Indicates an item is required for the reservation.
FixedCharge boolean No Indicates an item has a fixed charge when attached to a reservation.
OutsideStay boolean No Indicates an item could be held outside of the reservation stay days.
DefaultDuration int No Define the default duration in days when booking the item.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
Description StringLength2000 0..1 Detail description of an item.
AvailabilityPeriod TimeWindowType 0..1 Defines a Time period when the item is available.
Inventories DailyItemInventoryCountsListType 0..1 Collection of Inventory counts for the given dates.
Element: Item [type PoolItemInventoryCountsListType]
Description
Items/Item pool with brief information and its Inventory counts for the given dates.
Attributes
Name Type Required? Description
Code CodeType Yes The item code.
Name StringLength200 Yes The name of an item.
ItemPool boolean No Indicates this is an item pool. Not applicable for Item within the Item Pool.
SellSeparate boolean No Indicates an item is allowed to be sold separately.
SellInReservation boolean No Indicates an item can be sold in reservation.
SellInEvent boolean No Indicates an item can be sold in the event.
RequiredForBooking boolean No Indicates an item is required for the reservation.
FixedCharge boolean No Indicates an item has a fixed charge when it is attached to a reservation.
OutsideStay boolean No Indicates an item could be held outside of the reservation stay days.
DefaultDuration int No Define the default duration in days when booking the item.
Content Model
24
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
Description StringLength2000 0..1 Detail description of an item.
AvailabilityPeriod TimeWindowType 0..1 Defines a Time period when the item is available.
Inventories DailyItemInventoryCountsListType 0..1 Collection of Inventory counts for the given dates.
PoolItems ItemInventoryCountsListType 0..1 Collection of items in the pool with brief information and its Inventory counts for the given dates. It element is populated when the parent item is a pull (when ItemPool is true.), ItemPool flag for this item, which is an item in the pool, cannot not be true.
Element: ItemClass [type ItemInventorySearchType]
Description
Item Class to filter the Items/Item Pools in the response.
Element: ItemInventory [element FetchItemInventoryRS]
Description
Collection of Reservations returned/fetched as per the criteria in the fetch request.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
Item PoolItemInventoryCountsType 0..* Items/Item pool with brief information and its Inventory counts for the given dates.
Element: ItemPools [type ItemInventorySearchType]
Description
Collection of Item Pools to filter the Item Pools in the response.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
Code CodeType 0..*
Element: Items [type ItemInventorySearchType]
Description
Collection of Items to filter the Items in the response.
Content Model
Contains elements as defined in the following table.
25
Component Type Occurs Description
1..1
Code CodeType 0..*
Element: Language [type OperaContextType]
Description
A hotel's language code.
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
FINEST
ERROR
MESSAGE
DEBUG
TRACE
Element: OperaContext [type OperaWebServiceRQBaseType]
Description
Refer to Generic common types document.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
UserLanguage language 0..1 A user's language code.
CROCode CodeType 0..1 Central Reservation Office (CRO) code.
HotelCode CodeType 0..1 A hotel code.
Language CodeType 0..1 A 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.
26
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.
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.
Element: Override [type OperaContextType]
Description
OPERA context is derived internally by request. If the client wants to override the OPERA Context, the client can
send true and then the OperaContext will override the above settings, such as HotelCode.
Element: PoolItems [type PoolItemInventoryCountsType]
Description
Collection of items in the pool with brief information and its Inventory counts for the given dates. It element is
populated when the parent item is a pull (when ItemPool is true.), ItemPool flag for this item, which is an item in
the pool, cannot not be true.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
Item ItemInventoryCountsType 0..* Provides item's brief information and a collection of Inventory counts for the given dates for the item.
Element: RunningApplication [type OperaContextType]
Description
Running Application. (Not supported)
Element: SellAttributes [type ItemInventorySearchType]
Description
Defines additional filtration on the items based its sell attributes. Multiple attributes are applied with an OR
condition..
Attributes
Name Type Required? Description
SellSeparate boolean No Indicates the item is allowed to be sold separately.
SellInReservation boolean No Indicates the item can be sold in the reservation.
SellInEvent boolean No Indicates the item can be sold in the event.
RequiredForBooking boolean No Indicates the item is required for the reservation.
27
Name Type Required? Description
FixedCharge boolean No Indicates the item has a fixed charge when it is attached to a reservation.
OutsideStay boolean No Indicates the item could be held outside of the reservation stay days.
DefaultDuration int No Define the default duration in days when booking the item.
Element: StartDate [type TimeSpanType]
Element: Success [type OperaWebServiceRSBaseType]
Description
Refer to Generic common types document.
Element: TargetExternalSystem [type OperaContextType]
Description
This element carries ID of the External System that serves this request. It is only needed 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: TimeSpan [type ItemInventorySearchType]
Description
Date Range to fetch the daily inventories of the items.
Content Model
Contains elements as defined in the following table.
Component Type Occurs Description
1..1
StartDate date 0..1
1..1
Duration duration 0..1
EndDate date 0..1
Element: UseLocal [type OperaContextType]
Description
Determines if the local system should be used and the external system ignored.
Element: UserLanguage [type OperaContextType]
Description
User's language code.
28
Element: Warning [type WarningsType]
Description
Used in conjunction with the Success element to define a business error.
Attributes
Name Type Required? Description
Type CodeType Yes The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". Refer to OpenTravel Code List Error Warning Type (EWT).
ShortText string No An abbreviated version of the error in textual format.
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.
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.