opera cloud web self-service · pdf filethis document is intended for developers who develop...

Oracle® Hospitality OPERA Cloud Web Self-Service

LOV 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 LOVService .......................................................................................... 5

LOVService Web Service .................................................................................................................................................. 6

Methods: LOVService ................................................................................................................................................ 7

Complex Types: LOVService .................................................................................................................................... 8

Elements: LOVService .............................................................................................................................................. 15

4

Preface

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

Sources

Name Description

LOVService The LOV Service provides various List of Values for drop-down components and single/multi-select LOVs for the user interface. This is a generic service in that the particular LOV is requested by code. This service is secured.

6

LOVService Web Service

Name

LOVService

Description

The LOV Service provides various List of Values for drop-down components and single/multi-select LOVs for the

user interface. This is a generic service in that the particular LOV is requested by code. This service is secured.

See Also

Methods

Elements

Complex Types

7

Methods: LOVService

Methods

Name Description

FetchListOfValues The Fetch List of Values operation requests a List of Values from the Database for a given LOV name. Some LOVs may require or permit additional parameters that further refine the list returned. Upon success, a collection containing name-value pairs is returned, perhaps with additional details.

Method: FetchListOfValues

Description

The Fetch List of values operation requests a List of Values from the Database for a given LOV name.

Some LOVs may require or permit additional parameters that further refine the list returned. Upon success,

a collection containing name-value pairs is returned, perhaps with additional details.

Input

The input of this method is the document element FetchListOfValuesRQ 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 ListOfValuesCriteriaType No 0..1

Output

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

ListOfValues ListOfValuesType No 0..1 Collection of List of Value items.

8

Complex Types: LOVService

Complex Type: CodeListType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Code CodeType 0..* Code corresponding to the list of values collection

requested.

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

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

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.

9


Status string No If present, recommended values are those enumerated in the OTA_ErrorRS, (NotProcessed, Incomplete, Complete, and 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


Language language No Language identification.

Complex Type: IDType

Attributes


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

Complex Type: IDTypes

Content Model



1..1

10


ID IDType 0..*

Complex Type: ItemType

Attributes


Code StringLength2000 Yes Used for Character Strings, length 0 to 2000.

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

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

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

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

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

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

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

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

Active boolean No

Content Model



1..1

IDs IDTypes 0..1

Flexfields ParametersType 0..1 Flex fields returning list of name value pairs.

Complex Type: ListOfValuesCriteriaType

Attributes


LOVName StringLength20 (restriction)

No

IncludeInactive boolean No Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.

Content Model



1..1

Parameters ParametersType 0..1 Please see documentation for a list of applicable Parameter Name options.

ItemCodes StringLength2000 0..*

ExcludeCodeList CodeListType 0..1

Complex Type: ListOfValuesType

Attributes

11



No

ItemCount int No

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

Content Model



1..1

Items anyType (restriction) 0..1

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



1..1

UserLanguage language 0..1 A user's language code.

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

HotelCode CodeType 0..1 The hotel code.

Language CodeType 0..1 The 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.

12

Attributes


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

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

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

CorrelationID StringLength80 No 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 an extension for OPERA Web Services Responses to provide uniform

implementation.

Attributes






13

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

Description

List of Generic Name-Value-Pair Parameters.

Content Model



1..1

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

Complex Type: ParameterType

Description

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

being passed are too dynamic to be defined.

Content Model



1..1

ParameterName string 0..1 Name of the parameter.

ParameterValue string 0..1 Value of the parameter.

Complex Type: 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: WarningsType

Description

Collection of warnings.

Content Model


14


1..1

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

Complex Type: WarningType

Description

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

Attributes


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




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



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

15

Elements: LOVService

Element: Code [type CodeListType]

Element: Criteria [element FetchListOfValuesRQ]

Attributes



No Name for the collection of values

IncludeInactive boolean No Only useful for LOVs that support toggle of inactive records inclusion. When set to true, inactive records will be included.

Content Model



1..1

Parameters ParametersType 0..1 Please see documentation for a list of applicable Parameter Name options.

ItemCodes StringLength2000 0..* List of codes that belong to the collection requested

ExcludeCodeList CodeListType 0..1 Excluded codes in the requested list

Element: CROCode [type OperaContextType]

Description

Central Reservation office (CRO) code.

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




16


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



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

Element: Errors [type OperaWebServiceRSBaseType]

Description

Refer to Generic common types document.

Content Model



1..1

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

Element: ExcludeCodeList [type ListOfValuesCriteriaType]

Content Model



1..1

Code CodeType 0..*

17

Element: ExternalSystem [type OperaContextType]

Description

External system code.

Element: FetchListOfValuesRQ

Attributes






Content Model



1..1

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

Criteria ListOfValuesCriteriaType 0..1

Element: FetchListOfValuesRS

Attributes





18



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.

ListOfValues ListOfValuesType 0..1 Collection of List of Value items.

Element: Flexfields [type ItemType]

Description

Flexfields returning list of name value pairs.

Content Model



1..1


Element: HotelCode [type OperaContextType]

Description

Hotel code.

Element: ID [type IDTypes]

Attributes


Source StringLength20 Yes

Element: IDs [type ItemType]

Content Model



1..1

ID IDType 0..*

Element: Item [type ListOfValuesType/Items]

Attributes

19


Code StringLength2000 Yes

Name StringLength2000 No

Description StringLength2000 No

OrderValue StringLength20 No

ParentCode StringLength2000 No

HotelCode StringLength20 No

Color StringLength20 No

ShortDescription StringLength2000 No

ImageURL StringLength2000 No

Active boolean No

Content Model



1..1

IDs IDTypes 0..1

Flexfields ParametersType 0..1 Flex fields returning list of name value pairs.

Element: ItemCodes [type ListOfValuesCriteriaType]

Element: Items [type ListOfValuesType]

Content Model



1..1

Item ItemType 0..*

Element: Language [type OperaContextType]

Description

Hotel's language code.

Element: ListOfValues [element FetchListOfValuesRS]

Description

Collection of List of Value items.

Attributes



No

ItemCount int No

Description StringLength20 No

Content Model

20



1..1

Items anyType (restriction) 0..1

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


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

21


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

Description

Please see documentation for a list of applicable ParameterName options.

Content Model



1..1


Element: ParameterValue [type ParameterType]

Description

Value of the parameter.

Element: RunningApplication [type OperaContextType]

Description

Running Application. (Not supported)

22

Element: Success [type OperaWebServiceRSBaseType]

Description


Element: TargetExternalSystem [type OperaContextType]

Description

This element carries ID of the External System that serves this request. It is only needed when 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: UseLocal [type OperaContextType]

Description

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

Element: UserLanguage [type OperaContextType]

Description

User's language code.

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




23


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



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

Element: Warnings [type OperaWebServiceRSBaseType]

Description


Content Model



1..1

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

opera cloud web self-service · pdf filethis document is intended for developers who develop...

Documents