opera property management - oracle help center xml... · if this software or related documentation...

Oracle® Hospitality OPERA Property Management

OPERA XML Posting Specifications Release 3.2

February 2020

2

Copyright © 2020, 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 3

Contents

Preface ....................................................................................................... 5

Audience .................................................................................................................................. 5

Customer Support ................................................................................................................... 5

Documentation ........................................................................................................................ 5

Revision History ...................................................................................................................... 5

1 Ifcws WSDL Information ..................................................................... 6

Ifcws WSDL ............................................................................................................................. 6

2 Process Command Supported Messages (inMsg) ................................ 8

PostInquiry Schema ................................................................................................................ 8

Example ............................................................................................................................. 8

PostRequest Schema ............................................................................................................... 9

Example ............................................................................................................................. 9

GuestCheckdetail Schema ................................................................................................... 16

GuestMessage Schema ......................................................................................................... 18

OPERA Responses to PostInquiry ...................................................................................... 19

PostList Response .......................................................................................................... 19

Example ........................................................................................................................... 19

PostAnswer Response ................................................................................................... 21

Example ........................................................................................................................... 21

OPERA Response to PostRequest ....................................................................................... 22

PostAnswer Response ................................................................................................... 22

Example ........................................................................................................................... 22

3 Answer Status Table .......................................................................... 24

4 Request Type Table ............................................................................ 25

5 XML Message Examples ..................................................................... 26

Post Inquiry with No Guests/Room found ........................................................................ 26

Request ................................................................................................................................... 26

Response ......................................................................................................................... 26

Post Inquiry Returning One Guest ..................................................................................... 26

Request ............................................................................................................................ 26

Response ......................................................................................................................... 26

Post Inquiry with RoomKey Track2/Swipe………………………………………………26

Request………………………………………………………………………………….26

Response……………………………………………………………………………….. 26

Post Inquiry Returning Multiple Guests ............................................................................ 27

4 Preface

Request ............................................................................................................................ 27

Response ......................................................................................................................... 27

Post Request Posting to Guest 3 from above PostList (Ms Lucille Ball, Room 210) .... 27

Request ............................................................................................................................ 27

Response ......................................................................................................................... 27

Post Request Posting to Guest 1 from above PostList (Baggins, Room 311) - NO

CREDIT................................................................................................................................... 27

Request ............................................................................................................................ 27

Response ......................................................................................................................... 28

Post Request Posting for Cash/Credit Card (Non-Room charge) -PostInquiry is not

required. ................................................................................................................................. 28

Request ............................................................................................................................ 28

Response ......................................................................................................................... 28

Ifcws WSDL Information 5

Preface

This document contains information on the Ifcws WSDL and its expected posting type

functionality.

Audience This document is intended for those developing custom applications that interact with

the IFC Process Command messages functionality.

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

Tenant\Organization code

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

November 2018 Initial publication

January 2020 Added GuestCheckdetail message

February 2020 Added details for specific messages – Key

Track, PM Account postings, image format

https://support.oracle.com/

http://docs.oracle.com/en/industries/hospitality/

6 Ifcws WSDL Information

1 Ifcws WSDL Information

Ifcws WSDL Use of this WebService requires an OPERA Property Interface configured that is an

XML IFC Type.

The WSDL (Web Services Description Language) used for this functionality with

OPERA Premise and displayed below can be found at

http(s)://appserver/Operajserv/Ifc8ws/Ifcws?WSDL, where appserver is the local

OPERA application server name.

IFC WSDL

<?xml version = '1.0' encoding = 'UTF-8'?>





<definitions

name="Ifcws"

targetNamespace="http://ifcws/Ifcws.wsdl"

xmlns="http://schemas.xmlsoap.org/wsdl/"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"

xmlns:tns="http://ifcws/Ifcws.wsdl"

xmlns:ns1="http://ifcws/Ifcws.xsd">

<types>

<schema

targetNamespace="http://ifcws/Ifcws.xsd"

xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"

xmlns="http://www.w3.org/2001/XMLSchema">

<complexType name="ifcws_IfcwsImpl_processCommand_Out"

jdev:packageName="ifcws"

xmlns:jdev="http://xmlns.oracle.com/jdeveloper/webservices">

<all>

<element name="outmsgOut" type="string"/>

<element name="outerrcodeOut" type="decimal"/>

<element name="outerrmsgOut" type="string"/>

</all>

</complexType>

</schema>

</types>

<message name="processCommand0Request">

<part name="inConnectStr" type="xsd:string"/>

<part name="inUser" type="xsd:string"/>

<part name="inPsw" type="xsd:string"/>

<part name="inResort" type="xsd:string"/>

<part name="inRowId" type="xsd:decimal"/>

<part name="inMsg" type="xsd:string"/>

</message>

<message name="processCommand0Response">

<part name="return" type="ns1:ifcws_IfcwsImpl_processCommand_Out"/>

</message>

<portType name="IfcwsPortType">

<operation name="processCommand">

<input name="processCommand0Request"

message="tns:processCommand0Request"/>

<output name="processCommand0Response"

message="tns:processCommand0Response"/>

</operation>

</portType>

<binding name="IfcwsBinding" type="tns:IfcwsPortType">

Ifcws WSDL Information 7

<soap:binding style="rpc"

transport="http://schemas.xmlsoap.org/soap/http"/>

<operation name="processCommand">

<soap:operation soapAction="" style="rpc"/>

<input name="processCommand0Request">

<soap:body use="encoded" namespace="Ifcws"

encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>

</input>

<output name="processCommand0Response">

<soap:body use="encoded" namespace="Ifcws"

encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>

</output>

</operation>

</binding>

<service name="Ifcws">

<port name="IfcwsPort" binding="tns:IfcwsBinding">

<soap:address location="http://johnu:8888/IFC8WS/Ifcws"/>

</port>

</service>

</definitions>

Depending on how the XML is structured, the CDATA content may be needed to

interpret the element (inMsg) as character data:

Example –

<inMsg>><![CDATA[<]]>PostInquiry xmlns="x-schema:PostInquirySchema_I"

PostInformation="test" MaximumGuestsNum="16" PaymentMethod="16"

CreditlimitOverride="" WSNum="1" PostNum="45" RequestType="15"

Date="180419" Time="110736"/<![CDATA[>]]></inMsg>

The WSDL (Web Services Description Language) used for this functionality with

OPERA Cloud, can be found on https://ServiceBus or Middleware

Layer/OPERA9OSB/schema/OperaIFCServices/IFCInternalService?wsdl

For additional security a username and password for the OPERA application can be

created by the OPERA Installation Specialist. This username and password is

provided to the vendor for populating the tags for inUser and inPsw. These are

provided to the WebService in order to validate and process the incoming requests.

This is mandatory with OPERA versions lower than 5.0.04.01. This username and

password does need to abide by PA-DSS requirements whereby the password needs

to be changed every 90 days. If it is not changed, the password will expire and

postings will be rejected. As of OPERA version 5.0.04.00E9 and higher, this is not

mandatory and inUser and inPsw can be null.

With the OPERA Cloud endpoint (…IFCInternalService) this security is mandatory

and the setup/info can be found at https://docs.oracle.com/cd/E90572_01/index.html

in the Security Information - OPERA Cloud Authentication document.

Not all attributes in the messages are available for all Partners to consume. Please

check with your Product Manager.

https://docs.oracle.com/cd/E90572_01/index.html

8 Process Command Supported Messages (inMsg)


PostInquiry Schema To query OPERA for a guest by room number, Guest name, and RoomKey Track2/Swipe.

Required for Guest Room Postings.

If a match is made, the response is a PostList message containing a list of guests that can

be posted to. If there is no match, the response is a PostAnswer.

Example

<PostInquiry xmlns="x-schema:PostInquirySchema_I" PostInformation="125"

MaximumGuestsNum="20" PaymentMethod=”401” WSNum="000000201" PostNum="24 "

RequestType="15" Date="130422" Time="094445"/>

Note: For additional sample messages, refer to XML

Message Examples. For a full list of PostRequest request

types, refer to the Request Type Table.

PostInquiry

<Schema name="PostInquirySchema_I" xmlns="urn:schemas-microsoft-

com:xml-data">

<ElementType name="PostInquiry" model="closed">

<AttributeType name="PostInformation"/>

<attribute type="PostInformation"/>

<AttributeType name="MaximumGuestsNum"/>

<attribute type="MaximumGuestsNum"/>

<AttributeType name="PaymentMethod"/>

<attribute type="PaymentMethod"/>

<AttributeType name="WSNum"/>

<attribute type="WSNum"/>

<AttributeType name="PostNum"/>

<attribute type="PostNum"/>

<AttributeType name="RequestType"/>

<attribute type="RequestType"/>

<AttributeType name="Date"/>

<attribute type="Date"/>

<AttributeType name="Time"/>

<attribute type="Time"/>

</ElementType>

</Schema>

Name Type Data Type Use Comment

PostInformation Attribute string required Information for the inquiry

(Room Number/Partial

Name/Track2).

MaximumGuestsNum Attribute number optional The maximum number of

guests returned in PostList.

PaymentMethod

Attribute string

optional The tender key used on the

vendor system.

Process Command Supported Messages (inMsg) 9

PostInquiry

WSNum Attribute string required The workstation number on

the vendor system used to

identify where request came

from.

PostNum Attribute string required The posting sequence

number.

RequestType Attribute number required Refer to the Request

Types Table, below.

Date Attribute string required The system date of the

vendor system YYMMDD

Time Attribute string required The system time of the

vendor system 24HHMISS

PostRequest Schema Posting record following the PostInquiry for Guest Room Posting. Data in the

PostRequest is based on the results in the PostList response for the PostInquiry.

PostRequest can be sent for non-room postings without a corresponding PostInquiry

(refers to Cash/Credit Card Account Postings, see example below in XML Message

Examples section).

Example

<PostRequest xmlns="x-schema:PostRequestSchema_I" RoomNum="125" GuestNum=""

GuestName="Testname" PostInformation="125" PostListItemNum="1" RequestType="4"

InvoiceNumber="" ArAcctNumber="" TotalAmount="4505" PaymentMethod="16" Covers="2"

SalesOutlet="1" ServingTime="1" CheckNum="12345678" PostNum="1234"

Subtotal1="2000" Subtotal2="500" Subtotal3="250" Subtotal4="150" Subtotal5="1000"

Subtotal6="" Subtotal7="" Subtotal8="" Subtotal9="" Subtotal10="" Subtotal11=""

Subtotal12="" Subtotal13="" Subtotal14="" Subtotal15="" Subtotal16=""

ServiceCharge1="100" ServiceCharge2="" ServiceCharge3="" ServiceCharge4=""

ServiceCharge5="" ServiceCharge6="" ServiceCharge7="" ServiceCharge8="" Tax1="120"

Tax2="385" Tax3="" Tax4="" Tax5="" Tax6="" Tax7="" Tax8="" Tax9="" Tax10=""

Tax11="" Tax12="" Tax13="" Tax14="" Tax15="" Tax16="" Tax17="" Tax18="" Tax19=""





Tax56="" Tax57="" Tax58="" Tax59="" Tax60="" Tax61="" Tax62="" Tax63=""

Discount1="" Discount2="" Discount3="" Discount4="" Discount5="" Discount6=""

Discount7="" Discount8="" Discount9="" Discount10="" Discount11="" Discount12=""

Discount13="" Discount14="" Discount15="" Discount16="" PostType="C"

UserID="Waiter_1" WSNum="000000201" Date="181120" Time="110334"/>


Message Examples. For a full list of PostRequest request



Note: InvoiceNumber should not be populated unless the

vendor supports specific functionality in OPERA to post to

an existing Invoice of a checked out reservation. The Vendor

must have knowledge of the OPERA InvoiceNumber from

another source. It is not provided in the responses found

here. PostRequest using InvoiceNumber does not require a

PostInquiry.

PostRequest

<Schema name="PostRequestSchema_I" xmlns="urn:schemas-microsoft-

com:xml-data">

<ElementType name="PostRequest" model="closed">

<AttributeType name="RoomNum"/>

<attribute type="RoomNum"/>

<AttributeType name="GuestName"/>

<attribute type="GuestName"/>

<AttributeType name="PostInformation"/>

<attribute type="PostInformation"/>

<AttributeType name="GuestNum"/>

<attribute type="GuestNum"/>

<AttributeType name="InvoiceNumber"/>

<attribute type="InvoiceNumber"/>

<AttributeType name="ArAcctNumber"/>

<attribute type="ArAcctNumber"/>

<AttributeType name="PostListItemNum"/>

<attribute type="PostListItemNum"/>



<AttributeType name="TotalAmount"/>

<attribute type="TotalAmount"/>

<AttributeType name="PaymentMethod"/>

<attribute type="PaymentMethod"/>

<AttributeType name="Covers"/>

<attribute type="Covers"/>

<AttributeType name="SalesOutlet"/>

<attribute type="SalesOutlet"/>

<AttributeType name="ServingTime"/>

<attribute type="ServingTime"/>

<AttributeType name="CheckNum"/>

<attribute type="CheckNum"/>



<AttributeType name="Subtotal1"/>

<attribute type="Subtotal1"/>















PostRequest


















<AttributeType name="ServiceCharge1"/>

<attribute type="ServiceCharge1"/>















<AttributeType name="Tax1"/>

<attribute type="Tax1"/>



























PostRequest






























































PostRequest








































<AttributeType name="Discount1"/>

<attribute type="Discount1"/>





















PostRequest












<AttributeType name="PostType"/>

<attribute type="PostType"/>

<AttributeType name="UserID"/>

<attribute type="UserID"/>







</ElementType>

</Schema>


RoomNum Attribute string Required for

Room Posting

The room number of

the guest.

GuestName Attribute string optional The name of the guest.

PostInformation Attribute string Required for

Room Posting

Same as PostInquiry.

GuestNum Attribute Number optional Resv_name_id in

OPERA

InvoiceNumber Attribute Number optional *DNU unless

supporting specific

functionality

ArAcctNumber Attribute string optional *used with

InvoiceNumber.

Account Receivable

number in OPERA

PostListItemNum Attribute Number Required for

Room Posting

The number assigned

to the guest in the

PostList used.

RequestType Attribute number required Refer to the Request

Types Table, below.

TotalAmount Attribute Number required The total amount of the

check, including tax

and gratuity.


PostRequest

PaymentMethod Attribute string Optional for

Room Posting.

Required for

Account Posting.

The tender key that

was used on the POS.

Covers Attribute string optional The number of covers

on this check.

SalesOutlet Attribute string optional The sales outlet or

revenue center that

generated this charge.

ServingTime Attribute string optional The serving period that

the check was opened

under.

CheckNum Attribute string optional The check number.

PostNum Attribute string required The posting sequence

number.

Subtotal 1 - 16 Attribute number optional Individual subtotals for

sales items.

Tax 1 - 63 Attribute number optional Individual tax items for

different taxes.

ServiceCharge 1 - 8 Attribute number optional Used to hold

additional gratuity.

Discount 1 - 16 Attribute number optional Individual discount

totals for different

discounts.

PostType Attribute string required Should be sent as "C"

for charge.

UserID Attribute string optional The user ID from the

vendor system.

WSNum Attribute string required The workstation

number of the vendor

system.

Date Attribute string required The system date from

the vendor system

YYMMDD

Time Attribute string required The system time from

the vendor system

24HHMISS


GuestCheckdetail Schema GuestCheckdetailSchema_I message is used following a successful PostRequest to insert

the Check Detail associated to the posting for display in OPERA. The GuestCheckdetail

will need to have the same CheckNum, Date and Time of the corresponding PostRequest.

The ClearText can be populated with the text and formatting of the check to be saved as

is, OR the CheckImage can have the Base64 string of the png/jpeg image (2MB max limit

for the complete message). There is no response message from OPERA for a

GuestCheckdetail.

Example with CheckImage populated

<GuestCheckdetail xmlns="x-schema:GuestCheckdetailSchema_I"

CheckNum="12345678" ClearText="" Date="181120" Time="110334" WSNum="1"

PathId="1"

CheckImage="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAdoAAAJGCAYAAAD

8qEQKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gA

AEP0SURBVHhe7b3/7zzHfd/3/icK/5QAbeDWEOx8Yc0YvaaxFSNIBASIoQiJP67CsHZ0rpsop

hUEzg+mFYB0WLt1cIJjM0FLhyiaiqZNq5ats2QpH0aWLJESJZOS5ch5k/rC6Asl27ERCGmc0J

nua3Zn9zWzM3N7ezt3u7ePB/Akb3dnZ2b3dudxs+/35303249+1RBCCCFLzxs332I+8F3fcdF

IH8J+IVpCCCFXEURLCCGEFAyiJYQQQgoG0RJCCCEFg2gJIYSQgrk60b7po6+Y73r6Xeb73vs2

83fe+bPm/Z96wfyVn3i/+etPfMR89/s/F92HEEIIKZUxor25uWkzZP2hTCbav/mhL5rX/tJbz

Pd8+PvMk7fPmEc+8nFz592fNHfe+Wnz+h+9a97wf/y4uf/pu9F9CSGEkBIZO6MNpRouH5PJRP

vtv/yI+bMf+WPmX37158zX/vBL5n2vvGL+3pe+Zt70L79k3vgTHzNv+JF/Yr7tf/7H5r73MrM

lhBBynowVrUTLdaxkJZOI9v67nzN/9B1/xLzm6f/S/KPf/Wnz2B8a8/Qf/mfzd3/nP5o3Pv0F

88afesFs/vrPmAff8/3mDW9/KFoHIaXynW/55uBmuc+8LlJurnnd68v1ua7bzze8LV6WkCXmF

NFK9L0R2z4kk4j2dY++x/xXP/g3zJ/80X9m/tyv3Jof+N0/MH/7K//BvOET/9b85adeMm/4sY

+ZP/1XnzJv/bXXmdc9+WfMmz7y5Wg9hEybZ83mm+QGCST1tvtOl0lVx803PWS+M7ZtQRHRft1

bno1um1Wu5HyT8+dqRPvn/sEvmT/1PX/LfMubf9r89//kA+bP/tJnzbe/5wvmtT/zkvkLu0+Y

v/iWD5lv/PNvN2/51dea//pH/gvzN5/5YrQeQqaMncmWGpwR7XmDaMnInCJaLdlTZHuSaL+3y

kMf+E3zxHs/bN7/3CfNr3zwY+Z9z3zcvPX/umu+7R8+a177Dz5mvv37f818y3e8z3z9N7/dfP

0Pv9b80Tt/1bzpmS9F6yNkurzdfEN1U+RnrlLmm83mHWrdOx4yX6dnwDLAtzdZXbb3uPX1b2/

37z2mVtsktdje3sy069g+2nbdOn8G7snQ649Ksg/B8QU5JNr88dRPDL7hbfW5dv0ec4z+tipK

qrnzTcihjBWtvuZiy8fkJNH+1HMvmmc+9Rnz3KdfNF/+nd8zP/HPnzLP/+tb8/6PP2+efNcHz

H/3+neYP/Xnf8V84//wLvNN3/ZO85pvfbv5tr/z3mhdhEwaK6RgMO/lgGjta7X9bQ+p1/0ZVi

0l3Wbz6FqJoZZGV2crsrau+D4pGdr9VT/C5UPn4WDd2eOpl7/um+7zzuGYY/zOt+g6+ttj55u

QIRkj2pRUU+sPZbRo3/LBl8wvf+Cj5jNf+or5/CtfMS9/+avmH//fT5nbl/+N+cTtS+bp5z5u

/v6PPm7+m7/84+aPv+7nzJ9+/d586994t/kfn3oxWh8hk2Yy0Sbq6A38kbokQR1WQlogsZl3U

HdShuEHgWgfammlZva1FHVcX4ccTyPaoG9jjrGXcPuh8oQkMnZGO2VGi/bH3/sR8+mXv2x+/b

deMp//8lfMl776O+bHHnu7+Vef/Zx54fZF86FP/qZ53zMfNH/iH73BvPbN7zavf/g5c+f//I1

oXYRMHhmYU5JsE5FJRCQioJ6oYiKItue30ZdmpA9B3XHRRiRn+6Cl2SUn2qjEBx1PXOJjjlHS

znxdEC2ZIIsW7U/84l3zTCXTz37pFfPpz75sfuVDHzFv+uEfMz/5xP9rfupnfsHc/eivm+f/9

Yvmr/3Ik+a7/5/PmL/yU//CfMdP/7J54/4TZvuRr0TrJGSy9GZ7sRwSrV4ng79aHw78g8Q0nW

h7j4glyT6kMw/RyvYDYg2XCRmYRYv2J9/9q+a3Xv6C+eTtZ8yHPvEp88Hnf8M89vP7at0XzW2

VV37398xLn/u8+fY3/6/mW3/obeYvPfrz5q899WHz3b/KH6wg50gzG/UeYYZJCCAqmGAGGQ78

KbEH4p5EtLaPqbYi6zNJinbQ8Uwk2uAcSaI/a0a0ZEQWLdofeu/HrGA/8OsvVP//TfPJz3zef

O6rv2t+79//gflP/9mYFyvZ/uKHPmr+p6dfNN/za18wb3r2lWg9hJRLZKYkqQbtWg6hjJvybt

Bvy3Vl22UrO18OIhh/XSDnpsxpoq37GJVjlWgfXp8WVL8//rb88QTnpMnRxxhK3S5XbYeiDc4

3IUOyaNF+74e/aN7xa8+ZZ37j0+bDn/yUefGLr1jJ/sF/etX8+//wB+b3/t2/Mz/wCx+M7kvI

+VLLIPmzv1aukmog17MrN+A38eWh6lWz5vDnjKHEjpZQFb1PLb9IVB/CMmEfdPr98ZM/nolEW

8VrR9YH21Pnm5BDWbRoJf/Lr75kfu6DHzHPffrW/M7X/j/z/G+9ZP7jq6+aF24/Y374lz5o/5

1tbD9CCCHkHBHJzSFhvwaLVvK9H/6C+cF3P2f+6d1nzD97+sNmd/ej5vve96loWUIIIYQcKVp

CCCGEHBdESwghhBQMoiWEEEIKBtESQgghBYNoCSGEkIJBtIQQQkjBIFpCCCGkYJKi/YH3/Zb5

oZ9/hhBCCCEDIt6M+TQ7o/393/99QgghhAxIzKMSREsIIYRMkJhHJYiWEEIImSAxj0oQLSGEE

DJBYh6VIFpCCCFkgsQ8KkG0hBBCyASJeVSCaAkhhJAJEvOoBNGS2eVH//efXGRix0IIWU9iHp

UgWjK7iLSWBqIlhMQ8KjlJtPrTPCFTZmlIn2P3CCFkPYl5VHKyaH/7t3/7quIG+ti2a8gSjk/

6tzSkz7F7hBCynsQ8KkG0QZYgolOyhOOT/i0N6XPsHiGErCcxj0oQbZAliOiULOH4pH9LQ/oc

u0cIIetJzKMSRBtkCSI6JUs4Pulfjs3NjblR2e6bDTlud2az2ZnbZnFqpM+xe4QQsp7EPCpZh

miffdjce+/D5tnYtomzBBGdkiUcn/QvhydMEegQ2SJaQkjhxDwqKSLae6uB796Hn+3WnSrKOY


n2ifu82dTNfU/Ey800uePzjqvJvffdd7Zz7yL9y9ETppLo7W6j+r8xO1vw1uw23TFtZGUjaL/

ceKTPsXuEELKexDwqKSPae+8z9917r3n42WbdlYj22YfvrQbl+"/>

GuestCheckdetail

<Schema name="GuestCheckdetailSchema_I" xmlns="urn:schemas-microsoft-

com:xml-data">

<ElementType name="GuestCheckdetail" model="closed">

<AttributeType name="CheckNum"/>

<attribute type="CheckNum"/>

<AttributeType name="ClearText"/>

<attribute type="ClearText"/>







<AttributeType name="CheckImage"/>

<attribute type="CheckImage"/>

</ElementType>

</Schema>


CheckNum Attribute string required The check number matching the

PostRequest check number.

ClearText Attribute string optional The guest check details in text and

formatting. Only use this or use

CheckImage, depending on what is

wanted.

WSNum Attribute string required The workstation number of the

vendor system.

Date Attribute string required The date from the PostRequest

YYMMDD

Time Attribute string required The time from the PostRequest

24HHMISS

CheckImage Attribute Base64 string optional The guest check details image.

JPEG/PNG currently supported.

Only use this or use ClearText,

depending on what is wanted.


GuestMessage Schema GuestMessSchema_I messages can be used for two reasons. If the RequestType and

CrossReferencexx elements are used, the message may be used in conjuction with TrackIt

(in OPERA) to track packages using the PacTrac interface. If the RequestType and

CrossReferencexx elements are not used, GuestMessSchema_I messages may be used as

simple text messages to the guest. There is no response message from OPERA for a

GuestMessage.

Note: There may be numerous CrossReferencexx elements

used within the same message. CrossReferencexx elements

may be used for a multitude of purposes and may vary from

message to message. For a full list of Guest message request


Example

<GuestMess xmlns="x-schema:GuestMessSchema_I" TransNum="888777" RequestType="1"

EquipmentStatus="OPEN" GuestNum="1327897" MessageText="Musical Equipment"

CrossReference0="ODH" CrossReference1="BS" CrossReference2="TODO"

CrossReference3="Y" CrossReference4="FEDEX" Date="070611" Time="134411"/>

GuestMess

<Schema name="GuestMessSchema_I" xmlns="urn:schemas-microsoft-com:xml-

data">

<ElementType name="GuestMess" model="closed">

<AttributeType name="TransNum"/>

<attribute type="TransNum"/>



<AttributeType name="EquipmentStatus"/>

<attribute type="EquipmentStatus"/>

<AttributeType name="GuestNum"/>


<AttributeType name="MessageText"/>

<attribute type="MessageText"/>

<AttributeType name="CrossReference0"/>

<attribute type="CrossReference0"/>













</ElementType>

</Schema>


TransNum Attribute string optional The transaction number.


RequestType Attribute string optional The request type.

EquipmentStatus Attribute string optional The status of the message.

OPEN or CLOSED

GuestNum Attribute string required The guest number in OPERA.

MessageText Attribute string required The simple text message.

CrossReference0 Attribute string optional The resort code.

CrossReference1 Attribute string optional The location of package.

CrossReference2 Attribute string optional The type of action that should

be taken.

CrossReference3 Attribute string optional Message creation indicator

(Y/N). “Y” indicates that the

message should be created.

CrossReference4 Attribute string optional The type of package.

Date Attribute string required The date stamp YYMMDD

Time Attribute string required The time stamp 24HHMISS

OPERA Responses to PostInquiry

PostList Response

Outgoing message that holds an array of PostListItems containing guest/room data as a

response to the PostInquiry for a Room Posting. It is expected to be a single PostListItem

when the PostInquiry was initiated with RoomKey Track2/Swipe. PostInquiry with

Room Number and Guest Name may produce a PostList with multiple PostListItem.

Example

<PostList xmlns="x-schema:PostListSchema_O" WSNum="000000201"

PostNum="24"><PostListItem RoomNum="125" GuestNum="5651457" GuestName="Busey"

GuestFormattedname="(EN) Mr Busey" DefRef2="" DefRef3="" DefRef4="" DefRef5=""

DefRef6="" DefRef7="" DefRef8="" DefRef9="" DefRef10=""/></PostList>


Message Examples.


PostList

<Schema name="PostListSchema_O" xmlns="urn:schemas-microsoft-com:xml-

data">

<ElementType name="PostListItem" model="closed">

<AttributeType name="RoomNum" required="yes"/>


<AttributeType name="GuestNum" required="yes"/>




<AttributeType name="GuestFormattedname"/>

<attribute type="GuestFormattedname"/>

<AttributeType name="DefRef2"/>

<attribute type="DefRef2"/>
















</ElementType>

<ElementType name="PostList" model="closed">





<element type="PostListItem" maxOccurs="*"/>

</ElementType>

</Schema>


WSNum Attribute string required The workstation number from

the PostInquiry.

PostNum Attribute string required The PostNum from the

PostInquiry.

PostListItem Element string required Guest/Room information for

the inquiry.

RoomNum Attribute string required The room number of the guest.


PostList

GuestNum Attribute string required Resv_name_id in OPERA.

GuestName Attribute string required The guest’s name.

GuestFormattedName Attribute string required The user defined name format.

This should be used for

display to the POS user.

DefRef 2 Attribute string optional Additional user defined fields

to be displayed to the user.

















PostAnswer Response

The response message to a PostInquiry when no data is found in PMS.

Example

<PostAnswer xmlns="x-schema:PostAnswerSchema_O" RoomNum=”” GuestName=“” UserID=””

WSNum="000000201" PostNum="24" AnswerStat="NG" BusinessDate=”130422”

ClearText="Guest not found."/>


Message Examples.


PostAnswer

<Schema name="PostAnswerSchema_O" xmlns="urn:schemas-microsoft-com:xml-

data">

<ElementType name="PostAnswer" model="closed">





<AttributeType name="AnswerStat" required="yes"/>

<attribute type="AnswerStat"/>

<AttributeType name="BusinessDate"/>

<attribute type="BusinessDate"/>









</ElementType>

</Schema>


RoomNum Attribute string N/A The room number of guest.

GuestName Attribute string N/A The guest’s last name.

AnswerStat Attribute string required Refer to the Answer Status

Table, below.

BusinessDate Attribute string optional PMS business date YYMMDD

ClearText Attribute string required Additional text information

(should be displayed to a user

upon failure).

PostNum Attribute string required The posting number from the

PostInquiry.

UserID Attribute string N/A The user ID from the

PostRequest.


the PostInquiry.

OPERA Response to PostRequest

PostAnswer Response

The response message to a PostRequest (Accepted or Failed).

Example

<PostAnswer xmlns="x-schema:PostAnswerSchema_O" UserID="901" GuestName=”Smith”

WSNum="000000201" PostNum="25" RoomNum="125" BusinessDate=”130422” AnswerStat="OK"

ClearText="Posting successful. Interface transaction number/s - 1925491"/>



Message Examples. For a full list of answer statuses, refer to

the Answer Status Table.

PostAnswer

<Schema name="PostAnswerSchema_O" xmlns="urn:schemas-microsoft-com:xml-

data">

<ElementType name="PostAnswer" model="closed">





<AttributeType name="AnswerStat" required="yes"/>

<attribute type="AnswerStat"/>



<AttributeType name="BusinessDate"/>

<attribute type="BusinessDate"/>







</ElementType>

</Schema>


RoomNum Attribute string optional The room number of the

guest.

GuestName Attribute string optional The guest’s last name.

AnswerStat Attribute string required Refer to the Answer Status

Table, below.

ClearText Attribute string optional Additional text information

(should be displayed to a user

upon failure).

BusinessDate Attribute string optional PMS business date YYMMDD

PostNum Attribute string required The posting number from the

PostRequest.

UserID Attribute string optional The user ID from the

PostRequest.


the PostRequest.

24 Answer Status Table

3 Answer Status Table

The table below lists all of the valid Answer Status’s that will be returned in the

AnswerStat attribute.

Code Interface Type Using This Code Meaning

CO All PostingRequest Systems Posting denied because overwrite

of CreditLimit is not allowed

DM All PostingRequest Systems Difference mismatch. TotalAmount

doesn’t equal total of all subtotals

in the message.

FX All systems using Guest related

requests

Guest is not allowed to use this

feature.

IA All systems using Guest related

requests

Invalid Account (Room)

NA All systems Night Audit running

NG All info requests Guest/Room not found

NP All PostingRequest Systems Posting denied because NoPost is

set

OK All systems Command or request successful

RY All systems Retry (-ing)

UR All requests Unprocessable request, this request

cannot be carried out, no retry

Request Type Table 25

4 Request Type Table

The table below lists request types that are used in PostInquiry and PostRequest

messages to determine how we are finding the particular guest. In addition, the table

displays request types that are used in Guest messages.

A number or an additive number of multiple codes below can be used. For example, to

perform a query based on a guest name, you would fill the RequestType attribute with

‘8’. To perform a query where you are not sure if you are looking for the guest by room

number or name you would fill the RequestType attribute with ‘12’, because 8 (guest

name) + 4 (room number) = 12

RequestType Action Name Type / Meaning

1 PostInquiry &

PostRequest

Search/Post by PaymentMethod

2 PostInquiry &

PostRequest

Search/Post by Track2

4 PostInquiry &

PostRequest

Search/Post by RoomNum

8 PostInquiry &

PostRequest

Search/Post by GuestName

16 PostInquiry &

PostRequest

Search/Post by ExtensionNum

32 PostInquiry &

PostRequest

Search/Post by GuestNum

1 GuestMess_I Parcel/Baggage item

2 GuestMess_I Car/Valet Item

26 XML Message Examples


Post Inquiry with No Guests/Room found

(RequestType indicates the PostInformation will be searched on in PMS by Room Number, Guest Name, and Key Track2 and respond with all found matches)

Request <PostInquiry xmlns="x-schema:PostInquirySchema_I" PostInformation="zzz"

MaximumGuestsNum="20" WSNum="000000201" PostNum="26 " RequestType="14"

Date="130422" Time="094445"/>

Response

<PostAnswer xmlns="x-schema:PostAnswerSchema_O" UserID="" WSNum="000000201"

PostNum="26 " BusinessDate=”130422” AnswerStat="NG" ClearText="Guest not found."/>

Post Inquiry Returning One Guest

(RequestType indicates the PostInformation will be searched on in PMS by Room Number and Guest Name and respond with all found matches)

Request

<PostInquiry xmlns="x-schema:PostInquirySchema_I" PostInformation="VO"


Date="130422" Time="094845"/>

Response

<PostList xmlns="x-schema:PostListSchema_O" WSNum="000000201" PostNum="27

"><PostListItem RoomNum="1004" GuestNum="1550639" GuestName="Vorwerk"

GuestFormattedname="(EN) MR Vorwerk" DefRef2="" DefRef3="" DefRef4="" DefRef5=""

DefRef6="" DefRef7="" DefRef8="" DefRef9="" DefRef10=””/></PostList>

Post Inquiry with RoomKey Track2/Swipe

(RequestType indicates the PostInformation will be searched on in PMS by Key Track2 and respond with the specific match)

Request

<PostInquiry xmlns="x-schema:PostInquirySchema_I"

PostInformation="19100165286579018899" MaximumGuestsNum="16" PaymentMethod="21"

WSNum="98761" PostNum="2" RequestType="2" Date="181107" Time="150736"/>

Response

<PostList xmlns="x-schema:PostListSchema_O" WSNum="98761"

PostNum="2"><PostListItem RoomNum="301" GuestNum="2147961543" GuestName="Kumar"

GuestFormattedname="(EN) Ram Kumar" DefRef2="" DefRef3="" DefRef4="" DefRef5=""


XML Message Examples 27

Post Inquiry Returning Multiple Guests

(RequestType indicates the PostInformation will be searched on in PMS by Room Number, Guest Name, and Key Track2 and respond with all found matches)

Request

<PostInquiry xmlns="x-schema:PostInquirySchema_I" PostInformation="ba"


Date="130422" Time="094945"/>

Response

<PostList xmlns="x-schema:PostListSchema_O" WSNum="000000201" PostNum="28

"><PostListItem RoomNum="311" GuestNum="3506698" GuestName="Baggins"

GuestFormattedname="(EN) Bilbo Baggins" DefRef2="" DefRef3="" DefRef4=""

DefRef5="" DefRef6="" DefRef7="" DefRef8="" DefRef9="" DefRef10=""/><PostListItem

RoomNum="115" GuestNum="5684458" GuestName="batur" GuestFormattedname="(EN) Mr

batur" DefRef2="" DefRef3="" DefRef4="" DefRef5="" DefRef6="" DefRef7=""

DefRef8="" DefRef9="" DefRef10=""/><PostListItem RoomNum="210" GuestNum="900140"

GuestName="Ball" GuestFormattedname="(EN) Ms Lucille Ball" DefRef2="" DefRef3=""

DefRef4="" DefRef5="" DefRef6="" DefRef7="" DefRef8="" DefRef9=""

DefRef10=""/><PostListItem RoomNum="217" GuestNum="5386707" GuestName="BATUR"

GuestFormattedname="(EN) Mr BATUR" DefRef2="" DefRef3="" DefRef4="" DefRef5=""


Post Request Posting to Guest 3 from above PostList (Ms Lucille Ball, Room 210)

Request

<PostRequest xmlns="x-schema:PostRequestSchema_I" RoomNum="210" GuestName="Ball"

PostInformation="ba" PostListItemNum="3" RequestType="14" TotalAmount="1757"

PaymentMethod="401" Covers="2" SalesOutlet="1" ServingTime="2" CheckNum="834"

PostNum="29 " Subtotal1="925" Subtotal2="250" Subtotal3="0" Subtotal4="0"

ServiceCharge1="500" ServiceCharge2="0" Tax1="82" Tax2="0" Discount1="0"

Discount2="0" Discount3="0" Discount4="0" PostType="C" UserID="901"

WSNum="000000201" Date="130422" Time="095040"/>

Response

<PostAnswer xmlns="x-schema:PostAnswerSchema_O" UserID="901" WSNum="000000201"

PostNum="29" RoomNum="210" GuestName=”Ball” BusinessDate=”130422” AnswerStat="OK"


Post Request Posting to Guest 1 from above PostList (Baggins, Room 311) - NO CREDIT

Request

<PostRequest xmlns="x-schema:PostRequestSchema_I" RoomNum="311"

GuestName="Baggins" PostInformation="ba" PostListItemNum="1" RequestType="14"

TotalAmount="1757" PaymentMethod="401" Covers="2" SalesOutlet="1" ServingTime="2"

CheckNum="834" PostNum="29 " Subtotal1="925" Subtotal2="250" Subtotal3="0"

Subtotal4="0" ServiceCharge1="500" ServiceCharge2="0" Tax1="82" Tax2="0"

Discount1="0" Discount2="0" Discount3="0" Discount4="0" PostType="C" UserID="901"

WSNum="000000201" Date="130422" Time="095040"/>


Response


PostNum="29" RoomNum="311" GuestName=”Baggins” BusinessDate=”130422”

AnswerStat="NP" ClearText="No Credit."/>

Post Request Posting for Cash/Credit Card (Non-Room charge) -PostInquiry is not required.

For this PostRequest functionality a PaymentMethod is required and needs to be

configured in the PMS IFC Configuration for a Posting Account.

RequestType in the PostRequest is required and needs to contain an additive of 1 for

posting by this PaymentMethod.

No RoomNum, GuestName, PostInformation, and PostListItemNum is needed for this

type of posting.

Request

<PostRequest xmlns="x-schema:PostRequestSchema_I" RequestType="1"

TotalAmount="12007" PaymentMethod="22" Covers="2" SalesOutlet="1" ServingTime="2"

CheckNum="837" PostNum="45" Subtotal1="11500" Subtotal2="400" Subtotal3="0"

Subtotal4="0" ServiceCharge1="100" ServiceCharge2="0" Tax1="07" Tax2="0"

Discount1="0" PostType="C" UserID="901" WSNum="000000201" Date="130422"

Time="132140"/>

Response


GuestName="F&B Amex Account" RoomNum="9004" BusinessDate=”130422” AnswerStat="OK"


opera property management - oracle help center xml... · if this software or related documentation...

Documents