28
Oracle ® Hospitality OPERA Cloud Web Self-Service Integration Processor Service Web Service Reference October 2017

OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

  • Upload
    others

  • View
    1

  • Download
    0

Embed Size (px)

Citation preview

Page 1: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

Oracle® Hospitality OPERA Cloud Web Self-Service

Integration Processor Service Web Service Reference

October 2017

Page 2: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

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.

Page 3: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

Contents

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

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

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

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

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

1 IntegrationProcessorService ................................................................. 5

IntegrationProcessorService Web Service ...................................................................................................................... 6

Methods: IntegrationProcessorService .................................................................................................................... 7

Complex Types: IntegrationProcessorService ........................................................................................................ 8

Elements: IntegrationProcessorService .................................................................................................................. 16

Page 4: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

4

Preface

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

Page 5: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

5

1 IntegrationProcessorService

Sources

Name Description

IntegrationProcessorService The Integration Processor Service provides a set of operations which help the external customers and vendors to process Business Events generated in OPERA.

Page 6: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

6

IntegrationProcessorService Web Service

Name

IntegrationProcessorService

Description

The Integration Processor Service provides a set of operations which help the external customers and vendors to

process Business Events generated in OPERA.

See Also

Methods

Elements

Complex Types

Page 7: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

7

Methods: IntegrationProcessorService

Methods

Name Description

FetchBusinessEvents Fetches messages from business event queue.

Method: FetchBusinessEvents

Description

Fetches messages from business event queue.

Input

Request object for FetchBusinessEvent operation.

Name Type Required? Occurs Description

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

Criteria BusinessEventsSearchCriteria Yes 1..1 Criteria to clear the messages from the BE queue.

Output

Response object for FetchBusinessEvent operation.

Name Type Required? Occurs Description

Yes 1..1

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

Yes 1..1

BusinessEventsList anyType (restriction)

Yes 1..1

Page 8: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

8

Complex Types: IntegrationProcessorService

Complex Type: BusinessEventDataType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

BusinessEvent BusinessEventType 1..1 Business event type.

BusinessEventID BusinessEventIDType 0..1 Unique identifier of the Business Event ID

Complex Type: BusinessEventDetailsType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Detail BusinessEventDetailType 1..*

Complex Type: BusinessEventDetailType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

DataElement string 1..1 Name of the data element, such as arrival date, departure date, and so on.

OldValue string 0..1 Value of the element when this action took place. In case of date values, format used is YYYY-MM-DD.

NewValue string 0..1 Value of the element after this action took place. In case of date values, format used is YYYY-MM-DD.

ScopeFrom date 0..1 Begin date from when this value is applicable, such as daily element date, block grid date, and so on.

ScopeTo date 0..1 End date till when this value is applicable, such as daily element date, block grid date, and so on.

ElementSequence int 0..1 Sequence number used to correlate fields of each record, when a collection of records is represented.

ElementType string 0..1 Element type used to correlate fields of each record, when a collection of records is represented, such as phone type for phones.

ElementRole string 0..1 Element role used to correlate fields of each record, when a collection of records is represented, such as phone role for phones.

HotelCode string 0..1 Optional code to represent the hotel to which the child data belongs to, such as preference codes of a profile.

Complex Type: BusinessEventHeaderType

Content Model

Page 9: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

9

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

ModuleName BusinessEventModuleType 1..1 Business event module name.

ActionType string 1..1 Business event action type, such as new reservation, update profile, and so on.

ActionId double 1..1 Unique action instance ID of the business event. Uniqueness is guaranteed intra-module only.

PrimaryKey string 1..1 Primary key value of the business event, such as reservation name ID, allotment header ID, and name ID.

ParentActionId double 0..1 Action instance ID of the parent business event, if the action triggered this event was a side effect of another action.

PublisherId double 1..1 Internal ID of the application or system user that triggered this event.

CreatedDateTime dateTime 1..1 Timestamp of the business event.

Complex Type: BusinessEventIDType

Attributes

Name Type Required? Description

Status BusinessEventIDStatusType No Message ID Status

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

Description

Criteria to fetch BE queued in Cloud for a resort

Attributes

Page 10: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

10

Name Type Required? Description

FetchSize integer No Number of messages the web service should clear from the BE queue.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

ModuleName BusinessEventModuleType 0..1 Module Name for which the message needs to be cleared from the BE queue.

ActionType string 0..1 Action type of corresponding module for which the message needs to be cleared from the BE queue. The Values of the ActionType are Business event action types, such as new reservation, update profile, and so on.

FetchInstructions anyType (restriction) 0..1 Collection of fetch instructions. This is currently not supported in this version.

Complex Type: BusinessEventType

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Header BusinessEventHeaderType 1..1 Business event header type.

Details BusinessEventDetailsType 1..1 Business event details collection.

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.

Attributes

Page 11: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

11

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

Page 12: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

12

Name Type Required? Description

Language language No Language identification.

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.

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

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.

Page 13: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

13

Name Type Required? Description

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 a base for an extension for OPERA Web Services Responses to provide

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

1..1

Page 14: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

14

Component Type Occurs Description

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

Name Type Required? Description

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

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

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

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

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

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

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.

Page 15: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

15

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.

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.

Page 16: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

16

Elements: IntegrationProcessorService

Element: ActionId [type BusinessEventHeaderType]

Description

Unique action instance ID of the business event, uniqueness is guaranteed intra-module only.

Element: ActionType [type BusinessEventHeaderType]

Description

Business event action type, such as new reservation, update profile, and so on.

Element: ActionType [type BusinessEventsSearchCriteria]

Description

Action type of corresponding module for which the message needs to be cleared from the BE queue. The Values

of the ActionType are Business event action types, such as new reservation, update profile, and so on.

Element: BusinessEvent [type BusinessEventDataType]

Description

Business event type.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Header BusinessEventHeaderType 1..1 Business event header type.

Details BusinessEventDetailsType 1..1 Business event details collection.

Element: BusinessEventData [element FetchBusinessEventsRS/BusinessEventsList]

Description

Criteria for fetching BusinessEvents.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

BusinessEvent BusinessEventType 1..1 Business event type.

BusinessEventID BusinessEventIDType 0..1 Unique identifier of the Business Event ID

Element: BusinessEventID [type BusinessEventDataType]

Description

Unique identifier of the Business Event ID

Attributes

Name Type Required? Description

Status BusinessEventIDStatusType No Message ID Status

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

Page 17: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

17

Name Type Required? Description

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

Element: BusinessEventsList [element FetchBusinessEventsRS]

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

BusinessEventData BusinessEventDataType 1..4000 Criteria for fetching BusinessEvents.

Element: CreatedDateTime [type BusinessEventHeaderType]

Description

Timestamp of the business event.

Element: Criteria [element FetchBusinessEventsRQ]

Description

Criteria to clear messages from the BE queue.

Attributes

Name Type Required? Description

FetchSize integer No Number of messages the web service should clear from the BE queue.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

ModuleName BusinessEventModuleType 0..1 Module Name for which the message needs to be cleared from the BE queue.

Page 18: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

18

Component Type Occurs Description

ActionType string 0..1 Action type of corresponding module for which the message needs to be cleared from the BE queue. The Values of the ActionType are Business event action types, such as new reservation, update profile, and so on.

FetchInstructions anyType (restriction) 0..1 Collection of fetch instructions. This is currently not supported in this version.

Element: CROCode [type OperaContextType]

Description

Central Reservation office (CRO) code.

Element: DataElement [type BusinessEventDetailType]

Description

Name of the data element, such as arrival date, departure date, and so on.

Element: Detail [type BusinessEventDetailsType]

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

DataElement string 1..1 Name of the data element, such as arrival date, departure date, and so on.

OldValue string 0..1 Value of the element when this action took place. In case of date values, format used is YYYY-MM-DD.

NewValue string 0..1 Value of the element after this action took place. In case of date values, format used is YYYY-MM-DD.

ScopeFrom date 0..1 Begin date from when this value is applicable, such as daily element date, block grid date, and so on.

ScopeTo date 0..1 End date till when this value is applicable, such as daily element date, block grid date, and so on.

ElementSequence int 0..1 Sequence number used to correlate fields of each record, when a collection of records is represented.

ElementType string 0..1 Element type used to correlate fields of each record, when a collection of records is represented, such as phone type for phones.

ElementRole string 0..1 Element role used to correlate fields of each record, when a collection of records is represented, such as phone role for phones.

HotelCode string 0..1 Optional code to represent the hotel to which the child data belongs to, such as preference codes of a profile.

Element: Details [type BusinessEventType]

Description

Business event details collection.

Page 19: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

19

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

Detail BusinessEventDetailType 1..*

Element: ElementRole [type BusinessEventDetailType]

Description

Element role used to correlate fields of each record, when a collection of records is represented, such as phone

role for phones.

Element: ElementSequence [type BusinessEventDetailType]

Description

Sequence number used to correlate fields of each record, when a collection of records is represented.

Element: ElementType [type BusinessEventDetailType]

Description

Element type used to correlate fields of each record, when a collection of records is represented, such as phone

type for phones.

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.

Page 20: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

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

Description

Request payload for fetch business event.

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.

Page 21: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

21

Name Type Required? Description

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 BusinessEventsSearchCriteria 1..1 Criteria to clear the messages from the BE queue.

Element: FetchBusinessEventsRS

Description

Provides business event message dequeued from BE queue as response

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

Page 22: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

22

Component Type Occurs Description

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.

BusinessEventsList anyType (restriction) 1..1

Element: FetchInstruction [type BusinessEventsSearchCriteria/FetchInstructions]

Description

Fetch instructions to be used.

Enumeration

Value

SkipEventIDs

FailedBussinessEvents

Element: FetchInstructions [type BusinessEventsSearchCriteria]

Description

Collection of fetch instructions. This is currently not supported in this version.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

FetchInstruction BusinessEventInstructionType 0..4000 Fetch instructions to be used.

Element: Header [type BusinessEventType]

Description

Business event header type.

Content Model

Contains elements as defined in the following table.

Component Type Occurs Description

1..1

ModuleName BusinessEventModuleType 1..1 Business event module name.

ActionType string 1..1 Business event action type, such as new reservation, update profile, and so on.

ActionId double 1..1 Unique action instance ID of the business event, uniqueness is guaranteed intra-module only.

PrimaryKey string 1..1 Primary key value of the business event, such as reservation name ID, allotment header ID, or name ID.

Page 23: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

23

Component Type Occurs Description

ParentActionId double 0..1 Action instance ID of the parent business event, if the action triggered this event was a side effect of another action.

PublisherId double 1..1 Internal ID of the application or system user that triggered this event.

CreatedDateTime dateTime 1..1 Timestamp of the business event.

Element: HotelCode [type BusinessEventDetailType]

Description

Optional code to represent the hotel to which the child data belongs to, such as preference codes of a profile.

Element: HotelCode [type OperaContextType]

Description

Hotel code.

Element: Language [type OperaContextType]

Description

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: ModuleName [type BusinessEventHeaderType]

Description

Business event module name.

Enumeration

Page 24: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

24

Value

ACTIVITY

AVAILABILITY

BLOCK

BLOCK OFFSETS

CASHIERING

CATERING

CATERING NOTES

CONFIGURATION

E-CERTIFICATE

ENROLLMENT

HOUSEKEEPING

MR_ENROLLMENT

NIGHT AUDIT

OWNER CONTRACT

PROFILE

RATE

RESERVATION

STAY RECORDS

Element: ModuleName [type BusinessEventsSearchCriteria]

Description

Module Name for which the message need to be cleared from the business event queue. Module are not

supported as a search criteria under FetchBusinessEventsRQ.

Enumeration

Value

ACTIVITY

AVAILABILITY

BLOCK

BLOCK OFFSETS

CASHIERING

CATERING

CATERING NOTES

CONFIGURATION

E-CERTIFICATE

ENROLLMENT

HOUSEKEEPING

MR_ENROLLMENT

NIGHT AUDIT

OWNER CONTRACT

PROFILE

Page 25: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

25

Value

RATE

RESERVATION

STAY RECORDS

Element: NewValue [type BusinessEventDetailType]

Description

Value of the element after this action took place. In case of date values, format used is YYYY-MM-DD.

Element: OldValue [type BusinessEventDetailType]

Description

Value of the element when this action took place. In case of date values, format used is YYYY-MM-DD.

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

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.

Page 26: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

26

Element: ParentActionId [type BusinessEventHeaderType]

Description

Action instance ID of the parent business event, if the action triggered this event was a side effect of another

action.

Element: PrimaryKey [type BusinessEventHeaderType]

Description

Primary key value of the business event, such as reservation name ID, allotment header ID, name ID, and so on.

Element: PublisherId [type BusinessEventHeaderType]

Description

Internal ID of the application or system user that triggered this event.

Element: RunningApplication [type OperaContextType]

Description

Running Application. (Not supported)

Element: ScopeFrom [type BusinessEventDetailType]

Description

Begin date from when this value is applicable, such as daily element date, block grid date, and so on.

Element: ScopeTo [type BusinessEventDetailType]

Description

End date till when this value is applicable, such as daily element date, block grid date, and so on.

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 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: UseLocal [type OperaContextType]

Description

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

Element: UserLanguage [type OperaContextType]

Description

User's language code.

Page 27: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

27

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.

Content Model

Page 28: OPERA Cloud Web Self-Service · ModuleName BusinessEventModuleType 1..1 Business event module name. ActionType string 1..1 Business event action type, such as new reservation, update

28

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.