Oracle Hospitality OPERA Exchange Interface Profile Lookup Vendor Specification. May 2018

Transcription

1 Oracle Hospitality OPERA Exchange Interface Profile Lookup Vendor Specification May 2018

2 Copyright 2004, 2018, 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. 2

3 Contents Preface... 4 Audience... 4 Customer Support... 4 Documentation Assumptions Validations Profile Lookup Lifecycle HTTP Communication... 8 Lookup Request... 8 Profile Request XML Schemas... 9 Lookup Request... 9 Lookup Response Profile Request Profile Response HTTP Call Samples Profile Lookup Request and Response HTTP POST Data (Request for matching profiles) HTTP POST Response (List of matching profiles returned synchronously by external system) Profile Request HTTP GET Response (Unique matching profile returned synchronously by external system) Profile Anonymization Schema Changes XDR: profile.fidelio.5.0.xml: XSD Sample Message

4 Preface Profile lookup may be used to retrieve profile information from remote systems. At a minimum, profile lookup should provide the following functionality: Search for profiles matching the criteria provided by the user. It should accept wildcards as part of the matching criteria. Retrieve complete information of a profile when requested by specifying the unique identifier of the profile. Audience This document explains the functionality currently offered by OPERA XChange Interface for doing profile lookup in external systems from OPERA. It is intended for third party vendor developers who might be implementing the functionality to interface with OPERA XChange Interface. Knowledge of HTTP protocol and server side implementation is a prerequisite to accomplish this task. Customer Support Documentation To contact Oracle Customer Support, access My Oracle Support at the following URL: 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 Oracle Hospitality product documentation is available on the Oracle Help Center at 4

5 1 Assumptions This document describes the intended functionality of profile lookup in OXI flavored interfaces. Details explained in this document may change as needed or required. 5

6 2 Validations OXI does not validate the lookup criteria receive from OPERA. For details on any validations performed by OPERA, please refer to OPERA s documentation. External systems may get a wild card profile lookup request. Neither OPERA nor OXI mandates any particular wild card conventions. A commonly used wild card is * for one or more characters. 6

7 3 Profile Lookup Lifecycle OPERA user initiates profile lookup Listening OXI Processor receives the lookup request, builds a profile lookup request XML and sends to the external system as HTTP POST operation. External system retrieves lookup criteria from the input stream, builds a profile lookup response XML from the list of profiles matching the criteria and sends in the HTTP response stream. OXI processor parses the response and sends the profiles to OPERA. OPERA displays the profiles to the user. User selects a profile. OPERA initiates a profile request for the profile selected by the user. Listening OXI processor receives the profile request and sends to the external system as HTTP GET operation. Using OXI's generic match/ merge process, OXI processor builds the profile in OPERA and sends the id of the resultant profile to OPERA. External system retrieves the profile request from the URL parameters, builds a complete profile XML from the matching profile and sends in the HTTP response stream. OPERA displays the profile edit screen with the profile created/ merged by OXI

8 4 HTTP Communication Lookup Request URL HTTP Operation Parameters Content-Type Data Stream Response Stream Profile Request URL HTTP Operation Content-Type Data Stream Response Stream : : POST : none : text/xml : plquery XML message : plresult XML message : propertyname=externalresort&transactionid=transactionid&action=g ETC RS&profileId=ExtSysUniqueProfileID : GET : text/xml : None : profile XML message URL Parameters Seq Parameter Name Type Description 1 propertyname string Property code recognized by the external system. External resort configured in OXI s interface setup. 2 transactionid int Id to uniquely identify this request. 3 action string Always GETCRS. 4 profile_id int Unique profile Id recognized by the external system. This will be the value sent by the external system in ProfileSet\nameId element of plresult message. 8

9 5 XML Schemas Lookup Request XML Schema : plquery XML Schema version : 1.1 Query <xs:complextype name="query"> <xs:sequence> <xs:element name="propertyname" type="xs:string"/> <xs:element name="formatname" type="xs:string" minoccurs="0"/> <xs:element name="transactionid" type="xs:string"/> <xs:element name="setsize" type="xs:int" minoccurs="0"/> <xs:element name="transactiontype" type="xs:string" minoccurs="0"/> <xs:element name="firstname" type="xs:string" minoccurs="0"/> <xs:element name="lastname" type="xs:string" minoccurs="0"/> <xs:element name="city" type="xs:string" minoccurs="0"/> <xs:element name="state" type="xs:string" minoccurs="0"/> <xs:element name="zip" type="xs:string" minoccurs="0"/> <xs:element name="country" type="xs:string" minoccurs="0"/> <xs:element name="membernumber" type="xs:string" minoccurs="0"/> <xs:element name="creditcard" type="xs:string" minoccurs="0"/> </xs:sequence> <xs:attribute name="profiletype" type="xs:string" use="required"/> </xs:complextype> Name Type Data Type Use Comment profiletype attribute string required Type of the profile. Valid values are GUEST, CORPORATE, TRAVEL, GROUP and WHOLESALER. OXI uses profile type conversion. propertyname element string required Property code recognized by the external system. External resort configured in OXI s interface setup. formatname element string optional Not used. transactionid element string required Unique id associated with the lookup request. Generated by OPERA while initiating the lookup. XML Schemas 9

10 setsize element int optional Maximum number of matching profiles to return in the response. External system should use this as a hint to limit the number of matching profiles. transactiontype element string optional Not used. firstname element string optional First name of the profile. OPERA mandates this field. lastname element string optional Last name of the profile. OPERA mandates this field. city element string optional City of the profile. state element string optional State of the profile. zip element string optional Zip code of the profile. country element string optional Country of the profile. membernumber element string optional Membership number. creditcard element string optional Not used. Lookup Response XML Schema : plresult XML Schema version : 1.0 LookupResult <xs:complextype name="lookupresult"> <xs:sequence> <xs:element name="transactionid" type="xs:string"/> <xs:element name="profilesets" type="profilesets" minoccurs="0"/> <xs:element name="errormsg" type="xs:string" minoccurs="0"/> </xs:sequence> </xs:complextype> Name Type Data Type Use Comment transactionid element string required transactionid sent in lookup request. ProfileSets element ProfileSets optional List of matching profiles. errormsg element string optional Details of error, if any. 10

11 ProfileSets <xs:complextype name="profilesets"> <xs:sequence> <xs:element name="profileset" type="profileset" minoccurs="0" maxoccurs="unbounded"/> </xs:sequence> </xs:complextype> Name Type Data Type Use Comment ProfileSet element ProfileSet optional Details of matching profile. ProfileSet <xs:complextype name="profileset"> <xs:sequence> <xs:element name="resortnameid" type="xs:string" minoccurs="0"/> <xs:element name="nameid" type="xs:int" minoccurs="0"/> <xs:element name="membernumber" type="xs:string" minoccurs="0"/> <xs:element name="lastname" type="xs:string" minoccurs="0"/> <xs:element name="firstname" type="xs:string" minoccurs="0"/> <xs:element name="address" type="xs:string" minoccurs="0"/> <xs:element name="address2" type="xs:string" minoccurs="0"/> <xs:element name="city" type="xs:string" minoccurs="0"/> <xs:element name="state" type="xs:string" minoccurs="0"/> <xs:element name="zip" type="xs:string" minoccurs="0"/> <xs:element name="country" type="xs:string" minoccurs="0"/> <xs:element name="profiletype" type="xs:string" minoccurs="0"/> <xs:element name="udf" type="xs:string" minoccurs="0"/> </xs:sequence> </xs:complextype> Name Type Data Type Use Comment resortnameid element string optional Unique id of the profile in OPERA, if available. nameid element int optional Unique id of the profile in external system. This value is mandatory as it is the key used while requesting for full profile when user selects a profile from the returned list of profiles. membernumber element string optional Membership number. OPERA displays this. lastname element string optional Last name. OPERA displays this. firstname element string optional First name. OPERA displays this. XML Schemas 11

12 address element string optional Address line 1. OPERA displays this. address2 element string optional Address line 2. OPERA displays this. city element string optional City. OPERA displays this. state element string optional State. OPERA displays this. zip element string optional Postal code. OPERA displays this. country element string optional Country. OPERA displays this. profiletype element string optional Profile type. Udf element string optional Not used. Profile Request XML Schema Notes Profile Response XML Schema XML Schema version XML Tables : Not applicable : No XML schema is used to request a particular profile. Profile s unique identifier is passed in the request itself. : profile : 1.2 or 2.0 as configured in OXI : Please refer to OXI profile download specifications. 12

13 Profile Lookup Request and Response HTTP Action : POST Sample URL : /servlets/orslookup URL Parameters : None Request & Response content type : text/xml Request & Response character encoding : UTF8 6 HTTP Call Samples HTTP POST Data (Request for matching profiles) <?xml version="1.0"?> <?Label SLBK PLQUERY 5018 SUCCESS?> <Query xmlns="plquery.fidelio.1.1" profiletype=""> <propertyname>slbk</propertyname> <transactionid>1111</transactionid> <setsize>50</setsize> <firstname>jane</firstname> <lastname>smith</lastname> <city> Anytown</city> <state>fl</state> <zip>99999</zip> <country>us</country> </Query> HTTP POST Response (List of matching profiles returned synchronously by external system) <?xml version="1.0"?> <LookupResult xmlns="plresult.fidelio.1.0"> <transactionid>5018</transactionid> <ProfileSets> <ProfileSet> <resortnameid>29542</resortnameid> <nameid>10759</nameid> <membernumber>97105</membernumber> <lastname>smith</lastname> <firstname>jane</firstname> <address> 1111 Street</address> <city>anytown</city> <state>fl</state> <zip>99999</zip> <country>us</country> </ProfileSet> <ProfileSet> HTTP Call Samples 13

14 <resortnameid>29542</resortnameid> <nameid>10759</nameid> <membernumber>97105</membernumber> <lastname>john</lastname> <firstname>smith</firstname> <address> 1111 Street</address> <address2>2222 Street</address2> <city>anytown</city> <state>fl</state> <zip> 99999</zip> <country>us</country> </ProfileSet> <ProfileSet> <resortnameid>29542</resortnameid> <nameid>10759</nameid> <membernumber>97105</membernumber> <lastname>smith</lastname> <firstname>jane</firstname> <address>1111 Street</address> <city>anytown</city> <zip>99999</zip> <country>us</country> </ProfileSet> <ProfileSet> <nameid>10766</nameid> <lastname>smith</lastname> <firstname>jane</firstname> <address>2222 Street</address> <city>anytown</city> <state>fl</state> <zip>9999</zip> <country>us</country> </ProfileSet> </ProfileSets> </LookupResult> Profile Request HTTP Action : GET Sample URL : /servlets/orslookup URL Parameters : propertyname=slbk&transactionid=10766&action=getcrs&profileid=10766 Response content type : text/xml Response character encoding : UTF8 HTTP GET Response (Unique matching profile returned synchronously by external system) <?xml version = '1.0'?> <?Label SLBK PROFILE 108 SUCCESS?> <Profile profiletype="guest" gender="f" xmlns="profile.fidelio.1.2"> <profileid>10766</profileid> 14

15 <creatorcode>oxi-v6</creatorcode> <createddate> t13:57:03.000</createddate> <lastupdatercode>soriam</lastupdatercode> <lastupdated> t16:36:14.000</lastupdated> <genericname>john</genericname> <IndividualName> <nameprefix>mrs</nameprefix> <namefirst>jane</namefirst> <namesur>smith</namesur> </IndividualName> <primarylanguageid>e</primarylanguageid> <Documents> <Document> <name>jane</name> <docnumber>a </docnumber> <nationality>us</nationality> <documentcode>passport</documentcode> </Document> </Documents> <PostalAddresses> <PostalAddress addresstype="home"> <address1>1111 Street</address1> <city>anytown</city> <statecode>fl</statecode> <postalcode>99999</postalcode> <countrycode>us</countrycode> <mfprimaryyn>y</mfprimaryyn> </PostalAddress> </PostalAddresses> <PhoneNumbers> <PhoneNumber phonenumbertype="home"> <phonenumber>+1(999) </phonenumber> <mfprimaryyn>y</mfprimaryyn> </PhoneNumber> </PhoneNumbers> <mfresort>slbk</mfresort> <mfvipstatus>0</mfvipstatus> <mfallowmail>no</mfallowmail> <mfallow >no</mfallow > <mfguestpriv>no</mfguestpriv> </Profile> HTTP Call Samples 15

16 7 Profile Anonymization Schema Changes This message specification has been extended to exchange the anonymization status of a profile. XDR: profile.fidelio.5.0.xml: <AttributeType name="anonymizationstatus" dt:type="enumeration" dt:values="undefined REQUESTED ANONYMIZED" default="undefined" required="no"/> <ElementType name="profile" content="eltonly"> <attribute type="anonymizationstatus"/> XSD 16

17 Sample Message <?xml version="1.0" encoding="utf-8"?> <?Label MOTTI PROFILE SUCCESS?> <Profile xmlns="profile.fidelio.5.0" profiletype="guest" gender="unknown" multiproperty="0" miniprofile="0" pseudoprofile="0" anonymizationstatus="anonymized" replaceaddress="0"> <creatorcode>supervisor</creatorcode> <createddate> t16:13:45.000</createddate> <lastupdatercode>supervisor</lastupdatercode> <lastupdated> t16:13:58.000</lastupdated> <genericname>kxxxxxxxxn</genericname> <IndividualName> <namesur>kxxxxxxxxn</namesur> <nameordered>e</nameordered> </IndividualName> <primarylanguageid>e</primarylanguageid> <alternatelanguageids>ch</alternatelanguageids> <PostalAddresses> <PostalAddress addresstype="home"> <countrycode>us</countrycode> <mfprimaryyn>y</mfprimaryyn> <mfaddresslanguage>ch</mfaddresslanguage> <cleansed>0</cleansed> </PostalAddress> <PostalAddress addresstype="home"> <countrycode>us</countrycode> <mfprimaryyn>n</mfprimaryyn> <mfaddresslanguage>e</mfaddresslanguage> <cleansed>0</cleansed> </PostalAddress> </PostalAddresses> <mfresort>motti</mfresort> <mfresortprofileid> </mfresortprofileid> <mfnamecode>5xxxxxxxx5</mfnamecode> <mfallowmail>yes</mfallowmail> <mfallow >no</mfallow > <mfguestpriv>no</mfguestpriv> <Udfs> <Udf xmlns="udf.fidelio.2.0"> <UdfDefinition xmlns="udfdefinition.fidelio.2.0"> <pmstablename>name</pmstablename> <pmscolumnname>udfc01</pmscolumnname> </UdfDefinition> </Udf> </Udfs> Profile Anonymization Schema Changes 17

18 <mfnationalname> <namelast>kxxxxxxxxn</namelast> </mfnationalname> <mfallowphone>0</mfallowphone> <mfallowsms>0</mfallowsms> <SalesExtention/> <PrivacyOption> <mfallowmail>y</mfallowmail> <mfallow >n</mfallow > <mfallowphone>0</mfallowphone> <mfallowsms>0</mfallowsms> <mfallowhistory>0</mfallowhistory> <mfallowmarketresearch>1</mfallowmarketresearch> <mfallowthirdparty>1</mfallowthirdparty> </PrivacyOption> <ResortData> <mfresort>enterextresort_11504</mfresort> <mfresort>cloud5</mfresort> <mfresort>enterextresort_11510</mfresort> <mfresort>enterextresort_11512</mfresort> <mfresort>barrie</mfresort> <mfresort>zoltar</mfresort> <mfresort>enterextresort_11537</mfresort> 18

19 Profile Anonymization Schema Changes 19 <mfresort>qadeanna</mfresort> <mfresort>fair</mfresort> <mfresort>fair2</mfresort> <mfresort>fair3</mfresort> <mfresort>fred</mfresort> <mfresort>enterextresort_11551</mfresort> <mfresort>enterextresort_11560</mfresort> <mfresort>ipkk</mfresort> <mfresort>radqa</mfresort> <mfresort>enterextresort_11575</mfresort> <mfresort>kmh</mfresort> <mfresort>enterextresort_11577</mfresort>

20 <mfresort>enterextresort_11578</mfresort> <mfresort>enterextresort_11583</mfresort> <mfresort>enterextresort_11584</mfresort> <mfresort>enterextresort_11585</mfresort> <mfresort>mead</mfresort> <mfresort>mexico</mfresort> <mfresort>motti</mfresort> <mfresort>mottitwo</mfresort> <mfresort>mo_iii</mfresort> <mfresort>enterextresort_11606</mfresort> <mfresort>enterextresort_11608</mfresort> 20

21 Profile Anonymization Schema Changes 21 <mfresort>enterextresort_11614</mfresort> <mfresort>enterextresort_11633</mfresort> <mfresort>enterextresort_11638</mfresort> <mfresort>enterextresort_11654</mfresort> <mfresort>toronto</mfresort> <mfresort>vixx</mfresort> <mfresort>world1</mfresort> <mfresort>zeroors</mfresort> <mfresort>enterextresort_11699</mfresort> <mfresort>enterextresort_11710</mfresort> </ResortData> <ResortList>EnterExtResort_11504</ResortList> <ResortList>CLOUD5</ResortList>

22 <ResortList>EnterExtResort_11510</ResortList> <ResortList>EnterExtResort_11512</ResortList> <ResortList>BARRIE</ResortList> <ResortList>ZOLTAR</ResortList> <ResortList>EnterExtResort_11537</ResortList> <ResortList>QADEANNA</ResortList> <ResortList>FAIR</ResortList> <ResortList>FAIR2</ResortList> <ResortList>FAIR3</ResortList> <ResortList>FRED</ResortList> <ResortList>EnterExtResort_11551</ResortList> <ResortList>EnterExtResort_11560</ResortList> <ResortList>IPKK</ResortList> <ResortList>RADQA</ResortList> <ResortList>EnterExtResort_11575</ResortList> <ResortList>KMH</ResortList> <ResortList>EnterExtResort_11577</ResortList> <ResortList>EnterExtResort_11578</ResortList> <ResortList>EnterExtResort_11583</ResortList> <ResortList>EnterExtResort_11584</ResortList> <ResortList>EnterExtResort_11585</ResortList> <ResortList>MEAD</ResortList> <ResortList>MEXICO</ResortList> <ResortList>MOTTI</ResortList> <ResortList>MOTTITWO</ResortList> <ResortList>MO_III</ResortList> <ResortList>EnterExtResort_11606</ResortList> <ResortList>EnterExtResort_11608</ResortList> <ResortList>EnterExtResort_11614</ResortList> <ResortList>EnterExtResort_11633</ResortList> <ResortList>EnterExtResort_11638</ResortList> <ResortList>EnterExtResort_11654</ResortList> <ResortList>TORONTO</ResortList> <ResortList>VIXX</ResortList> <ResortList>WORLD1</ResortList> <ResortList>ZEROORS</ResortList> <ResortList>EnterExtResort_11699</ResortList> <ResortList>EnterExtResort_11710</ResortList> <MultiResortEntities> <entity>routing_instructions</entity> <entity>credit_cards</entity> 22

23 <entity>resort_ars</entity> <entity>comments</entity> <entity>preferences</entity> <entity>negotiated_rates</entity> <entity>resort_neg_rates</entity> <entity>resort_commissions</entity> <entity>channel_access_codes</entity> <entity>yield_adjustments</entity> <entity>pseudo_city_codes</entity> <entity>relationships</entity> </MultiResortEntities> </Profile> Note: profile.fidelio.5.0.xml is used in reservation.fidelio.5.0.xml, so it contains the same profile changes. Profile Anonymization Schema Changes 23