Oracle® Hospitality OPERA Web Self-Service

Reservation Web Service Specifications

Version 5.1

March 2019

 


Copyright © 1987, 2019, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.


Contents

Preface. 20

Audience. 20

Customer Support. 20

Documentation.. 20

Revision History. 20

1    Introduction. 30

2    Functional Overview. 31

3    AddAccompanyGuest 35

AddAccompanyGuestRequest. 35

AddAccompanyGuestsRQ_Leg1. 36

AddAccompanyGuestsRQ_Leg2. 37

AddAccompanyGuestsRQ_Leg3. 38

AddAnotherAccompanyGuestRQ_Leg1. 39

AddAnotherAccompanyGuestRQ_Leg2. 40

AddAnotherAccompanyGuestRQ_Leg3. 40

AddAccompanyGuestResponse. 41

AddAccompanyGuestsRS_Leg1. 42

AddAccompanyGuestsRS_Leg2. 43

AddAccompanyGuestsRS_Leg3. 43

AddAnotherAccompanyGuestRS_Leg1. 44

AddAnotherAccompanyGuestRS_Leg2. 45

AddAnotherAccompanyGuestRS_Leg3. 51

4    AssignRoom.. 52

AssignRoomRequest. 52

AssignRoomResponse. 53

5    BookHoldItems 55

BookHoldItemsRequest. 55

BookHoldItemsResponse. 57

6    BreakShare. 58

BreakShareRequest. 58

BreakShareResponse. 59

7    CancelBooking. 61

CancelBookingRequest. 61

CancelBooking 2nd Leg External Reference Request. 61

CancelBooking with Language Code Request. 62

CancelBooking of FavGuest Request. 63

CancelBooking Request with Terminal ID.. 63

CancelBookingResponse. 65

CancelBooking 2nd Leg External Reference Response. 66

CancelBooking with Language Code Response. 67

CancelBooking of FavGuest Response. 67

CancelBooking Response with Terminal ID.. 68

8    ClearItemHold. 70

ClearItemHoldRequest. 70

ClearItemHoldResponse. 71

9    CombineShare. 72

CombineShareRequest. 72

CombineShareResponse. 74

10  ConfirmBooking. 78

ConfirmBookingRequest. 78

ConfirmBookingResponse. 79

11  CreateBooking. 81

CreateBookingRequest. 81

CreateBookingRequest with Leg ID.. 83

CreateBooking 1st Leg External Reference Request. 85

CreateBooking 2nd Leg External Reference Request. 87

CreateBookingRequest With Multiple Rate Codes. 89

CreateBookingRequest With Switch Card.. 92

CreateBookingRequest With Multiple Memberships. 96

CreateBookingRequest With UDFs. 100

CreateBookingRequest by GDS. 102

CreateBookingRequest using Block Code. 104

CreateBooking Request for Points Redemption.. 106

CreateBooking Request with Profile Number and Guaranteed using IATA Number. 108

CreateBooking Request using Promotion or Coupon Code. 110

CreateBooking Request Guaranteed by Company. 111

CreateBooking Request with Comments Guest Viewable. 113

CreateBooking Request with NativeName. 115

CreateBooking CC GTD Request Reduced Message Size. 117

CreateBooking Packages Request. 119

CreateBooking Maximum Occupancy Request. 121

CreateBooking Request Points Only. 122

CreateBooking Request with Estimated Time of Arrival 124

CreateBooking Request with Language Translation.. 126

CreateBooking Request with Language Code. 131

CreateBooking ChipAndPin False Request. 133

CreateBooking Non-ChipAndPin True Request. 135

CreateBooking with Discount Request. 137

CreateBooking with Discount and Rate Amount Request. 139

CreateBooking with Discount Percent Request. 141

CreateBooking with E Certificate Request. 143

CreateBooking with Email Format Request. 146

CreatingBooking with Profile Discount Request. 148

CreatingBooking Using Redeem Rate for FavGuest Request. 149

CreateBooking Non-Cancelable Request. 151

CreateBooking Using Contact and Company Request. 152

CreateBookingRequest with transportationRequired = N for Pick-up and Drop-off. 154

CreateBookingRequest with transportationRequired = Y for Pick-up and  Drop-off. 157

CreateBooking Request Room Features. 159

CreateBooking Request Points Breakdown Per Night. 162

CreateBooking Request canHandleVaultedCreditCard="true". 164

CreateBooking Request with Profession.. 166

CreateBooking Request with Terminal ID.. 168

CreateBookingResponse. 171

CreateBookingResponse with Leg ID.. 176

CreateBooking 1st Leg External Reference Response. 180

CreateBooking 2nd Leg External Reference Response. 184

CreateBookingResponse with Multiple Rate Codes. 188

CreateBookingResponse with Multiple Memberships. 193

CreateBookingResponse with UDFs. 198

CreateBooking Response by GDS. 203

CreateBooking Response using Block Code. 208

CreateBooking Response for Points Redemption.. 212

CreateBooking Response with Profile Number and Guaranteed using IATA Number. 216

CreateBooking Response using Promotion or Coupon Code. 222

CreateBooking Response Guaranteed by Company. 226

CreateBooking Response  with Comments Guest Viewable. 232

CreateBooking Response with NativeName. 237

CreateBooking Response CC GTD with Reduced Message Size. 241

CreateBooking Packages Response. 243

CreateBooking Response with Maximum Occupancy. 247

CreateBooking Response Points Only. 247

CreateBooking Response with Estimated Time of Arrival 250

CreateBooking Response with Language Translation.. 254

CreateBooking Response with Language Code. 259

CreateBooking ChipAndPin False Response. 265

CreateBooking Non-ChipAndPin True Response. 270

CreateBooking with Discount Response. 275

CreateBooking with Discount and Rate Amount Response. 280

CreateBooking with Discount Percent Response. 286

CreateBooking with E Certificate Response. 291

CreateBooking with Email Format Response. 298

CreateBooking with Profile Discount Response. 304

CreateBooking Using Redeem Rate for FavGuest  Response. 309

CreateBooking Non-Cancelable Response. 313

CreateBooking Using Contact and Company  Response. 319

CreateBookingResponse with transportationRequired = N for Pick-up and Drop-off. 325

CreateBookingResponse with transportationRequired = Y for Pick-up and  Drop-off. 331

CreateBooking Response with Room Features. 336

CreateBooking Response Points Breakdown Per Night. 343

CreateBookingResponse canHandleVaultedCreditCard="true". 349

CreateBookingResponse with Profession.. 354

CreateBooking Response with Terminal ID.. 359

12  CreateItemHold. 369

CreateItemHoldRequest. 369

CreateItemHoldResponse. 370

13  CreateMultipleBookings 372

CreateMultipleBookingsRequest. 372

CreateMultipleBookingsResponse. 377

14  DeleteAccompanyGuest 389

DeleteAccompanyGuestRequest. 389

DeleteAccompanyGuestResponse. 390

DeleteAccompanyGuestRQ_Leg1. 391

DeleteAccompanyGuestRS_Leg1. 392

DeleteAccompanyGuestRQ_Leg2. 392

DeleteAccompanyGuestRS_Leg2. 393

DeleteAccompanyGuestRQ_Leg3. 394

DeleteAccompanyGuestRS_Leg3. 394

15  DeleteInventoryItem.. 396

DeleteInventoryItemRequest. 396

DeleteInventoryItemResponse. 398

16  DeletePackages 399

DeletePackagesRequest. 399

Delete Booked Packages Request. 399

DeletePackagesResponse. 401

Delete Booked Packages Response. 401

17  EmailConfirmation. 403

EmailConfirmationRequest. 403

EmailConfirmation Request with Language Code. 403

EmailConfirmation Request using the “Confirmation Email From” Parameter Setting  404

EmailConfirmationResponse. 405

EmailConfirmation Response for Language Code. 406

EmailConfirmation Response using the “Confirmation Email From” Parameter Setting  406

18  FetchAvailableOffers 408

FetchAvailableOffersRequest. 408