Oracle® Hospitality OPERA Web Self-Service

Security Web Service Specification

Version 5.1

 

March 2022

 


Copyright © 1987, 2022, 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. 8

Audience. 8

Customer Support 8

Documentation.. 8

Revision History. 8

1    Functional Overview.. 10

2    AuthenticateNRUser 12

AuthenticateNRUserRequest 12

AuthenticateUserRequest with vaultedCreditCardNumber. 12

AuthenticateNRUserResponse. 13

AuthenticateUserResponse for vaultedCreditCardNumber. 14

3    AuthenticateUser 16

AuthenticateUserRequest 16

AuthenticateUserRequest with User Domain.. 16

AuthenticateUserResponse. 17

AuthenticateUserResponse for User Domain.. 18

4    CreateAppUser 20

CreateAppUserRequest 20

CreateAppUserResponse. 22

5    CreateUser 24

CreateUserRequest 24

CreateUserResponse. 25

6    DeleteAppUser 27

DeleteAppUserRequest 27

DeleteAppUserResponse. 28

7    ExtAuthenticateUser 30

ExtAuthenticateUserRequest 30

ExtAuthenticateUserRequest with User Domain.. 30

ExtAuthenticateUserResponse. 31

ExtAuthenticateUserResponse for User Domain.. 32

8    FetchAppUser 34

FetchAppUserRequest 34

FetchAppUserResponse. 34

9    FetchQuestionList 37

FetchQuestionListRequest 37

FetchQuestionListResponse. 37

10  GeneratePassword. 39

GeneratePasswordRequest 39

GeneratePasswordRequest with User Domain.. 39

GeneratePasswordResponse. 40

GeneratePasswordResponse for User Domain.. 40

11  LoginAppUser 42

LoginRequest 42

LoginRequest for Application User Groups. 42

LoginResponse. 43

LoginResponse for Application User Groups. 44

12  ResetPassword. 47

ResetPasswordRequest 47

ResetPasswordResponse. 47

13  UpdateAppUser 49

UpdateAppUserRequest 49

UpdateAppUserResponse. 51

14  UpdateAppUserPassword. 53

UpdateAppUserPasswordRequest 53

UpdateAppUserPasswordResponse. 54

15  UpdatePassword. 56

UpdatePasswordRequest 56

UpdatePasswordRequest with User Domain.. 56

UpdatePasswordResponse. 57

UpdatePasswordResponse for User Domain.. 58

16  UpdateQuestion. 60

UpdateQuestionRequest 60

UpdateQuestionRequest with User Domain.. 60

UpdateQuestionResponse. 61

UpdateQuestionResponse for User Domain.. 62

17  UserAccountLock. 64

UserAccountLockRequest 64

UserAccountLockRequest with User Domain.. 64

UserAccountLockResponse. 65

UserAccountLockResponse for User Domain.. 66

18  ValidateQuestion. 67

ValidateQuestionRequest 67

ValidateQuestionRequest with User Domain.. 67

ValidateQuestionResponse. 69

ValidateQuestionResponse for User Domain.. 69

19  Complex and Simple Type Definitions. 72

Address. 72

ApplicationUserGroup.. 72

ArrayOfApplicationUserGroup.. 73

ArrayOfComment 73

ArrayOfGovernmentID.. 73

ArrayOfIDPair. 74

ArrayOfNameAddress. 74

ArrayOfNameCreditCard.. 74

ArrayOfNameEmail 75

ArrayOfNameMembership.. 75

ArrayOfNamePhone. 76

ArrayOfNegotiatedRate. 76

ArrayOfPreference. 76

ArrayOfPrivacyOptionType. 77

ArrayOfQuestion.. 77

ArrayOfText 77

ArrayOfTextElement 78

ArrayOfUniqueID.. 78

ArrayOfUserDefinedValue. 79

ArrayOfUserGroupItem... 79

ArrayOfUserSystemRightsProfile. 79

BlackList 80

BlackListFlag. 80

Comment 80

Company. 81

CompanyCompanyType. 82

CreditCard.. 82

Customer. 83

DescriptiveText 83

FunctionNameType. 84

Gender. 84

GovernmentID.. 85

IDPair. 85

LoginCredentials. 85

Membership.. 86

ModuleNameType. 87

NameAddress. 87

NameCreditCard.. 88

NameEmail 89

NameMembership.. 89

NamePhone. 91

NativeName. 91

NegotiatedRate. 92

PersonName. 92

Phone. 93

PhonePhoneData. 94

Preference. 94

PrivacyOptionType. 95

PrivacyOptionTypeOptionType. 95

PrivacyOptionTypeOptionValue. 96

Profile. 96

ProfileUserGroup.. 99

Question.. 99

ResultStatus. 99

ResultStatusFlag. 100

SystemIdType. 101

Text 101

TextElement 101

TextList 102

UniqueID.. 102

UniqueIDType. 102

UserAccountLockSettingType. 103

UserDefinedValue. 103

UserGroup.. 104

UserGroupItem... 104

UserGroupType. 104

UserProfile. 105

UserProfileAccountLocked.. 106

UserProfilePassword.. 106

UserProfileSecurityQuestion.. 107

UserRightItem... 107

UserRightsList 107

UserSystemRightsProfile. 108

VaultedCardType. 108

 



Preface

The objective of this document is to depict how the Security Web Service messages function in OPERA Web Suite (OWS). In addition, this document breaks down the available simple and complex element types.

This document may not contain all the web service messages supported by OWS.

Audience

This document is intended for those developing custom applications that interact with OPERA using Security functionality in OWS.

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

·         Screenshots 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

January 2004

·         Initial Release

July 2004

·         Create user

September 2004

·         Version 5.1

September 2006

·         Revised and Edited

February 2007

·         Edited

March 2007

·         Revised.

November 2007

·         Regenerated

December 2007

·         Updated descriptions.

February 2009

·         154254 –  AuthenticateUserRequest attributes changed as follows: membershipNumber is required, lastName is optional, and password is required.

April 2009

·         150730 –  Updated all message samples as part of SDK update.

June 2009

·         157539 – Added UpdateAppUserPassword web function and sample request and response messages.

January 2010

·         168992 – Added userDomain attribute to Validatequestion, Useraccountlock,Updatequestion, Updatepassword, Generatepassword, AuthenticateUser and ExtAuthenticateUser functions. Sample request and response messages also added. V5.0.02.01

March 2010

·         172474 – LoginAppUser function now returns the application user groups . Added RQ and RS message samples for LoginAppUser. ApplicationUserGroup and ArrayOfApplicationUserGroup elements were also added. V5.0.02.02

March 2012

·         219104 — canHandleVaultedCreditCard boolean and VaultedCardType complex types added. Message samples added. V5.0.03.03

December 2013

·         235207 – terminalID attribute is now included in the LoginRequest and LoginResponse.

September 2015

·         Added ResetPassword function. V5.0.05.01

September 2017

·         Rebrand and update document format.

March 2022

·         Updated ArrayOfText, TextList, and ResultStatus.

 

 

1 Functional Overview

The following functions are currently provided through the Security Web Service:

 

 

Function

Description

AuthenticateNRUser

Authenticates a non-registered (no membership profile) user and returns the name identifier, given the user last name, confirmation identifier, and credit card number.

AuthenticateUser

Authenticates a user and returns the name identifier, given the membership number, last name, and password.

CreateAppUser

Creates an application user profile and returns the name identifier, given the profile details, and user group type, as well as a login name, password, and expiration date.

CreateUser

Creates a web user, given the name identifier and a login name and password.

DeleteAppUser

Deletes an application user profile, given the login name and password.

ExtAuthenticateUser

Authenticates a user and returns the login profile, given the login name and password.

FetchAppUser

Retrieves a list of application users, given the login name. Login and name profile details are also returned.

FetchQuestionList

Retrieves a list of predefined secret questions that users can choose from and answer for further authentication.

GeneratePassword

Returns an automatically generated password, given the login name.

LoginAppUser

Authenticates an application user using the login name and password credentials, and returns the security identifier (company name and user group type) and license key.

ResetPassword

Reset password or activate account of existing user.

UpdateAppUser

Modifies an application user profile and returns the name identifier, given the login name, password, and expiration date, as well as the name profile and user group information.

UpdateAppUserPassword

Updates the user’s password given the application user’s loginName, oldPassword, and newPassword. This allows users to change their passwords without logging into the application. A Success or Error Result is returned.

UpdatePassword

Modifies the login password, given the membership number, last name, old password (if not a new user), and new password.

UpdateQuestion

Modifies the answer to a user’s chosen secret question, given the name identifier, pre-defined question identifier, and new answer.

UserAccountLock

Performs a lock or unlock operation on a user account, given the login name and the lock action type.

 


 

2 AuthenticateNRUser

Authenticates a non-registered (no membership profile) user and returns the name identifier, given the user last name, confirmation identifier, and credit card number.

 

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#AuthenticateNRUser

AuthenticateNRUserRequest

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

      <soap:Header>

            <OGHeader transactionID="324969893" timeStamp="2009-03-17T18:42:12.5430600+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

                  <Origin entityID="WEST" systemType="WEB"/>

                  <Destination entityID="TI" systemType="ORS"/>

            </OGHeader>

      </soap:Header>

      <soap:Body>

            <AuthenticateNRUserRequest lastName="Smith" confirmationNumber="4627011" creditCardNumber="373344556677889" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl"/>

      </soap:Body>

</soap:Envelope>

AuthenticateUserRequest with vaultedCreditCardNumber

 

The Credit Card Vault functionality must be activated in OPERA for this feature to be available.

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

      <soap:Header>

            <OGHeader transactionID="324969893" timeStamp="2009-03-17T18:42:12.5430600+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

                  <Origin entityID="WEST" systemType="WEB"/>

                  <Destination entityID="TI" systemType="ORS"/>

            </OGHeader>

      </soap:Header>

      <soap:Body>

            <AuthenticateUserRequest lastName="SMITH" confirmationNumber="4691024" vaultedCreditCardNumber="5555555555555555" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl"/>

      </soap:Body>

</soap:Envelope>

 

AuthenticateNRUserRequest

 

<xs:complexType name="AuthenticateNRUserRequest">

<xs:attribute name="lastName" type="xs:string" />

<xs:attribute name="confirmationNumber" type="xs:string" />

<xs:attribute name="creditCardNumber" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

lastName

attribute

string

none

The last name of the guest to be authenticated.

confirmationNumber

attribute

string

none

The confirmation number of an existing reservation/booking in OPERA.

creditCardNumber

attribute

string

none

The credit card number of the card used to guarantee the booking that is referenced in the previous attribute.

 

AuthenticateNRUserResponse

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="324969893" timeStamp="2009-03-17T13:42:12.54306-04:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="TI" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#AuthenticateNRUserResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:00c66d60-cc7a-4974-8761-272c28f0fd88</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:28a5bb9c-032b-4e5f-87f1-f978435fbf73</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <AuthenticateNRUserResponse xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

      <NameID type="INTERNAL">4649260</NameID>

    </AuthenticateNRUserResponse>

  </soap:Body>

</soap:Envelope>

AuthenticateUserResponse for vaultedCreditCardNumber

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

      <soap:Header>

            <OGHeader transactionID="324969893" timeStamp="2009-03-17T13:42:12.54306-04:00" primaryLangID="E" channelValidation="true" xmlns="http://webservices.micros.com/og/4.3/Core/">

                  <Origin entityID="TI" systemType="ORS"/>

                  <Destination entityID="KIOSK" systemType="KIOSK"/>

            </OGHeader>       <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#AuthenticateNRUserResponse</wsa:Action>

            <wsa:MessageID>urn:uuid:996ca1cd-e0a0-4ffa-a564-7d07b1f95be9</wsa:MessageID>

            <wsa:RelatesTo>urn:uuid:92a3e1e3-0f7e-4334-b88f-385ec7f773bd</wsa:RelatesTo>

            <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

      </soap:Header>

      <soap:Body>

            <AuthenticateUserResponse xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

                  <Result resultStatusFlag="SUCCESS"/>

                  <NameID type="INTERNAL">4720222</NameID>

            </AuthenticateUserResponse>

      </soap:Body>

</soap:Envelope>

 

 

AuthenticateNRUserResponse

 

<xs:complexType name="AuthenticateNRUserResponse">

<xs:annotation>

<xs:appinfo>

<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>

</xs:appinfo>

</xs:annotation>

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

<xs:element minOccurs="0" maxOccurs="1" name="NameID" xmlns:q2="http://webservices.micros.com/og/4.3/Common/" type="q2:UniqueID" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

A primary indication of the success or failure of a transaction.

NameID

element

UniqueID

optional

If the authentication succeeded, this is the NameID value of the authenticated guest.

 

 


 

3 AuthenticateUser

Authenticates a user and returns the name identifier, given the membership number, last name, and password.

 

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#AuthenticateUser

AuthenticateUserRequest

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <soap:Header>

    <OGHeader transactionID="1349769" timeStamp="2009-03-02T21:43:03.3437500+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="WEST" systemType="WEB" />

      <Destination entityID="OWS" systemType="ORS" />

    </OGHeader>

  </soap:Header>

  <soap:Body>

    <AuthenticateUserRequest membershipNumber="JSMITH" password="MICROS1" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl" />

  </soap:Body>

</soap:Envelope>

AuthenticateUserRequest with User Domain

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <soap:Header>

    <OGHeader transactionID="1349769" timeStamp="2009-03-02T21:43:03.3437500+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="WEST" systemType="WEB" />

      <Destination entityID="OWS" systemType="ORS" />

    </OGHeader>

  </soap:Header>

  <soap:Body>

    <AuthenticateUserRequest membershipNumber="JSMITH" password="Abc@123" userDomain="PADMES" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl" />

  </soap:Body>

</soap:Envelope>

 

AuthenticateUserRequest

 

<xs:complexType name="AuthenticateUserRequest">

<xs:attribute name="membershipNumber" type="xs:string" />

<xs:attribute name="lastName" type="xs:string" />

<xs:attribute name="password" type="xs:string" />

<xs:attribute name="userDomain" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

membershipNumber

attribute

string

required

The membership number.

lastName

attribute

string

optional

The last name.

password

attribute

string

required

The password.

userDomain

attribute

string

none

The domain (chain code) for the web user's login account.

AuthenticateUserResponse

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="1349769" timeStamp="2009-03-02T15:43:03.34375-05:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#AuthenticateUserResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:14436d97-b77a-46b8-b68c-7a98c8123bea</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:dbb731d2-c900-45d7-973e-85b50ea68def</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <AuthenticateUserResponse xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

      <NameID type="INTERNAL">194600</NameID>

    </AuthenticateUserResponse>

  </soap:Body>

</soap:Envelope>

AuthenticateUserResponse for User Domain

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="1349769" timeStamp="2009-03-02T15:43:03.34375-05:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#AuthenticateUserResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:14436d97-b77a-46b8-b68c-7a98c8123bea</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:dbb731d2-c900-45d7-973e-85b50ea68def</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <AuthenticateUserResponse xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

      <NameID type="INTERNAL">194600</NameID>

    </AuthenticateUserResponse>

  </soap:Body>

</soap:Envelope>

 

AuthenticateUserResponse

 

<xs:complexType name="AuthenticateUserResponse">

<xs:annotation>

<xs:appinfo>

<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>

</xs:appinfo>

</xs:annotation>

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

<xs:element minOccurs="0" maxOccurs="1" name="NameID" xmlns:q2="http://webservices.micros.com/og/4.3/Common/" type="q2:UniqueID" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

The standard result object.

NameID

element

UniqueID

optional

The OPERA name ID.

 

 

 

 


4 CreateAppUser

Creates an application user profile and returns the name identifier, given the profile details, and user group type, as well as a login name, password, and expiration date.

 

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#CreateAppUser

CreateAppUserRequest

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <soap:Header>

    <OGHeader transactionID="203487987" timeStamp="2006-03-13T15:48:31.0312500+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="WEB" />

      <Destination entityID="OWS" systemType="ORS" />

      <Authentication>

        <UserCredentials>

          <UserName>ONBEHALF</UserName>

          <UserPassword>Abc@123</UserPassword>

          <Domain>GE FLORIDA</Domain>

          <SecurityId>1786836</SecurityId>

        </UserCredentials>

        <Licence>

          <Key>EUSNZ2S7EJQ382OCHB4R</Key>

        </Licence>

      </Authentication>

    </OGHeader>

  </soap:Header>

  <soap:Body>

    <CreateAppUserRequest loginName="JSMITH" password="Abc@123" expiryDate="2010-10-10" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <ProfileDetails nameType="D">

        <Customer xmlns="http://webservices.micros.com/og/4.3/Name/">

          <PersonName>

            <firstName xmlns="http://webservices.micros.com/og/4.3/Common/">JOHN</firstName>

            <lastName xmlns="http://webservices.micros.com/og/4.3/Common/">SMITH</lastName>

          </PersonName>

        </Customer>

        <Addresses xmlns="http://webservices.micros.com/og/4.3/Name/">

          <NameAddress addressType="BUSINESS">

            <AddressLine xmlns="http://webservices.micros.com/og/4.3/Common/">1111 Street</AddressLine>

            <cityName xmlns="http://webservices.micros.com/og/4.3/Common/">Anytown</cityName>

            <stateProv xmlns="http://webservices.micros.com/og/4.3/Common/">FL</stateProv>

            <countryCode xmlns="http://webservices.micros.com/og/4.3/Common/">US</countryCode>

            <postalCode xmlns="http://webservices.micros.com/og/4.3/Common/">99999</postalCode>

          </NameAddress>

        </Addresses>

      </ProfileDetails>

      <UserGroup groupType="BOOKER" />

    </CreateAppUserRequest>

  </soap:Body>

</soap:Envelope>

 

 

CreateAppUserRequest

 

<xs:complexType name="CreateAppUserRequest">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="ProfileDetails" xmlns:q1="http://webservices.micros.com/og/4.3/Name/" type="q1:Profile" />

<xs:element minOccurs="0" maxOccurs="1" name="UserGroup" xmlns:q2="http://webservices.micros.com/og/4.3/Name/" type="q2:UserGroup" />

</xs:sequence>

<xs:attribute name="loginName" type="xs:string" />

<xs:attribute name="password" type="xs:string" />

<xs:attribute name="expiryDate" type="xs:date" use="required" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

loginName

attribute

string

none

The login name of the user.

password

attribute

string

none

The password value to be authenticated.

expiryDate

attribute

date

required

The expiration date for the login.

ProfileDetails

element

Profile

optional

The profile details

UserGroup

element

UserGroup

optional

The user group that the profile belongs to. For example, TAM, BOOKER, BOOKER2, or COMPANY.

CreateAppUserResponse

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="203487987" timeStamp="2006-03-13T10:48:31.03125-04:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="OWS" systemType="WEB" />

      <Authentication>

        <UserCredentials>

          <UserName>ONBEHALF</UserName>

          <UserPassword>Abc@123</UserPassword>

          <Domain>GE FLORIDA</Domain>

          <SecurityId>1786836</SecurityId>

        </UserCredentials>

        <Licence>

          <Key>EUSNZ2S7EJQ382OCHB4R</Key>

        </Licence>

      </Authentication>

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#CreateAppUserResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:3dea2733-e249-4fb9-81b0-e4d8e4ee04b0</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:39446c26-c43a-4b8f-b3d1-358170814353</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <CreateAppUserResponse xmlns:nm="http://webservices.micros.com/og/4.3/Name/" xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

      <NameID type="INTERNAL">2</NameID>

    </CreateAppUserResponse>

  </soap:Body>

</soap:Envelope>

 

CreateAppUserResponse

 

<xs:complexType name="CreateAppUserResponse">

<xs:annotation>

<xs:appinfo>

<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>

</xs:appinfo>

</xs:annotation>

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

<xs:element minOccurs="0" maxOccurs="1" name="NameID" xmlns:q2="http://webservices.micros.com/og/4.3/Common/" type="q2:UniqueID" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

A primary indication of the success or failure of the transaction.

NameID

element

UniqueID

optional

The company name, which is required for on-behalf booking messages.

 


5 CreateUser

Creates a Web user, given the name identifier and a login name and password.

 

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#CreateUser

CreateUserRequest

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

      <soap:Header>

            <OGHeader transactionID="340985348" timeStamp="2009-03-02T21:41:40.5312500+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

                  <Origin entityID="WEST" systemType="WEB"/>

                  <Destination entityID="OWS" systemType="ORS"/>

                        <Authentication>

        <UserCredentials>

          <UserName>ONBEHALF</UserName>

          <UserPassword>Abc@123</UserPassword>

          <Domain>GE FLORIDA</Domain>

          <SecurityId>1786836</SecurityId>

        </UserCredentials>

        <Licence>

          <Key>80TOL0ZGJ3CGNKMIG3WF</Key>

        </Licence>

      </Authentication>

            </OGHeader>

      </soap:Header>

      <soap:Body>

            <CreateUserRequest loginName="JSMITH" password="Abc@123" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

                  <NameID type="INTERNAL">194600</NameID>

            </CreateUserRequest>

      </soap:Body>

</soap:Envelope>

 

CreateUserRequest

 

<xs:complexType name="CreateUserRequest">

<xs:annotation>

<xs:appinfo>

<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>

</xs:appinfo>

</xs:annotation>

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="NameID" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:UniqueID" />

</xs:sequence>

<xs:attribute name="loginName" type="xs:string" />

<xs:attribute name="password" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

loginName

attribute

string

none

The login name of the user.

password

attribute

string

none

The password value to be authenticated.

NameID

element

UniqueID

optional

The name ID or membership card number to be used.

 

CreateUserResponse

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="340985348" timeStamp="2009-03-02T15:41:40.53125-05:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

      <Authentication>

        <UserCredentials>

          <UserName>ONBEHALF</UserName>

          <UserPassword>Abc@123</UserPassword>

          <Domain>GE FLORIDA</Domain>

          <SecurityId>1786836</SecurityId>

        </UserCredentials>

        <Licence>

          <Key>80TOL0ZGJ3CGNKMIG3WF</Key>

        </Licence>

      </Authentication>

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#CreateUserResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:2332ca43-c9c4-496d-90bb-7e0b7da650c8</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:cc067d33-deb7-410c-b1d5-70115c186ced</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <CreateUserResponse xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

    </CreateUserResponse>

  </soap:Body>

</soap:Envelope>

 

CreateUserResponse

 

<xs:complexType name="CreateUserResponse">

<xs:annotation>

<xs:appinfo>

<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>

</xs:appinfo>

</xs:annotation>

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

A primary indication of the success or failure of the transaction.

 

 


6 DeleteAppUser

Deletes an application user profile, given the login name and password.

 

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#DeleteAppUser

DeleteAppUserRequest

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

      <soap:Header>

            <OGHeader transactionID="2342340972" timeStamp="2009-03-13T16:27:00.0000000+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

                  <Origin entityID="WEST" systemType="WEB"/>

                  <Destination entityID="OWS" systemType="ORS"/>

                        <Authentication>

        <UserCredentials>

          <UserName>ONBEHALF</UserName>

          <UserPassword>Abc@123</UserPassword>

          <Domain>GE FLORIDA</Domain>

          <SecurityId>1786836</SecurityId>

        </UserCredentials>

        <Licence>

          <Key>80TOL0ZGJ3CGNKMIG3WF</Key>

        </Licence>

      </Authentication>

            </OGHeader>

      </soap:Header>

      <soap:Body>

            <DeleteAppUserRequest loginName="JSMITH" password="Abc@123" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl"/>

      </soap:Body>

</soap:Envelope>

 

DeleteAppUserRequest

 

<xs:complexType name="DeleteAppUserRequest">

<xs:attribute name="loginName" type="xs:string" />

<xs:attribute name="password" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

loginName

attribute

string

none

The user’s login.

password

attribute

string

none

The user’s password.

 

DeleteAppUserResponse

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="2342340972" timeStamp="2009-03-13T11:27:00-04:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

      <Authentication>

        <UserCredentials>

          <UserName>ONBEHALF</UserName>

          <UserPassword>Abc@123</UserPassword>

          <Domain>GE FLORIDA</Domain>

          <SecurityId>1786836</SecurityId>

        </UserCredentials>

        <Licence>

          <Key>80TOL0ZGJ3CGNKMIG3WF</Key>

        </Licence>

      </Authentication>

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#DeleteAppUserResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:667118b5-4c17-45df-b6c9-416ea1ff6ab0</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:98659ed6-0d49-4602-b9a8-690f82c84420</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <DeleteAppUserResponse xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

    </DeleteAppUserResponse>

  </soap:Body>

</soap:Envelope>

 

DeleteAppUserResponse

 

<xs:complexType name="DeleteAppUserResponse">

<xs:annotation>

<xs:appinfo>

<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>

</xs:appinfo>

</xs:annotation>

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

A primary indication of the success or failure of the transaction.

 

 


7 ExtAuthenticateUser

Authenticates a user and returns the login profile, given the login name and password.

 

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#ExtAuthenticateUser

ExtAuthenticateUserRequest

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <soap:Header>

    <OGHeader transactionID="3234097" timeStamp="2009-03-13T10:58:31.4218750+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="WEST" systemType="WEB" />

      <Destination entityID="OWS" systemType="ORS" />

    </OGHeader>

  </soap:Header>

  <soap:Body>

    <ExtAuthenticateUserRequest loginName="JSMITH" password="Abc@123" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl" />

  </soap:Body>

</soap:Envelope>

ExtAuthenticateUserRequest with User Domain

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <soap:Header>

    <OGHeader transactionID="3234097" timeStamp="2009-03-13T10:58:31.4218750+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="WEST" systemType="WEB" />

      <Destination entityID="OWS" systemType="ORS" />

    </OGHeader>

  </soap:Header>

  <soap:Body>

    <ExtAuthenticateUserRequest loginName="JSMITH" password="Abc@123" userDomain="PADMES" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl" />

  </soap:Body>

</soap:Envelope>

 

ExtAuthenticateUserRequest

 

<xs:complexType name="ExtAuthenticateUserRequest">

<xs:attribute name="loginName" type="xs:string" />

<xs:attribute name="password" type="xs:string" />

<xs:attribute name="userDomain" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

loginName

attribute

string

none

The login name.

password

attribute

string

none

The password.

userDomain

attribute

string

none

The domain (chain code) for the web user's login account.

 

ExtAuthenticateUserResponse

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="3234097" timeStamp="2009-03-13T05:58:31.421875-04:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#ExtAuthenticateUserResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:eecf39cd-19fd-4ad3-bfee-d46c00e64ff7</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:361e4d98-c2ca-4e2d-90e8-5ca68edca0bb</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <ExtAuthenticateUserResponse xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

      <LoginProfile>

        <UserName xmlns="http://webservices.micros.com/og/4.3/Security/">JSMITH</UserName>

        <NameId type="INTERNAL" xmlns="http://webservices.micros.com/og/4.3/Security/">194600</NameId>

        <Password IsExpired="false" LastPasswordChanged="2009-04-03" IsSystemGenerated="true" xmlns="http://webservices.micros.com/og/4.3/Security/" />

      </LoginProfile>

    </ExtAuthenticateUserResponse>

  </soap:Body>

</soap:Envelope>

ExtAuthenticateUserResponse for User Domain

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="3234097" timeStamp="2009-03-13T05:58:31.421875-04:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#ExtAuthenticateUserResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:eecf39cd-19fd-4ad3-bfee-d46c00e64ff7</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:361e4d98-c2ca-4e2d-90e8-5ca68edca0bb</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <ExtAuthenticateUserResponse xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

      <LoginProfile>

        <UserName xmlns="http://webservices.micros.com/og/4.3/Security/">JSMITH</UserName>

        <NameId type="INTERNAL" xmlns="http://webservices.micros.com/og/4.3/Security/">194600</NameId>

        <Password IsExpired="false" LastPasswordChanged="2009-04-03" IsSystemGenerated="true" xmlns="http://webservices.micros.com/og/4.3/Security/" />

      </LoginProfile>

    </ExtAuthenticateUserResponse>

  </soap:Body>

</soap:Envelope>

 

ExtAuthenticateUserResponse

 

<xs:complexType name="ExtAuthenticateUserResponse">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

<xs:element minOccurs="0" maxOccurs="1" name="LoginProfile" xmlns:q2="http://webservices.micros.com/og/4.3/Security/" type="q2:UserProfile" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

A primary indication of the success or failure of a transaction.

LoginProfile

element

UserProfile

optional

The login profile.

 

 


8 FetchAppUser

Retrieves a list of application users, given the login name. Login and name profile details are also returned.

 

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#FetchAppUser

FetchAppUserRequest

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Header>

    <OGHeader transactionID="82347909970" timeStamp="2009-03-09T09:55:16.3618750-05:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="WEST" systemType="WEB" />

      <Destination entityID="OWS" systemType="ORS" />

      <Authentication>

        <UserCredentials>

          <UserName>ONBEHALF</UserName>

          <UserPassword>Abc@123</UserPassword>

          <Domain>GE FLORIDA</Domain>

          <SecurityId>1786836</SecurityId>

        </UserCredentials>

        <Licence>

          <Key>80TOL0ZGJ3CGNKMIG3WF</Key>

        </Licence>

      </Authentication>

    </OGHeader>

  </soap:Header>

  <soap:Body>

    <FetchAppUserRequest loginName="JSMITH" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl" />

  </soap:Body>

</soap:Envelope>

 

FetchAppUserRequest

 

<xs:complexType name="FetchAppUserRequest">

<xs:attribute name="loginName" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

loginName

attribute

string

none

The login name.

 

FetchAppUserResponse

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="82347909970" timeStamp="2009-03-09T10:55:16.361875-04:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

      <Authentication>

        <UserCredentials>

          <UserName>ONBEHALF</UserName>

          <UserPassword>Abc@123</UserPassword>

          <Domain>GE FLORIDA</Domain>

          <SecurityId>1786836</SecurityId>

        </UserCredentials>

        <Licence>

          <Key>80TOL0ZGJ3CGNKMIG3WF</Key>

        </Licence>

      </Authentication>

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#FetchAppUserResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:51c822d5-58e9-469f-a427-606a4c0d4b6d</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:20b6a79c-3de8-48d5-8c89-b4ffb542bc9b</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <FetchAppUserResponse loginName="JSMITH" password="Abc@123" expiryDate="2010-10-10" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <ResultStatus resultStatusFlag="SUCCESS" />

      <ProfileDetails insertUser="663" updateUser="663">

        <Customer xmlns="http://webservices.micros.com/og/4.3/Name/">

          <PersonName>

            <firstName xmlns="http://webservices.micros.com/og/4.3/Common/">John</firstName>

            <lastName xmlns="http://webservices.micros.com/og/4.3/Common/">Smith</lastName>

          </PersonName>

        </Customer>

        <Addresses xmlns="http://webservices.micros.com/og/4.3/Name/">

          <NameAddress>

            <AddressLine xmlns="http://webservices.micros.com/og/4.3/Common/">1111 Street </AddressLine>

            <cityName xmlns="http://webservices.micros.com/og/4.3/Common/">Anytown</cityName>

            <stateProv xmlns="http://webservices.micros.com/og/4.3/Common/">FL</stateProv>

            <countryCode xmlns="http://webservices.micros.com/og/4.3/Common/">US</countryCode>

            <postalCode xmlns="http://webservices.micros.com/og/4.3/Common/">99999</postalCode>

          </NameAddress>

        </Addresses>

        <UserGroup groupType="BOOKER" xmlns="http://webservices.micros.com/og/4.3/Name/" />

      </ProfileDetails>

    </FetchAppUserResponse>

  </soap:Body>

</soap:Envelope>

 

FetchAppUserResponse

 

<xs:complexType name="FetchAppUserResponse">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="ResultStatus" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

<xs:element minOccurs="0" maxOccurs="1" name="ProfileDetails" xmlns:q2="http://webservices.micros.com/og/4.3/Name/" type="q2:Profile" />

</xs:sequence>

<xs:attribute name="loginName" type="xs:string" />

<xs:attribute name="password" type="xs:string" />

<xs:attribute name="expiryDate" type="xs:date" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

loginName

attribute

string

none

The login name.

password

attribute

string

none

The password.

expiryDate

attribute

date

none

The expiration date.

ResultStatus

element

ResultStatus

optional

A primary indication of the success or failure of a transaction.

ProfileDetails

element

Profile

optional

The profile details.

 

 


9 FetchQuestionList

Retrieves a list of predefined secret questions that users can choose from and answer for further authentication.

 

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#FetchQuestionList

FetchQuestionListRequest

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

      <soap:Header>

            <OGHeader transactionID="2198721990" timeStamp="2009-03-02T21:46:06.4062500+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

                  <Origin entityID="WEST" systemType="WEB"/>

                  <Destination entityID="OWS" systemType="ORS"/>

                              </OGHeader>

      </soap:Header>

      <soap:Body>

            <FetchQuestionListRequest xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl"/>

      </soap:Body>

</soap:Envelope>

 

No input parameters are required for this operation.

 

FetchQuestionListResponse

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="2198721990" timeStamp="2009-03-02T15:46:06.40625-05:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#FetchQuestionListResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:d7d609f9-e2bd-4e3a-be62-f7612679e421</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:f577f400-ec95-4e76-bc1d-103a24badf24</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <FetchQuestionListResponse xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

      <Questions>

        <Question questionId="001">What is your pet's name?</Question>

        <Question questionId="002">What is your mother's maiden name?</Question>

        <Question questionId="003">What is your favorite animal?</Question>

        <Question questionId="004">Where is your country of birth?</Question>

        <Question questionId="005">What color is the sky?</Question>

        <Question questionId="006">What is your favorite color?</Question>

      </Questions>

    </FetchQuestionListResponse>

  </soap:Body>

</soap:Envelope>

 

FetchQuestionListResponse

 

<xs:complexType name="FetchQuestionListResponse">

<xs:annotation>

<xs:appinfo>

<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>

</xs:appinfo>

</xs:annotation>

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

<xs:element minOccurs="0" maxOccurs="1" name="Questions" xmlns:q2="http://webservices.micros.com/ows/5.1/Security.wsdl" type="q2:ArrayOfQuestion" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

A primary indication of the success or failure of a transaction.

Questions

element

ArrayOfQuestion

optional

A list of Question elements. If present, this must contain at least one question child element.


10    GeneratePassword

Returns an automatically generated password, given the login name.

 

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#GeneratePassword

GeneratePasswordRequest

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <soap:Header>

    <OGHeader transactionID="234423426" timeStamp="2009-03-13T10:54:31.0781250+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="WEST" systemType="WEB" />

      <Destination entityID="TI" systemType="ORS" />

    </OGHeader>

  </soap:Header>

  <soap:Body>

    <GeneratePasswordRequest loginName="SMITH" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl" />

  </soap:Body>

</soap:Envelope>

GeneratePasswordRequest with User Domain

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <soap:Header>

    <OGHeader transactionID="234423426" timeStamp="2009-03-13T10:54:31.0781250+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="WEST" systemType="WEB" />

      <Destination entityID="TI" systemType="ORS" />

    </OGHeader>

  </soap:Header>

  <soap:Body>

    <GeneratePasswordRequest loginName="SMITH" userDomain="PADMES" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl" />

  </soap:Body>

</soap:Envelope>

 

GeneratePasswordRequest

 

<xs:complexType name="GeneratePasswordRequest">

<xs:attribute name="loginName" type="xs:string" />

<xs:attribute name="userDomain" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

loginName

attribute

string

none

The login name.

userDomain

attribute

string

none

The domain (chain code) for the web user's login account.

 

GeneratePasswordResponse

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="234423426" timeStamp="2009-03-13T05:54:31.078125-04:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="TI" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#GeneratePasswordResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:1c093274-1996-48fa-b80b-924299f58adf</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:19aeadf4-4ab3-41cc-acd1-90bb2d60c2c9</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <GeneratePasswordResponse xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

      <Password>JCV63PK5G</Password>

    </GeneratePasswordResponse>

  </soap:Body>

</soap:Envelope>

GeneratePasswordResponse for User Domain

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="234423426" timeStamp="2009-03-13T05:54:31.078125-04:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="TI" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#GeneratePasswordResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:1c093274-1996-48fa-b80b-924299f58adf</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:19aeadf4-4ab3-41cc-acd1-90bb2d60c2c9</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <GeneratePasswordResponse xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

      <Password>JCV63PK5G</Password>

    </GeneratePasswordResponse>

  </soap:Body>

</soap:Envelope>

 

GeneratePasswordResponse

 

<xs:complexType name="GeneratePasswordResponse">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

<xs:element minOccurs="0" maxOccurs="1" name="Password" type="xs:string" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

An indication of the success or failure of the called function.

Password

element

string

optional

The password.

 


11    LoginAppUser

Authenticates an application user using the login name and password credentials, and returns the security identifier (company name and user group type) and license key.

 

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#LoginAppUser

LoginRequest

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

   <soap:Header>

     <OGHeader transactionID="000032" terminalID="LoginTest" timeStamp="2004-01-09T09:55:16.3618750-05:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

        <Origin entityID="WEST" systemType="WEB"/>

        <Destination entityID="WEST" systemType="ORS"/>

        <Authentication>

          <UserCredentials>

             <UserName>USERNAME_EXAMPLE</UserName>

             <UserPassword>USERPASS_EXAMPLE</UserPassword>

             <Domain>SEFIVE</Domain>

          </UserCredentials>

        </Authentication>

     </OGHeader>

   </soap:Header>

   <soap:Body>

     <LoginRequest xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl"/>

   </soap:Body>

</soap:Envelope>

 

No input parameters are required for this operation.  All of the login information is contained in the UserCredentials section of the OGHeader.

LoginRequest for Application User Groups

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Header>

    <OGHeader transactionID="000032" timeStamp="2004-01-09T09:55:16.3618750-05:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="WEST" systemType="WEB" />

      <Destination entityID="WC" systemType="ORS" />

      <Authentication>

        <UserCredentials>

          <UserName>JSMITH</UserName>

          <UserPassword>Abc@123</UserPassword>

        </UserCredentials>

      </Authentication>

    </OGHeader>

  </soap:Header>

  <soap:Body>

    <LoginRequest xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl" />

  </soap:Body>

</soap:Envelope>

 

LoginRequest

 

<xs:complexType name="LoginRequest">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="LockUser" type="xs:boolean" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

LockUser

element

boolean

optional

Flag to indicate whether locked accounts should be returned.

 

LoginResponse

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

   <soap:Header>

     <OGHeader transactionID="000032" timeStamp="2004-01-09T09:55:16.361875-05:00" primaryLangID="E" channelValidation="true" terminalID="LoginTest" xmlns="http://webservices.micros.com/og/4.3/Core/">

        <Origin entityID="WEST" systemType="ORS"/>

        <Destination entityID="WEST" systemType="WEB"/>

        <Authentication>

          <UserCredentials>

             <UserName>USERNAME_EXAMPLE</UserName>

             <UserPassword>USERPASS_EXAMPLE</UserPassword>

             <Domain>SEFIVE</Domain>

             <SecurityId>0</SecurityId>

          </UserCredentials>

          <Licence/>

        </Authentication>

     </OGHeader>

      <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#LoginAppUserResponse</wsa:Action>

     <wsa:MessageID>urn:uuid:3a01f219-653b-484c-acad-1a4c03c7d82f</wsa:MessageID>

     <wsa:RelatesTo>urn:uuid:189dbaf4-dab4-4e47-be42-8db129b8dbfd</wsa:RelatesTo>

     <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

   </soap:Header>

   <soap:Body>

     <LoginResponse xmlns:c="http://webservices.micros.com/og/4.3/Common/" LastPasswordChanged="2013-02-27" PasswordChangedDays="90" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

        <Result resultStatusFlag="SUCCESS"/>

        <ApplicationUserGroups>

          <ApplicationUserGroup GroupID="OPERA DEMOGROUP" GroupName="OPERA Demo User Group" xmlns="http://webservices.micros.com/og/4.3/Security/"/>

          <ApplicationUserGroup GroupID="OPERA DEMOGROUP" GroupName="OPERA Demo User Group" xmlns="http://webservices.micros.com/og/4.3/Security/"/>

        </ApplicationUserGroups>

     </LoginResponse>

   </soap:Body>

</soap:Envelope>

 

LoginResponse for Application User Groups

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="000032" timeStamp="2004-01-09T09:55:16.361875-05:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="WC" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

      <Authentication>

        <UserCredentials>

          <UserName>JSMITH</UserName>

          <UserPassword>Abc@123</UserPassword>

          <SecurityId>0</SecurityId>

        </UserCredentials>

        <Licence />

      </Authentication>

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#LoginAppUserResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:707b981b-efc6-4742-92a0-c3248b3cea6a</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:0af76392-295e-47f6-b753-1dfb330108da</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <LoginResponse xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

      <ApplicationUserGroups>

        <ApplicationUserGroup GroupID="ABC ADMIN" GroupName="ABC Resort Admin" xmlns="http://webservices.micros.com/og/4.3/Security/" />

      </ApplicationUserGroups>

    </LoginResponse>

  </soap:Body>

</soap:Envelope>

 

LoginResponse

 

<xs:complexType name="LoginResponse">

<xs:annotation>

<xs:appinfo>

<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>

</xs:appinfo>

</xs:annotation>

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

<xs:element minOccurs="0" maxOccurs="1" name="ApplicationUserGroups" xmlns:q2="http://webservices.micros.com/og/4.3/Security/" type="q2:ArrayOfApplicationUserGroup" />

</xs:sequence>

<xs:attribute name="companyName" type="xs:string" />

<xs:attribute name="userGroup" type="xs:string" />

<xs:attribute name="LastPasswordChanged" type="xs:date" />

<xs:attribute name="PasswordChangedDays" type="xs:int" />

<xs:attribute name="accountLocked" type="xs:boolean" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

companyName

attribute

string

none

The company name required for on-behalf booking messages.

userGroup

attribute

string

none

The type of user.

LastPasswordChanged

attribute

date

none

The date the password was last changed.

PasswordChangedDays

attribute

int

none

The number of days after which a password must be changed.

accountLocked

attribute

boolean

none

Whether or not the account is currently locked out.

Result

element

ResultStatus

optional

A primary indication of the success or failure of the transaction.

ApplicationUserGroups

element

ArrayOfApplicationUserGroup

optional

The application user groups collection.

 


12    ResetPassword

Reset password or activate account of existing user.

 

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#ResetPassword

ResetPasswordRequest

See the OWS SDK for the XML message samples.

 

ResetPasswordRequest

 

<xs:element name="ResetPasswordRequest">

<xs:complexType>

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="LoginCredentials" xmlns:q1="http://webservices.micros.com/ows/5.1/Security.wsdl" type="q1:LoginCredentials" />

<xs:element minOccurs="0" maxOccurs="1" name="Question" xmlns:q2="http://webservices.micros.com/ows/5.1/Security.wsdl" type="q2:Question" />

<xs:element minOccurs="0" maxOccurs="1" name="Answer" type="xs:string" />

</xs:sequence>

<xs:attribute name="userDomain" type="xs:string" />

</xs:complexType>

</xs:element>

 

Name

Type

Data Type

Use

Comments

userDomain

attribute

string

none

The user domain name.

LoginCredentials

element

LoginCredentials

optional

The user’s login credentials.

Question

element

Question

optional

A question element, of which only the ID is required.

Answer

element

string

optional

The proposed new answer.

 

ResetPasswordResponse

See the OWS SDK for the XML message samples.

 

ResetPasswordResponse

 

<xs:element name="ResetPasswordResponse">

<xs:complexType>

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

</xs:sequence>

</xs:complexType>

</xs:element>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

The standard result object.


 

13    UpdateAppUser

Modifies an application user profile and returns the name identifier, given the login name, password, and expiration date, as well as the name profile and user group information.

 

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#UpdateAppUser

UpdateAppUserRequest

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

      <soap:Header>

            <OGHeader transactionID="234234423" timeStamp="2006-03-13T16:14:20.0781250+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

                  <Origin entityID="OWS" systemType="WEB"/>

                  <Destination entityID="OWS" systemType="ORS"/>

                  <Authentication>

        <UserCredentials>

          <UserName>ONBEHALF</UserName>

          <UserPassword>Abc@123</UserPassword>

          <Domain>GE FLORIDA</Domain>

          <SecurityId>1786836</SecurityId>

        </UserCredentials>

        <Licence>

          <Key>NQJ4I5RSJ7AG0ILEMIC4</Key>

        </Licence>

      </Authentication>

            </OGHeader>

      </soap:Header>

      <soap:Body>

            <UpdateAppUserRequest loginName="JSMITH" password="Abc@123" expiryDate="2010-10-10" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

                  <ProfileDetails nameType="D">

                        <Customer gender="MALE" xmlns="http://webservices.micros.com/og/4.3/Name/">

                              <PersonName>

                                    <firstName xmlns="http://webservices.micros.com/og/4.3/Common/">John</firstName>

                                    <lastName xmlns="http://webservices.micros.com/og/4.3/Common/">Smith</lastName>

                              </PersonName>

                        </Customer>

                        <Addresses xmlns="http://webservices.micros.com/og/4.3/Name/">

                              <NameAddress addressType="BUSINESS">

                                    <AddressLine xmlns="http://webservices.micros.com/og/4.3/Common/">1111 Street</AddressLine>

                                    <cityName xmlns="http://webservices.micros.com/og/4.3/Common/">Anytown</cityName>

                                    <stateProv xmlns="http://webservices.micros.com/og/4.3/Common/">FL</stateProv>

                                    <countryCode xmlns="http://webservices.micros.com/og/4.3/Common/">US</countryCode>

                                    <postalCode xmlns="http://webservices.micros.com/og/4.3/Common/">99999</postalCode>

                              </NameAddress>

                        </Addresses>

                  </ProfileDetails>

                  <UserGroup groupType="BOOKER"/>

            </UpdateAppUserRequest>

      </soap:Body>

</soap:Envelope>

 

UpdateAppUserRequest

 

<xs:complexType name="UpdateAppUserRequest">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="ProfileDetails" xmlns:q1="http://webservices.micros.com/og/4.3/Name/" type="q1:Profile" />

<xs:element minOccurs="0" maxOccurs="1" name="UserGroup" xmlns:q2="http://webservices.micros.com/og/4.3/Name/" type="q2:UserGroup" />

</xs:sequence>

<xs:attribute name="loginName" type="xs:string" />

<xs:attribute name="password" type="xs:string" />

<xs:attribute name="expiryDate" type="xs:date" use="required" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

loginName

attribute

string

none

The user’s login name.

password

attribute

string

none

The user’s password.

expiryDate

attribute

date

required

The date that the user is no longer valid in the system.

ProfileDetails

element

Profile

optional

Detailed information about the profile.

UserGroup

element

UserGroup

optional

The user group, such as TAM, BOOKER, BOOKER2, or COMPANY.

UpdateAppUserResponse

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="234234423" timeStamp="2006-03-13T11:14:20.078125-04:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="OWS" systemType="WEB" />

      <Authentication>

        <UserCredentials>

          <UserName>ONBEHALF</UserName>

          <UserPassword>Abc@123</UserPassword>

          <Domain>GE FLORIDA</Domain>

          <SecurityId>1786836</SecurityId>

        </UserCredentials>

        <Licence>

          <Key>NQJ4I5RSJ7AG0ILEMIC4</Key>

        </Licence>

      </Authentication>

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#UpdateAppUserResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:0060b42d-2926-4401-8770-ba313264c1b9</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:42b5af10-57a8-4e6c-8623-5b951af44b50</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <UpdateAppUserResponse xmlns:nm="http://webservices.micros.com/og/4.3/Name/" xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

      <NameID type="INTERNAL">0</NameID>

    </UpdateAppUserResponse>

  </soap:Body>

</soap:Envelope>

 

UpdateAppUserResponse

 

<xs:complexType name="UpdateAppUserResponse">

<xs:annotation>

<xs:appinfo>

<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>

</xs:appinfo>

</xs:annotation>

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

<xs:element minOccurs="0" maxOccurs="1" name="NameID" xmlns:q2="http://webservices.micros.com/og/4.3/Common/" type="q2:UniqueID" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

A primary indication of the success or failure of a transaction.

NameID

element

UniqueID

optional

The company name, which is required for on-behalf booking messages.

 

 

 


14    UpdateAppUserPassword

Updates the user’s password given the application user’s loginName, oldPassword, and newPassword. This allows users to change their passwords without logging into the application. A Success or Error Result is returned.

 

This web function requires that the OWS application parameter Secured Mode is enabled.

 

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#UpdateAppUserPassword

UpdateAppUserPasswordRequest

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

      <soap:Header>

            <OGHeader transactionID="234234423" timeStamp="2006-03-13T16:14:20.0781250+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

                  <Origin entityID="OWS" systemType="WEB"/>

                  <Destination entityID="OWS" systemType="ORS"/>

                  <Authentication>

                        <UserCredentials>

                              <UserName>JSMITH</UserName>

                              <UserPassword>Abc@123</UserPassword>

                              <Domain>SEFIVE</Domain>

                        </UserCredentials>

                  </Authentication>

            </OGHeader>

      </soap:Header>

      <soap:Body>

            <UpdateAppUserPasswordRequest xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

                  <loginName>JSMITH</loginName>

                  <oldPassword>Abc@123</oldPassword>

                  <newPassword>Def@456</newPassword>

            </UpdateAppUserPasswordRequest>

      </soap:Body>

</soap:Envelope>

 

UpdateAppUserPasswordRequest

 

<xs:complexType name="UpdateAppUserPasswordRequest">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="loginName" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="oldPassword" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="newPassword" type="xs:string" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

A primary indication of the success or failure of a transaction.

NameID

element

UniqueID

optional

The company name, which is required for on-behalf booking messages.

Result

element

ResultStatus

optional

A primary indication of the success or failure of a transaction.

 

UpdateAppUserPasswordResponse

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  

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

   xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="349867895392" timeStamp="2009-03-02T15:44:49.9375-05:00"

      primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#UpdatePasswordResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:cd7fe5e3-10cb-4d8f-ade6-2b8c2ba4dca7</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:d60ed407-f7f7-4192-8aeb-5af8ef373687</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <UpdateAppUserPasswordResponse xmlns:c="http://webservices.micros.com/og/4.3/Common/" 

    xmlns=" 

    http://webservices.micros.com/ows/5.1/Security.wsdl">

    <Result resultStatusFlag="SUCCESS" />

    </UpdateAppUserPasswordResponse>

  </soap:Body>

</soap:Envelope>

 

UpdateAppUserPasswordResponse

 

<xs:complexType name="UpdateAppUserPasswordResponse">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

A primary indication of the success or failure of a transaction.

 

 

 

 


15    UpdatePassword

Modifies the login password, given the membership number, last name, old password (if not a new user), and new password.

 

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#UpdatePassword

UpdatePasswordRequest

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

      <soap:Header>

            <OGHeader transactionID="349867895392" timeStamp="2009-03-02T21:44:49.9375000+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

                  <Origin entityID="WEST" systemType="WEB"/>

                  <Destination entityID="OWS" systemType="ORS"/>

                              </OGHeader>

      </soap:Header>

      <soap:Body>

            <UpdatePasswordRequest membershipNumber="JSMITH" oldPassword="Abc@123" newPassword="Def@456" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl"/>

      </soap:Body>

</soap:Envelope>

UpdatePasswordRequest with User Domain

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

      <soap:Header>

            <OGHeader transactionID="349867895392" timeStamp="2009-03-02T21:44:49.9375000+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

                  <Origin entityID="WEST" systemType="WEB"/>

                  <Destination entityID="OWS" systemType="ORS"/>

                              </OGHeader>

      </soap:Header>

      <soap:Body>

            <UpdatePasswordRequest membershipNumber="JSMITH" oldPassword="Abc@123" newPassword="Def@456" userDomain="PADMES" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl"/>

      </soap:Body>

</soap:Envelope>

 

UpdatePasswordRequest

<xs:complexType name="UpdatePasswordRequest">

<xs:attribute name="membershipNumber" type="xs:string" />

<xs:attribute name="lastName" type="xs:string" />

<xs:attribute name="oldPassword" type="xs:string" />

<xs:attribute name="newPassword" type="xs:string" />

<xs:attribute name="userDomain" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

membershipNumber

attribute

string

none

The membership number of the guest.

lastName

attribute

string

none

The guest’s last name.

oldPassword

attribute

string

none

The old password value, if it exists. In the case of a newly enrolled guest, this value may be omitted. However, if this is a true change to an existing non-null value, the attribute becomes required.

newPassword

attribute

string

none

The new password value.

userDomain

attribute

string

none

The domain (chain code) for the web user's login account.

 

UpdatePasswordResponse

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="349867895392" timeStamp="2009-03-02T15:44:49.9375-05:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#UpdatePasswordResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:cd7fe5e3-10cb-4d8f-ade6-2b8c2ba4dca7</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:d60ed407-f7f7-4192-8aeb-5af8ef373687</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <UpdatePasswordResponse xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

    </UpdatePasswordResponse>

  </soap:Body>

</soap:Envelope>

UpdatePasswordResponse for User Domain

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="349867895392" timeStamp="2009-03-02T15:44:49.9375-05:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#UpdatePasswordResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:cd7fe5e3-10cb-4d8f-ade6-2b8c2ba4dca7</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:d60ed407-f7f7-4192-8aeb-5af8ef373687</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <UpdatePasswordResponse xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

    </UpdatePasswordResponse>

  </soap:Body>

</soap:Envelope>

 

UpdatePasswordResponse

 

<xs:complexType name="UpdatePasswordResponse">

<xs:annotation>

<xs:appinfo>

<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>

</xs:appinfo>

</xs:annotation>

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

A primary indication of the success or failure of a transaction.

 

 

 


16    UpdateQuestion

Modifies the answer to a user’s chosen secret question, given the name identifier, pre-defined question identifier, and new answer.

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#UpdateQuestion

UpdateQuestionRequest

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <soap:Header>

    <OGHeader transactionID="114329" timeStamp="2009-03-02T21:53:17.9218750+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="WEST" systemType="WEB" />

      <Destination entityID="OWS" systemType="ORS" />

    </OGHeader>

  </soap:Header>

  <soap:Body>

    <UpdateQuestionRequest xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <NameID type="INTERNAL">194600</NameID>

      <Question>004</Question>

      <Answer>Bombay</Answer>

    </UpdateQuestionRequest>

  </soap:Body>

</soap:Envelope>

UpdateQuestionRequest with User Domain

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <soap:Header>

    <OGHeader transactionID="114329" timeStamp="2009-03-02T21:53:17.9218750+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="WEST" systemType="WEB" />

      <Destination entityID="OWS" systemType="ORS" />

    </OGHeader>

  </soap:Header>

  <soap:Body>

    <UpdateQuestionRequest userDomain="PADMES" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <NameID type="INTERNAL">194600</NameID>

      <Question>004</Question>

      <Answer>Bombay</Answer>

    </UpdateQuestionRequest>

  </soap:Body>

</soap:Envelope>

 

UpdateQuestionRequest

 

<xs:complexType name="UpdateQuestionRequest">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="NameID" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:UniqueID" />

<xs:element minOccurs="0" maxOccurs="1" name="Question" xmlns:q2="http://webservices.micros.com/ows/5.1/Security.wsdl" type="q2:Question" />

<xs:element minOccurs="0" maxOccurs="1" name="Answer" type="xs:string" />

</xs:sequence>

<xs:attribute name="userDomain" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

userDomain

attribute

string

none

The domain (chain code) for the web user's login account.

NameID

element

UniqueID

optional

A UniqueID element representing the authenticated NameID of the guest changing their question.

Question

element

Question

optional

A question element, of which only the ID is required.

Answer

element

string

optional

The proposed new answer.

UpdateQuestionResponse

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="114329" timeStamp="2009-03-02T15:53:17.921875-05:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#UpdateQuestionResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:0cac5ed9-66a5-41f7-b0ec-c07404b45cac</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:8b31dd79-3986-4ae2-927c-c60b4fa2b174</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <UpdateQuestionResponse xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

    </UpdateQuestionResponse>

  </soap:Body>

</soap:Envelope>

UpdateQuestionResponse for User Domain

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="114329" timeStamp="2009-03-02T15:53:17.921875-05:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#UpdateQuestionResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:0cac5ed9-66a5-41f7-b0ec-c07404b45cac</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:8b31dd79-3986-4ae2-927c-c60b4fa2b174</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <UpdateQuestionResponse xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

    </UpdateQuestionResponse>

  </soap:Body>

</soap:Envelope>

 

UpdateQuestionResponse

 

<xs:complexType name="UpdateQuestionResponse">

<xs:annotation>

<xs:appinfo>

<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>

</xs:appinfo>

</xs:annotation>

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

A primary indication of the success or failure of the transaction.

 

 

 


17    UserAccountLock

Performs a lock or unlock operation on a user account, given the login name and the lock action type.

 

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#UserAccountLock

UserAccountLockRequest

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

      <soap:Header>

            <OGHeader transactionID="09709" timeStamp="2009-03-13T11:12:37.3437500+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

                  <Origin entityID="WEST" systemType="WEB"/>

                  <Destination entityID="OWS" systemType="ORS"/>

            </OGHeader>

      </soap:Header>

      <soap:Body>

            <UserAccountLockRequest loginName="JSMITH" lockAction="LOCK" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl"/>

      </soap:Body>

</soap:Envelope>

UserAccountLockRequest with User Domain

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

      <soap:Header>

            <OGHeader transactionID="09709" timeStamp="2009-03-13T11:12:37.3437500+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

                  <Origin entityID="WEST" systemType="WEB"/>

                  <Destination entityID="OWS" systemType="ORS"/>

            </OGHeader>

      </soap:Header>

      <soap:Body>

            <UserAccountLockRequest loginName="JSMITH" lockAction="LOCK" userDomain="PADMES" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl"/>

      </soap:Body>

</soap:Envelope>

 

UserAccountLockRequest

<xs:complexType name="UserAccountLockRequest">

<xs:attribute name="loginName" type="xs:string" />

<xs:attribute name="lockAction" xmlns:q1="http://webservices.micros.com/og/4.3/Security/" type="q1:UserAccountLockSettingType" use="required" />

<xs:attribute name="userDomain" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

loginName

attribute

string

none

The login name.

lockAction

attribute

UserAccountLockSettingType

required

The user account lock setting.

userDomain

attribute

string

none

The domain (chain code) for the web user's login account.

 

UserAccountLockResponse

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="09709" timeStamp="2009-03-13T06:12:37.34375-04:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#UserAccountLockResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:86c261ec-3c61-4bc5-8b1e-c72c27600ba8</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:c15d9fc3-395c-4e86-9109-61f23fd7afbd</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <UserAccountLockResponse xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

    </UserAccountLockResponse>

  </soap:Body>

</soap:Envelope>

UserAccountLockResponse for User Domain

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="09709" timeStamp="2009-03-13T06:12:37.34375-04:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#UserAccountLockResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:86c261ec-3c61-4bc5-8b1e-c72c27600ba8</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:c15d9fc3-395c-4e86-9109-61f23fd7afbd</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <UserAccountLockResponse xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

    </UserAccountLockResponse>

  </soap:Body>

</soap:Envelope>

 

UserAccountLockResponse

 

<xs:complexType name="UserAccountLockResponse">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

An indication of the success or failure of the called function.

 

 

 

 


18    ValidateQuestion

Validates a user answer to a chosen special question and returns the password, given the membership number, question identifier, and an answer.

 

Soap Action: http://webservices.micros.com/ows/5.1/Security.wsdl#ValidateQuestion

ValidateQuestionRequest

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <soap:Header>

    <OGHeader transactionID="238675129086" timeStamp="2009-03-02T21:47:22.0000000+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="WEST" systemType="WEB" />

      <Destination entityID="OWS" systemType="ORS" />

      <Authentication>

        <UserCredentials>

          <UserName>ONBEHALF</UserName>

          <UserPassword>Abc@123</UserPassword>

          <Domain>GE FLORIDA</Domain>

          <SecurityId>1786836</SecurityId>

        </UserCredentials>

        <Licence>

          <Key>NQJ4I5RSJ7AG0ILEMIC4</Key>

        </Licence>

      </Authentication>

    </OGHeader>

  </soap:Header>

  <soap:Body>

    <ValidateQuestionRequest membershipNumber="JSMITH" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Question questionId="004" />

        <Answer>BOMBAY</Answer>

         </ValidateQuestionRequest>

  </soap:Body>

</soap:Envelope>

ValidateQuestionRequest with User Domain

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

  <soap:Header>

    <OGHeader transactionID="238675129086" timeStamp="2009-03-02T21:47:22.0000000+01:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="WEST" systemType="WEB" />

      <Destination entityID="OWS" systemType="ORS" />

      <Authentication>

        <UserCredentials>

          <UserName>ONBEHALF</UserName>

          <UserPassword>Abc@123</UserPassword>

          <Domain>GE FLORIDA</Domain>

          <SecurityId>1786836</SecurityId>

        </UserCredentials>

        <Licence>

          <Key>NQJ4I5RSJ7AG0ILEMIC4</Key>

        </Licence>

      </Authentication>

    </OGHeader>

  </soap:Header>

  <soap:Body>

    <ValidateQuestionRequest membershipNumber="JSMITH" userDomain="PADMES" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Question questionId="004" />

        <Answer>BOMBAY</Answer>

         </ValidateQuestionRequest>

  </soap:Body>

</soap:Envelope>

 

ValidateQuestionRequest

 

<xs:complexType name="ValidateQuestionRequest">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Question" xmlns:q1="http://webservices.micros.com/ows/5.1/Security.wsdl" type="q1:Question" />

<xs:element minOccurs="0" maxOccurs="1" name="Answer" type="xs:string" />

</xs:sequence>

<xs:attribute name="membershipNumber" type="xs:string" />

<xs:attribute name="userDomain" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

membershipNumber

attribute

string

none

The membership number of the guest seeking to retrieve the password.

userDomain

 

attribute

string

none

Question

element

Question

optional

The membership number of the guest seeking to retrieve the password.

Answer

element

string

optional

The text value of the answer to be validated.

ValidateQuestionResponse

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="238675129086" timeStamp="2009-03-02T15:47:22-05:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

      <Authentication>

        <UserCredentials>

          <UserName>ONBEHALF</UserName>

          <UserPassword>Abc@123</UserPassword>

          <Domain>GE FLORIDA</Domain>

          <SecurityId>1786836</SecurityId>

        </UserCredentials>

        <Licence>

          <Key>NQJ4I5RSJ7AG0ILEMIC4</Key>

        </Licence>

      </Authentication>

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#ValidateQuestionResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:c296a14b-2d0c-43c2-9837-f2c3ac1fa4b8</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:71fadbcc-ef29-4664-b4d9-3070a4382b90</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <ValidateQuestionResponse xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

      <Password>Abc@123</Password>

    </ValidateQuestionResponse>

  </soap:Body>

</soap:Envelope>

ValidateQuestionResponse for User Domain

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">

  <soap:Header>

    <OGHeader transactionID="238675129086" timeStamp="2009-03-02T15:47:22-05:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

      <Origin entityID="OWS" systemType="ORS" />

      <Destination entityID="WEST" systemType="WEB" />

      <Authentication>

        <UserCredentials>

          <UserName>ONBEHALF</UserName>

          <UserPassword>Abc@123</UserPassword>

          <Domain>GE FLORIDA</Domain>

          <SecurityId>1786836</SecurityId>

        </UserCredentials>

        <Licence>

          <Key>NQJ4I5RSJ7AG0ILEMIC4</Key>

        </Licence>

      </Authentication>

    </OGHeader>    <wsa:Action>http://webservices.micros.com/ows/5.1/Security.wsdl#ValidateQuestionResponse</wsa:Action>

    <wsa:MessageID>urn:uuid:c296a14b-2d0c-43c2-9837-f2c3ac1fa4b8</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:71fadbcc-ef29-4664-b4d9-3070a4382b90</wsa:RelatesTo>

    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>

  </soap:Header>

  <soap:Body>

    <ValidateQuestionResponse xmlns:c="http://webservices.micros.com/og/4.3/Common/" xmlns="http://webservices.micros.com/ows/5.1/Security.wsdl">

      <Result resultStatusFlag="SUCCESS" />

      <Password>Abc@123</Password>

    </ValidateQuestionResponse>

  </soap:Body>

</soap:Envelope>

 

ValidateQuestionResponse

 

<xs:complexType name="ValidateQuestionResponse">

<xs:annotation>

<xs:appinfo>

<keepNamespaceDeclarations>xsn</keepNamespaceDeclarations>

</xs:appinfo>

</xs:annotation>

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Result" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ResultStatus" />

<xs:element minOccurs="0" maxOccurs="1" name="Password" type="xs:string" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

A primary indication of the success or failure of the transaction.

Password

element

string

optional

The password value returned as a result of the validation process.

 

 

 


19    Complex and Simple Type Definitions

Address

 

<xs:complexType name="Address">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="AddressLine" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="cityName" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="stateProv" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="countryCode" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="postalCode" type="xs:string" />

</xs:sequence>

<xs:attribute name="addressType" type="xs:string" />

<xs:attribute name="otherAddressType" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

addressType

attribute

string

none

The address type.

otherAddressType

attribute

string

none

The other address type.

AddressLine

element

string

optional / multiple

The street address.

cityName

element

string

optional

The city.

stateProv

element

string

optional

The state.

countryCode

element

string

optional

The country code.

postalCode

element

string

optional

The ZIP Code.

 

ApplicationUserGroup

 

<xs:complexType name="ApplicationUserGroup">

<xs:attribute name="GroupID" type="xs:string" />

<xs:attribute name="GroupName" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

GroupID

attribute

string

none

The ID of the application user group.

GroupName

attribute

string

none

The name of the application user group.

 

 

ArrayOfApplicationUserGroup

 

<xs:complexType name="ArrayOfApplicationUserGroup">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="ApplicationUserGroup" xmlns:q1="http://webservices.micros.com/og/4.3/Security/" type="q1:ApplicationUserGroup" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

ApplicationUserGroup

element

ApplicationUserGroup

optional / multiple

A collection of application user group elements.

 

ArrayOfComment

 

<xs:complexType name="ArrayOfComment">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="Comment" xmlns:q1="http://webservices.micros.com/og/4.3/Name/" type="q1:Comment" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Comment

element

Comment

optional / multiple

A collection of comment elements.

 

ArrayOfGovernmentID

 

<xs:complexType name="ArrayOfGovernmentID">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="GovernmentID" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:GovernmentID" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

GovernmentID

element

GovernmentID

optional / multiple

A collection of GovernmentID elements.

 

ArrayOfIDPair

 

<xs:complexType name="ArrayOfIDPair">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="IDPair" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:IDPair" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

IDPair

element

IDPair

optional / multiple

A collection of IDPair elements.

 

ArrayOfNameAddress

 

<xs:complexType name="ArrayOfNameAddress">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="NameAddress" xmlns:q1="http://webservices.micros.com/og/4.3/Name/" type="q1:NameAddress" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameAddress

element

NameAddress

optional / multiple

A collection of NameAddress elements.

 

ArrayOfNameCreditCard

 

<xs:complexType name="ArrayOfNameCreditCard">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="NameCreditCard" xmlns:q1="http://webservices.micros.com/og/4.3/Name/" type="q1:NameCreditCard" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameCreditCard

element

NameCreditCard

optional / multiple

A collection of NameCreditCard elements.

 

ArrayOfNameEmail

 

<xs:complexType name="ArrayOfNameEmail">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="NameEmail" xmlns:q1="http://webservices.micros.com/og/4.3/Name/" type="q1:NameEmail" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameEmail

element

NameEmail

optional / multiple

A collection of NameEmail elements.

 

ArrayOfNameMembership

 

<xs:complexType name="ArrayOfNameMembership">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="NameMembership" xmlns:q1="http://webservices.micros.com/og/4.3/Name/" type="q1:NameMembership" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameMembership

element

NameMembership

optional / multiple

Name Membership information.

 

ArrayOfNamePhone

 

<xs:complexType name="ArrayOfNamePhone">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="NamePhone" xmlns:q1="http://webservices.micros.com/og/4.3/Name/" type="q1:NamePhone" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NamePhone

element

NamePhone

optional / multiple

Phone number information.

 

ArrayOfNegotiatedRate

 

<xs:complexType name="ArrayOfNegotiatedRate">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="NegotiatedRate" xmlns:q1="http://webservices.micros.com/og/4.3/Name/" type="q1:NegotiatedRate" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NegotiatedRate

element

NegotiatedRate

optional / multiple

A collection of NegotiatedRate elements.

 

ArrayOfPreference

 

<xs:complexType name="ArrayOfPreference">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="Preference" xmlns:q1="http://webservices.micros.com/og/4.3/Name/" type="q1:Preference" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Preference

element

Preference

optional / multiple

A collection of Preference elements.

 

ArrayOfPrivacyOptionType

 

<xs:complexType name="ArrayOfPrivacyOptionType">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="PrivacyOption" xmlns:q1="http://webservices.micros.com/og/4.3/Name/" type="q1:PrivacyOptionType" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

PrivacyOption

element

PrivacyOptionType

optional / multiple

A collection of PrivacyOptionType elements.

ArrayOfQuestion

 

<xs:complexType name="ArrayOfQuestion">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="Question" xmlns:q1="http://webservices.micros.com/ows/5.1/Security.wsdl" type="q1:Question" />

</xs:sequence>

</xs:complexType>

 

 

Name

Type

Data Type

Use

Comments

Question

element

Question

optional / multiple

A collection of Question elements.

 

ArrayOfText

 

<xs:complexType name="ArrayOfText">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="TextElement" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:TextList" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

TextElement

element

TextList

optional / multiple

An element list container for TextElement types. The TextElements contain the actual string value representing the errors, if any.

 

ArrayOfTextElement

 

<xs:complexType name="ArrayOfTextElement">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="TextElement" nillable="true" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:TextElement" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

TextElement

element

TextElement

optional / multiple

 

 

ArrayOfUniqueID

 

<xs:complexType name="ArrayOfUniqueID">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="UniqueID" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:UniqueID" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

UniqueID

element

UniqueID

optional / multiple

A collection of UniqueID elements.

ArrayOfUserDefinedValue

 

<xs:complexType name="ArrayOfUserDefinedValue">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="UserDefinedValue" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:UserDefinedValue" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

UserDefinedValue

element

UserDefinedValue

optional / multiple

A collection of UserDefinedValue elements.

 

ArrayOfUserGroupItem

 

<xs:complexType name="ArrayOfUserGroupItem">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="UserGroup" xmlns:q1="http://webservices.micros.com/og/4.3/Security/" type="q1:UserGroupItem" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

UserGroup

element

UserGroupItem

optional / multiple

A collection of UserGroup elements.

 

ArrayOfUserSystemRightsProfile

 

<xs:complexType name="ArrayOfUserSystemRightsProfile">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="SystemRights" xmlns:q1="http://webservices.micros.com/og/4.3/Security/" type="q1:UserSystemRightsProfile" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

SystemRights

element

UserSystemRightsProfile

optional / multiple

System rights information.

 

BlackList

 

<xs:complexType name="BlackList">

<xs:simpleContent>

<xs:extension base="xs:string">

<xs:attribute name="flag" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:BlackListFlag" />

</xs:extension>

</xs:simpleContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

BlackList

extension

string

 

The blacklist flag.

flag

attribute

BlackListFlag

none

The possible values are REMOVE and SET.

 

BlackListFlag

 

<xs:simpleType name="BlackListFlag">

<xs:restriction base="xs:string">

<xs:enumeration value="REMOVE" />

<xs:enumeration value="SET" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

BlackListFlag

enumeration

string

 

The possible values are REMOVE and SET.

 

Comment

 

<xs:complexType name="Comment">

<xs:complexContent mixed="false">

<xs:extension xmlns:q1="http://webservices.micros.com/og/4.3/Common/" base="q1:DescriptiveText">

<xs:attribute name="operaId" type="xs:long" />

<xs:attribute name="externalId" type="xs:string" />

<xs:attribute name="commentTitle" type="xs:string" />

<xs:attribute name="insertUser" type="xs:string" />

<xs:attribute name="insertDate" type="xs:dateTime" />

<xs:attribute name="updateUser" type="xs:string" />

<xs:attribute name="updateDate" type="xs:dateTime" />

<xs:attribute name="inactiveDate" type="xs:date" />

</xs:extension>

</xs:complexContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Comment

extension

DescriptiveText

 

Free-form text.

operaId

attribute

long

none

The OPERA ID.

externalId

attribute

string

none

The external ID.

commentTitle

attribute

string

none

The comment title.

insertUser

attribute

string

none

The user who added the comment.

insertDate

attribute

dateTime

none

The date the comment was inserted.

updateUser

attribute

string

none

The user who updated the comment.

updateDate

attribute

dateTime

none

The date updated.

inactiveDate

attribute

date

none

The inactive date.

 

Company

<xs:complexType name="Company">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="CompanyName" type="xs:string" />

<xs:element minOccurs="1" maxOccurs="1" name="CompanyType" xmlns:q1="http://webservices.micros.com/og/4.3/Name/" type="q1:CompanyCompanyType" />

<xs:element minOccurs="0" maxOccurs="1" name="CompanyID" type="xs:string" />

</xs:sequence>

<xs:attribute name="commissionCode" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

commissionCode

attribute

string

none

Not used in this context.

CompanyName

element

string

optional

The name of the company.

CompanyType

element

CompanyCompanyType

required

An enumerated value, such as TRAVEL_AGENT or COMPANY.

CompanyID

element

string

optional

Not used in this context.

 

CompanyCompanyType

 

<xs:simpleType name="CompanyCompanyType">

<xs:restriction base="xs:string">

<xs:enumeration value="TRAVEL_AGENT" />

<xs:enumeration value="COMPANY" />

<xs:enumeration value="SOURCE" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

CompanyCompanyType

enumeration

string

 

The possible values are TRAVEL_AGENT, COMPANY, and SOURCE.

 

CreditCard

 

<xs:complexType name="CreditCard">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="cardCode" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="cardHolderName" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="cardNumber" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="VaultedCardData" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:VaultedCardType" />

<xs:element minOccurs="0" maxOccurs="1" name="seriesCode" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="effectiveDate" type="xs:date" />

<xs:element minOccurs="1" maxOccurs="1" name="expirationDate" type="xs:date" />

</xs:sequence>

<xs:attribute name="cardType" type="xs:string" />

<xs:attribute name="otherCardType" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

cardType

attribute

string

none

The credit card type.

otherCardType

attribute

string

none

The other card type.

cardCode

element

string

optional

The card code.

cardHolderName

element

string

optional

The card holder’s name.

cardNumber

element

string

optional

The credit card number.

VaultedCardData

element

VaultedCardType

optional

The vaulted card type.

seriesCode

element

string

optional

The card series code.

effectiveDate

element

date

optional

The effective date of the credit card.

expirationDate

element

date

required

The credit card expiration date.

 

Customer

 

<xs:complexType name="Customer">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="PersonName" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:PersonName" />

<xs:element minOccurs="0" maxOccurs="1" name="NativeName" xmlns:q2="http://webservices.micros.com/og/4.3/Name/" type="q2:NativeName" />

<xs:element minOccurs="0" maxOccurs="1" name="BusinessTitle" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="GovernmentIDList" xmlns:q3="http://webservices.micros.com/og/4.3/Common/" type="q3:ArrayOfGovernmentID" />

</xs:sequence>

<xs:attribute name="gender" xmlns:q4="http://webservices.micros.com/og/4.3/Common/" type="q4:Gender" />

<xs:attribute name="birthDate" type="xs:date" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

gender

attribute

Gender

none

The gender.

birthDate

attribute

date

none

The customer’s date of birth.

PersonName

element

PersonName

optional

The first name.

NativeName

element

NativeName

optional

The last name.

BusinessTitle

element

string

optional

The title.

GovernmentIDList

element

ArrayOfGovernmentID

optional

Optional.

 

DescriptiveText

 

<xs:complexType name="DescriptiveText">

<xs:sequence>

<xs:choice minOccurs="1" maxOccurs="1">

<xs:element minOccurs="0" maxOccurs="1" name="Image" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="Text" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ArrayOfTextElement" />

<xs:element minOccurs="0" maxOccurs="1" name="Url" type="xs:anyURI" />

</xs:choice>

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Image

element

string

optional

The image file.

Text

element

ArrayOfTextElement

optional

Free-form text.

Url

element

anyURI

optional

The URL.

 

FunctionNameType

 

<xs:simpleType name="FunctionNameType">

<xs:restriction base="xs:string">

<xs:enumeration value="FetchBooking" />

<xs:enumeration value="CancelBooking" />

<xs:enumeration value="ModifyBooking" />

<xs:enumeration value="CreateBooking" />

<xs:enumeration value="FutureBooking" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

FunctionNameType

enumeration

string

 

The possible values are FetchBooking, CancelBooking, ModifyBooking, CreateBooking, and FutureBooking.

 

Gender

 

<xs:simpleType name="Gender">

<xs:restriction base="xs:string">

<xs:enumeration value="FEMALE" />

<xs:enumeration value="MALE" />

<xs:enumeration value="UNKNOWN" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

Gender

enumeration

string

 

The possible values are FEMALE, MALE, and UNKNOWN.

GovernmentID

 

<xs:complexType name="GovernmentID">

<xs:attribute name="documentType" type="xs:string" />

<xs:attribute name="documentNumber" type="xs:string" />

<xs:attribute name="effectiveDate" type="xs:date" />

<xs:attribute name="expirationDate" type="xs:date" />

<xs:attribute name="placeOfIssue" type="xs:string" />

<xs:attribute name="countryOfIssue" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

documentType

attribute

string

none

The document number type.

documentNumber

attribute

string

none

The document number.

effectiveDate

attribute

date

none

The effective date.

expirationDate

attribute

date

none

The expiration date.

placeOfIssue

attribute

string

none

The place of issue.

countryOfIssue

attribute

string

none

The issuing country.

 

IDPair

 

<xs:complexType name="IDPair">

<xs:attribute name="idType" type="xs:string" />

<xs:attribute name="operaId" type="xs:long" />

<xs:attribute name="externalId" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

idType

attribute

string

none

The ID type.

operaId

attribute

long

none

The internal OPERA ID.

externalId

attribute

string

none

The external ID.

 

LoginCredentials

 

<xs:complexType name="LoginCredentials">

<xs:attribute name="loginName" type="xs:string" />

<xs:attribute name="password" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

loginName

attribute

string

required

The user login name.

password

attribute

string

required

The user password.

Membership

 

<xs:complexType name="Membership">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="membershipType" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="membershipNumber" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="membershipLevel" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="memberName" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="effectiveDate" type="xs:date" />

<xs:element minOccurs="0" maxOccurs="1" name="expirationDate" type="xs:date" />

<xs:element minOccurs="0" maxOccurs="1" name="currentPoints" type="xs:long" />

<xs:element minOccurs="0" maxOccurs="1" name="enrollmentCode" type="xs:string" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

membershipType

element

string

optional

The membership type code.

membershipNumber

element

string

optional

The membership number.

membershipLevel

element

string

optional

The membership level.

memberName

element

string

optional

The name on the face of the membership card.

effectiveDate

element

date

optional

The effective date of the membership.

expirationDate

element

date

optional

The expiration date of the current membership.

currentPoints

element

long

optional

The current point value for the selected membership.

enrollmentCode

element

string

optional

 

 

ModuleNameType

 

<xs:simpleType name="ModuleNameType">

<xs:restriction base="xs:string">

<xs:enumeration value="Membership" />

<xs:enumeration value="Availability" />

<xs:enumeration value="Name" />

<xs:enumeration value="Reservation" />

<xs:enumeration value="Information" />

<xs:enumeration value="Brochure" />

<xs:enumeration value="StayHistory" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

ModuleNameType

enumeration

string

 

The possible values are Membership, Availability, Name, Reservation, Information, Brochure, and StayHistory.

 

NameAddress

 

<xs:complexType name="NameAddress">

<xs:complexContent mixed="false">

<xs:extension xmlns:q1="http://webservices.micros.com/og/4.3/Common/" base="q1:Address">

<xs:attribute name="operaId" type="xs:long" />

<xs:attribute name="externalId" type="xs:string" />

<xs:attribute name="primary" type="xs:boolean" />

<xs:attribute name="displaySequence" type="xs:int" />

<xs:attribute name="insertUser" type="xs:string" />

<xs:attribute name="insertDate" type="xs:dateTime" />

<xs:attribute name="updateUser" type="xs:string" />

<xs:attribute name="updateDate" type="xs:dateTime" />

<xs:attribute name="inactiveDate" type="xs:date" />

</xs:extension>

</xs:complexContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameAddress

extension

Address

 

The address name.

operaId

attribute

long

none

The OPERA ID.

externalId

attribute

string

none

The external ID.

primary

attribute

boolean

none

An indication of whether or not this is the primary address.

displaySequence

attribute

int

none

The order in which the address appears in an ordered list.

insertUser

attribute

string

none

The insert user.

insertDate

attribute

dateTime

none

The insert date.

updateUser

attribute

string

none

The update user.

updateDate

attribute

dateTime

none

The update date.

inactiveDate

attribute

date

none

The inactive date.

 

NameCreditCard

 

<xs:complexType name="NameCreditCard">

<xs:complexContent mixed="false">

<xs:extension xmlns:q1="http://webservices.micros.com/og/4.3/Common/" base="q1:CreditCard">

<xs:attribute name="operaId" type="xs:long" />

<xs:attribute name="externalId" type="xs:string" />

<xs:attribute name="primary" type="xs:boolean" />

<xs:attribute name="displaySequence" type="xs:int" />

<xs:attribute name="insertUser" type="xs:string" />

<xs:attribute name="insertDate" type="xs:dateTime" />

<xs:attribute name="updateUser" type="xs:string" />

<xs:attribute name="updateDate" type="xs:dateTime" />

<xs:attribute name="inactiveDate" type="xs:date" />

</xs:extension>

</xs:complexContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameCreditCard

extension

CreditCard

 

The name on the credit card.

operaId

attribute

long

none

The OPERA ID.

externalId

attribute

string

none

The external ID.

primary

attribute

boolean

none

An indication of whether or not this is the primary credit card.

displaySequence

attribute

int

none

The display sequence.

insertUser

attribute

string

none

The insert user.

insertDate

attribute

dateTime

none

The insert date.

updateUser

attribute

string

none

The update user.

updateDate

attribute

dateTime

none

The update date.

inactiveDate

attribute

date

none

The inactive date.

NameEmail

 

<xs:complexType name="NameEmail">

<xs:simpleContent>

<xs:extension base="xs:string">

<xs:attribute name="operaId" type="xs:long" />

<xs:attribute name="externalId" type="xs:string" />

<xs:attribute name="primary" type="xs:boolean" />

<xs:attribute name="displaySequence" type="xs:int" />

<xs:attribute name="insertUser" type="xs:string" />

<xs:attribute name="insertDate" type="xs:dateTime" />

<xs:attribute name="updateUser" type="xs:string" />

<xs:attribute name="updateDate" type="xs:dateTime" />

<xs:attribute name="inactiveDate" type="xs:date" />

</xs:extension>

</xs:simpleContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameEmail

extension

string

 

The NameEmail.

operaId

attribute

long

none

The OPERA ID.

externalId

attribute

string

none

The external ID.

primary

attribute

boolean

none

An indication of whether or not this is the primary email.

displaySequence

attribute

int

none

The display sequence.

insertUser

attribute

string

none

The insert user.

insertDate

attribute

dateTime

none

The insert date.

updateUser

attribute

string

none

The update user.

updateDate

attribute

dateTime

none

The update date.

inactiveDate

attribute

date

none

The inactive date.

 

NameMembership

 

<xs:complexType name="NameMembership">

<xs:complexContent mixed="false">

<xs:extension xmlns:q1="http://webservices.micros.com/og/4.3/Common/" base="q1:Membership">

<xs:attribute name="operaId" type="xs:long" />

<xs:attribute name="externalId" type="xs:string" />

<xs:attribute name="primary" type="xs:boolean" />

<xs:attribute name="preferred" type="xs:boolean" />

<xs:attribute name="central" type="xs:boolean" />

<xs:attribute name="membershipClass" type="xs:string" />

<xs:attribute name="pointsLabel" type="xs:string" />

<xs:attribute name="status" type="xs:string" />

<xs:attribute name="displaySequence" type="xs:int" />

<xs:attribute name="insertUser" type="xs:string" />

<xs:attribute name="insertDate" type="xs:dateTime" />

<xs:attribute name="updateUser" type="xs:string" />

<xs:attribute name="updateDate" type="xs:dateTime" />

<xs:attribute name="inactiveDate" type="xs:date" />

</xs:extension>

</xs:complexContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameMembership

extension

Membership

 

A collection of NameMembership records retrieved for the subject profile.

operaId

attribute

long

none

The actual internal value assigned to this individual membership. It is returned by any calling system when attempting to update or delete this membership.

externalId

attribute

string

none

Not used in this context.

primary

attribute

boolean

none

An indication of whether or not this membership should be considered as the guest’s primary membership.

preferred

attribute

boolean

none

An indication of whether or not this is a preferred memebership.

central

attribute

boolean

none

An indication of whether or not this membership is the central membeship.

membershipClass

attribute

string

none

The membership class.

pointsLabel

attribute

string

none

The points label.

status

attribute

string

none

The status.

displaySequence

attribute

int

none

If annotated, this is returned.

insertUser

attribute

string

none

The ID code of the user who originally inserted the record.

insertDate

attribute

dateTime

none

The date and time that the record was originally created.

updateUser

attribute

string

none

The ID code of the user who last updated the record.

updateDate

attribute

dateTime

none

The date and time the record was last modified.

inactiveDate

attribute

date

none

Not used in this context.

 

NamePhone

 

<xs:complexType name="NamePhone">

<xs:complexContent mixed="false">

<xs:extension xmlns:q1="http://webservices.micros.com/og/4.3/Common/" base="q1:Phone">

<xs:attribute name="operaId" type="xs:long" />

<xs:attribute name="externalId" type="xs:string" />

<xs:attribute name="primary" type="xs:boolean" />

<xs:attribute name="displaySequence" type="xs:int" />

<xs:attribute name="insertUser" type="xs:string" />

<xs:attribute name="insertDate" type="xs:dateTime" />

<xs:attribute name="updateUser" type="xs:string" />

<xs:attribute name="updateDate" type="xs:dateTime" />

<xs:attribute name="inactiveDate" type="xs:date" />

</xs:extension>

</xs:complexContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NamePhone

extension

Phone

 

The phone label, such as home or business.

operaId

attribute

long

none

The OPERA ID.

externalId

attribute

string

none

The external ID.

primary

attribute

boolean

none

An indication of whether or not this is the primary phone.

displaySequence

attribute

int

none

The display sequence.

insertUser

attribute

string

none

The insert user.

insertDate

attribute

dateTime

none

The date inserted.

updateUser

attribute

string

none

The update user.

updateDate

attribute

dateTime

none

The update date.

inactiveDate

attribute

date

none

The inactive date.

NativeName

 

<xs:complexType name="NativeName">

<xs:complexContent mixed="false">

<xs:extension xmlns:q1="http://webservices.micros.com/og/4.3/Common/" base="q1:PersonName">

<xs:attribute name="languageCode" type="xs:string" />

</xs:extension>

</xs:complexContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NativeName

extension

PersonName

 

The person’s native name.

languageCode

attribute

string

none

The language code.

 

NegotiatedRate

 

<xs:complexType name="NegotiatedRate">

<xs:attribute name="operaId" type="xs:long" />

<xs:attribute name="resortCode" type="xs:string" />

<xs:attribute name="rateCode" type="xs:string" />

<xs:attribute name="commissionCode" type="xs:string" />

<xs:attribute name="beginDate" type="xs:date" />

<xs:attribute name="endDate" type="xs:date" />

<xs:attribute name="displaySequence" type="xs:int" />

<xs:attribute name="insertUser" type="xs:string" />

<xs:attribute name="insertDate" type="xs:dateTime" />

<xs:attribute name="updateUser" type="xs:string" />

<xs:attribute name="updateDate" type="xs:dateTime" />

<xs:attribute name="inactiveDate" type="xs:date" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

operaId

attribute

long

none

The OPERA ID.

resortCode

attribute

string

none

The resort code.

rateCode

attribute

string

none

The rate code.

commissionCode

attribute

string

none

The commission code.

beginDate

attribute

date

none

The start date.

endDate

attribute

date

none

The end date.

displaySequence

attribute

int

none

The display sequence.

insertUser

attribute

string

none

The user who inserted the negotiated rate.

insertDate

attribute

dateTime

none

The date the negotiated rate was inserted.

updateUser

attribute

string

none

 

updateDate

attribute

dateTime

none

The date the negotiated rate was updated.

inactiveDate

attribute

date

none

The inactive date.

 

PersonName

 

<xs:complexType name="PersonName">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="nameTitle" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="firstName" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="unbounded" name="middleName" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="lastName" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="unbounded" name="nameSuffix" type="xs:string" />

</xs:sequence>

<xs:attribute name="nameOrdered" type="xs:string" />

<xs:attribute name="familiarName" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

nameOrdered

attribute

string

none

The sequence in whcih the name appears in an ordered list.

familiarName

attribute

string

none

The nickname.

nameTitle

element

string

optional / multiple

The name prefix, such as Mr. or Mrs.

firstName

element

string

optional

The first name.

middleName

element

string

optional / multiple

The middle name.

lastName

element

string

optional

The last name.

nameSuffix

element

string

optional / multiple

The name suffix, such as Jr. or Sr.

 

Phone

 

<xs:complexType name="Phone">

<xs:sequence>

<xs:choice minOccurs="1" maxOccurs="1">

<xs:element minOccurs="0" maxOccurs="1" name="PhoneNumber" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="PhoneData" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:PhonePhoneData" />

</xs:choice>

</xs:sequence>

<xs:attribute name="phoneType" type="xs:string" />

<xs:attribute name="phoneRole" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

phoneType

attribute

string

none

The type of phone.

phoneRole

attribute

string

none

The phone role.

PhoneNumber

element

string

optional

The phone number.

PhoneData

element

PhonePhoneData

optional

Information about the phone number, such as the country access code and the phone extension.

 

PhonePhoneData

 

<xs:complexType name="PhonePhoneData">

<xs:attribute name="countryAccessCode" type="xs:string" />

<xs:attribute name="areaCode" type="xs:string" />

<xs:attribute name="phoneNumber" type="xs:string" />

<xs:attribute name="extension" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

countryAccessCode

attribute

string

none

The country access code.

areaCode

attribute

string

none

The area code.

phoneNumber

attribute

string

none

The phone number.

extension

attribute

string

none

The extension.

Preference

 

<xs:complexType name="Preference">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="PreferenceDescription" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:DescriptiveText" />

</xs:sequence>

<xs:attribute name="resortCode" type="xs:string" />

<xs:attribute name="preferenceType" type="xs:string" />

<xs:attribute name="otherPreferenceType" type="xs:string" />

<xs:attribute name="preferenceValue" type="xs:string" />

<xs:attribute name="insertUser" type="xs:string" />

<xs:attribute name="insertDate" type="xs:dateTime" />

<xs:attribute name="updateUser" type="xs:string" />

<xs:attribute name="updateDate" type="xs:dateTime" />

<xs:attribute name="inactiveDate" type="xs:date" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

resortCode

attribute

string

none

The resort code.

preferenceType

attribute

string

none

The preference type.

otherPreferenceType

attribute

string

none

The other preference type.

preferenceValue

attribute

string

none

The preference value.

insertUser

attribute

string

none

The insert user.

insertDate

attribute

dateTime

none

The date inserted.

updateUser

attribute

string

none

The update user.

updateDate

attribute

dateTime

none

The date updated.

inactiveDate

attribute

date

none

The inactive date.

PreferenceDescription

element

DescriptiveText

optional

A description of the preference.

 

PrivacyOptionType

 

<xs:complexType name="PrivacyOptionType">

<xs:attribute name="OptionType" xmlns:q1="http://webservices.micros.com/og/4.3/Name/" type="q1:PrivacyOptionTypeOptionType" use="required" />

<xs:attribute name="OptionValue" xmlns:q2="http://webservices.micros.com/og/4.3/Name/" type="q2:PrivacyOptionTypeOptionValue" use="required" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

OptionType

attribute

PrivacyOptionTypeOptionType

required

The privacy option type.

OptionValue

attribute

PrivacyOptionTypeOptionValue

required

The value.

 

PrivacyOptionTypeOptionType

 

<xs:simpleType name="PrivacyOptionTypeOptionType">

<xs:restriction base="xs:string">

<xs:enumeration value="Promotions" />

<xs:enumeration value="MarketResearch" />

<xs:enumeration value="ThirdParties" />

<xs:enumeration value="LoyaltyProgram" />

<xs:enumeration value="Privacy" />

<xs:enumeration value="Email" />

<xs:enumeration value="Mail" />

<xs:enumeration value="Phone" />

<xs:enumeration value="SMS" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

PrivacyOptionTypeOptionType

enumeration

string

 

The possible values are Promotions, MarketResearch, ThirdParties, LoyaltyProgram, Privacy, Email, Mail, Phone, and SMS.

 

PrivacyOptionTypeOptionValue

 

<xs:simpleType name="PrivacyOptionTypeOptionValue">

<xs:restriction base="xs:string">

<xs:enumeration value="YES" />

<xs:enumeration value="NO" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

PrivacyOptionTypeOptionValue

enumeration

string

 

The possible values are YES and NO.

 

Profile

 

<xs:complexType name="Profile">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="ProfileIDs" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:ArrayOfUniqueID" />

<xs:choice minOccurs="1" maxOccurs="1">

<xs:element minOccurs="0" maxOccurs="1" name="Customer" xmlns:q2="http://webservices.micros.com/og/4.3/Name/" type="q2:Customer" />

<xs:element minOccurs="0" maxOccurs="1" name="Company" xmlns:q3="http://webservices.micros.com/og/4.3/Name/" type="q3:Company" />

</xs:choice>

<xs:element minOccurs="0" maxOccurs="1" name="CreditCards" xmlns:q4="http://webservices.micros.com/og/4.3/Name/" type="q4:ArrayOfNameCreditCard" />

<xs:element minOccurs="0" maxOccurs="1" name="Addresses" xmlns:q5="http://webservices.micros.com/og/4.3/Name/" type="q5:ArrayOfNameAddress" />

<xs:element minOccurs="0" maxOccurs="1" name="Blacklist" xmlns:q6="http://webservices.micros.com/og/4.3/Name/" type="q6:BlackList" />

<xs:element minOccurs="0" maxOccurs="1" name="Phones" xmlns:q7="http://webservices.micros.com/og/4.3/Name/" type="q7:ArrayOfNamePhone" />

<xs:element minOccurs="0" maxOccurs="1" name="Preferences" xmlns:q8="http://webservices.micros.com/og/4.3/Name/" type="q8:ArrayOfPreference" />

<xs:element minOccurs="0" maxOccurs="1" name="EMails" xmlns:q9="http://webservices.micros.com/og/4.3/Name/" type="q9:ArrayOfNameEmail" />

<xs:element minOccurs="0" maxOccurs="1" name="Memberships" xmlns:q10="http://webservices.micros.com/og/4.3/Name/" type="q10:ArrayOfNameMembership" />

<xs:element minOccurs="0" maxOccurs="1" name="NegotiatedRates" xmlns:q11="http://webservices.micros.com/og/4.3/Name/" type="q11:ArrayOfNegotiatedRate" />

<xs:element minOccurs="0" maxOccurs="1" name="Comments" xmlns:q12="http://webservices.micros.com/og/4.3/Name/" type="q12:ArrayOfComment" />

<xs:element minOccurs="0" maxOccurs="1" name="UserDefinedValues" xmlns:q13="http://webservices.micros.com/og/4.3/Common/" type="q13:ArrayOfUserDefinedValue" />

<xs:element minOccurs="0" maxOccurs="1" name="Privacy" xmlns:q14="http://webservices.micros.com/og/4.3/Name/" type="q14:ArrayOfPrivacyOptionType" />

<xs:element minOccurs="0" maxOccurs="1" name="UserGroup" xmlns:q15="http://webservices.micros.com/og/4.3/Name/" type="q15:ProfileUserGroup" />

</xs:sequence>

<xs:attribute name="nameType" type="xs:string" />

<xs:attribute name="protected" type="xs:boolean" />

<xs:attribute name="languageCode" type="xs:string" />

<xs:attribute name="nationality" type="xs:string" />

<xs:attribute name="vipCode" type="xs:string" />

<xs:attribute name="taxExempt" type="xs:boolean" />

<xs:attribute name="insertUser" type="xs:string" />

<xs:attribute name="insertDate" type="xs:dateTime" />

<xs:attribute name="updateUser" type="xs:string" />

<xs:attribute name="updateDate" type="xs:dateTime" />

<xs:attribute name="inactiveDate" type="xs:date" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

nameType

attribute

string

none

Not used in this context.

Protected

attribute

boolean

none

Not used in this context.

languageCode

attribute

string

none

Not used in this context.

Nationality

attribute

string

none

Not used in this context.

vipCode

attribute

string

none

Not used in this context.

taxExempt

attribute

boolean

none

Not used in this context.

insertUser

attribute

string

none

The insert user.

insertDate

attribute

dateTime

none

The insert date.

updateUser

attribute

string

none

The update user.

updateDate

attribute

dateTime

none

The update date.

inactiveDate

attribute

date

none

The inactive date.

ProfileIDs

element

ArrayOfUniqueID

optional

The profile ID.

Customer

element

Customer

optional

The customer.

Company

element

Company

optional

The company.

CreditCards

element

ArrayOfNameCreditCard

optional

Credit card information.

Addresses

element

ArrayOfNameAddress

optional

Address information.

Blacklist

element

BlackList

optional

Blacklist details.

Phones

element

ArrayOfNamePhone

optional

Phone details are used.

Preferences

element

ArrayOfPreference

optional

Not used in this context.

Emails

element

ArrayOfNameEmail

optional

Not used in this context.

Memberships

element

ArrayOfNameMembership

optional

Not used in this context.

NegotiatedRates

element

ArrayOfNegotiatedRate

optional

Not used in this context.

Comments

element

ArrayOfComment

optional

Not used in this context.

UserDefinedValues

element

ArrayOfUserDefinedValue

optional

Not used in this context.

Privacy

element

ArrayOfPrivacyOptionType

optional

Not used in this context.

UserGroup

element

ProfileUserGroup

optional

The on behalf group.

 

ProfileUserGroup

 

<xs:complexType name="ProfileUserGroup">

<xs:attribute name="groupType" xmlns:q1="http://webservices.micros.com/og/4.3/Name/" type="q1:UserGroupType" use="required" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

groupType

attribute

UserGroupType

required

The group type.

 

Question

 

<xs:complexType name="Question">

<xs:simpleContent>

<xs:extension base="xs:string">

<xs:attribute name="questionId" type="xs:string" />

</xs:extension>

</xs:simpleContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Question

extension

string

 

The question.

questionId

attribute

string

none

The internal reference code or value for the subject question. The actual text of the question exists in the root value.

 

ResultStatus

<xs:complexType name="ResultStatus">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="Text" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:TextList" />

<xs:element minOccurs="0" maxOccurs="1" name="IDs" xmlns:q2="http://webservices.micros.com/og/4.3/Common/" type="q2: IDPairList" />

<xs:element minOccurs="0" maxOccurs="1" name="OperaErrorCode" type="xs:string" />

</xs:sequence>

<xs:attribute name="resultStatusFlag" xmlns:q3="http://webservices.micros.com/og/4.3/Common/" type="q3:ResultStatusFlag" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

resultStatusFlag

attribute

ResultStatusFlag

none

The primary indication of the success or failure of the called function.

Text

element

TextList

optional

Used to store any error or warning text associated with the transaction.

IDs

element

IDPairList

optional

If populated, this contains the ReservationID of the newly created booking.

OperaErrorCode

element

string

optional

The error code returned in the response whenever there is an error returned from the OPERA database. All error codes are defined in the default "FIDELIO" channel under the Error tab.

 

ResultStatusFlag

 

<xs:simpleType name="ResultStatusFlag">

<xs:restriction base="xs:string">

<xs:enumeration value="FAIL" />

<xs:enumeration value="SUCCESS" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

ResultStatusFlag

enumeration

string

 

The possible values are FAIL and SUCCESS.

 

SystemIdType

 

<xs:simpleType name="SystemIdType">

<xs:restriction base="xs:string">

<xs:enumeration value="OWS" />

<xs:enumeration value="GAMING" />

<xs:enumeration value="PMS" />

<xs:enumeration value="SC" />

<xs:enumeration value="OVOS" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

SystemIdType

enumeration

string

 

The possible values are OWS, GAMING, PMS, SC, and OVOS.

 

Text

 

<xs:complexType name="Text">

<xs:simpleContent>

<xs:extension base="xs:normalizedString">

<xs:attribute name="formatted" type="xs:boolean" />

<xs:attribute name="language" type="xs:language" />

</xs:extension>

</xs:simpleContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Text

extension

normalizedString

 

Not used in this context.

formatted

attribute

boolean

none

Not used in this context.

language

attribute

language

none

Not used in this context.

 

TextElement

 

<xs:complexType name="TextElement">

<xs:simpleContent>

<xs:extension xmlns:q1="http://webservices.micros.com/og/4.3/Common/" base="q1:Text" />

</xs:simpleContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

TextElement

extension

Text

 

The TextElement element.

 

TextList

<xs:complexType name="TextList">

<xs:sequence>

<xs:element name="TextElement" type="tns:Text" maxOccurs="unbounded"/>

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

TextList

extension

Text

 

The text element.

UniqueID

 

<xs:complexType name="UniqueID">

<xs:simpleContent>

<xs:extension base="xs:string">

<xs:attribute name="type" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:UniqueIDType" use="required" />

<xs:attribute name="source" type="xs:string" />

</xs:extension>

</xs:simpleContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

UniqueID

extension

string

 

The UniqueID extension.

type

attribute

UniqueIDType

required

In this context, this is hard coded as ‘INTERNAL’, indicating that the root value is the internal OPERA Name ID of the authenticated guest.

source

attribute

string

none

Not used in this context.

 

UniqueIDType

 

<xs:simpleType name="UniqueIDType">

<xs:restriction base="xs:string">

<xs:enumeration value="EXTERNAL" />

<xs:enumeration value="INTERNAL" />

<xs:enumeration value="CANCELLATIONEXTERNAL" />

<xs:enumeration value="CANCELLATIONINTERNAL" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

UniqueIDType

enumeration

string

 

The possible values are EXTERNAL, INTERNAL, CANCELLATIONEXTERNAL, and CANCELLATIONINTERNAL.

 

UserAccountLockSettingType

 

<xs:simpleType name="UserAccountLockSettingType">

<xs:restriction base="xs:string">

<xs:enumeration value="LOCK" />

<xs:enumeration value="UNLOCK" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

UserAccountLockSettingType

enumeration

string

 

The possible values are LOCK and UNLOCK.

 

UserDefinedValue

 

<xs:complexType name="UserDefinedValue">

<xs:sequence>

<xs:choice minOccurs="1" maxOccurs="1">

<xs:element minOccurs="0" maxOccurs="1" name="CharacterValue" type="xs:string" />

<xs:element minOccurs="1" maxOccurs="1" name="DateValue" type="xs:dateTime" />

<xs:element minOccurs="1" maxOccurs="1" name="NumericValue" type="xs:double" />

</xs:choice>

</xs:sequence>

<xs:attribute name="valueName" type="xs:string" />

</xs:complexType>

 

 

Name

Type

Data Type

Use

Comments

valueName

attribute

string

none

The value name.

CharacterValue

element

string

optional

The character value.

DateValue

element

dateTime

required

The date.

NumericValue

element

double

required

The numeric value.

 

UserGroup

 

<xs:complexType name="UserGroup">

<xs:attribute name="groupType" xmlns:q1="http://webservices.micros.com/og/4.3/Name/" type="q1:UserGroupType" use="required" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

groupType

attribute

UserGroupType

required

The user group type.

 

UserGroupItem

 

<xs:complexType name="UserGroupItem">

<xs:attribute name="SystemId" xmlns:q1="http://webservices.micros.com/og/4.3/Security/" type="q1:SystemIdType" />

<xs:attribute name="Group" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

SystemId

attribute

SystemIdType

none

The system ID.

Group

attribute

string

none

The group.

 

UserGroupType

 

<xs:simpleType name="UserGroupType">

<xs:restriction base="xs:string">

<xs:enumeration value="TAM" />

<xs:enumeration value="BOOKER" />

<xs:enumeration value="BOOKER2" />

<xs:enumeration value="COMPANY" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

UserGroupType

enumeration

string

 

The possible values are TAM, BOOKER, BOOKER2, and COMPANY.

 

UserProfile

 

<xs:complexType name="UserProfile">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="UserName" type="xs:string" />

<xs:element minOccurs="0" maxOccurs="1" name="NameId" xmlns:q1="http://webservices.micros.com/og/4.3/Common/" type="q1:UniqueID" />

<xs:element minOccurs="0" maxOccurs="1" name="LastLogin" type="xs:date" />

<xs:element minOccurs="0" maxOccurs="1" name="AccountLocked" xmlns:q2="http://webservices.micros.com/og/4.3/Security/" type="q2:UserProfileAccountLocked" />

<xs:element minOccurs="0" maxOccurs="1" name="Password" xmlns:q3="http://webservices.micros.com/og/4.3/Security/" type="q3:UserProfilePassword" />

<xs:element minOccurs="0" maxOccurs="1" name="SecurityQuestion" xmlns:q4="http://webservices.micros.com/og/4.3/Security/" type="q4:UserProfileSecurityQuestion" />

<xs:element minOccurs="0" maxOccurs="1" name="Rights" xmlns:q5="http://webservices.micros.com/og/4.3/Security/" type="q5:ArrayOfUserSystemRightsProfile" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

UserName

element

string

optional

The user name.

NameId

element

UniqueID

optional

The name ID.

LastLogin

element

date

optional

The last time the user logged in.

AccountLocked

element

UserProfileAccountLocked

optional

An indication of whether the account is locked or not.

Password

element

UserProfilePassword

optional

The password.

SecurityQuestion

element

UserProfileSecurityQuestion

optional

The security question.

Rights

element

ArrayOfUserSystemRightsProfile

optional

The granted rights.

 

UserProfileAccountLocked

 

<xs:complexType name="UserProfileAccountLocked">

<xs:simpleContent>

<xs:extension base="xs:boolean">

<xs:attribute name="dateLocked" type="xs:date" />

</xs:extension>

</xs:simpleContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

UserProfileAccountLocked

extension

boolean

 

An indication of whether the account is locked or not.

dateLocked

attribute

date

none

The date the account was locked.

 

UserProfilePassword

 

<xs:complexType name="UserProfilePassword">

<xs:simpleContent>

<xs:extension base="xs:string">

<xs:attribute name="IsExpired" type="xs:boolean" />

<xs:attribute name="LastPasswordChanged" type="xs:date" />

<xs:attribute name="IsSystemGenerated" type="xs:boolean" />

</xs:extension>

</xs:simpleContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

UserProfilePassword

extension

string

 

The password.

IsExpired

attribute

boolean

none

Whether or not the password is expired.

LastPasswordChanged

attribute

date

none

The last date the password was changed.

IsSystemGenerated

attribute

boolean

none

Whether or not the password is system-generated.

 

UserProfileSecurityQuestion

 

<xs:complexType name="UserProfileSecurityQuestion">

<xs:simpleContent>

<xs:extension base="xs:string">

<xs:attribute name="Answer" type="xs:string" />

</xs:extension>

</xs:simpleContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

UserProfileSecurityQuestion

extension

string

 

The security question.

Answer

attribute

string

none

The security answer.

 

 

UserRightItem

 

<xs:complexType name="UserRightItem">

<xs:attribute name="SystemId" xmlns:q1="http://webservices.micros.com/og/4.3/Security/" type="q1:SystemIdType" />

<xs:attribute name="Module" xmlns:q2="http://webservices.micros.com/og/4.3/Security/" type="q2:ModuleNameType" use="required" />

<xs:attribute name="Function" xmlns:q3="http://webservices.micros.com/og/4.3/Security/" type="q3:FunctionNameType" use="required" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

SystemId

attribute

SystemIdType

none

The system ID.

Module

attribute

ModuleNameType

required

The module.

Function

attribute

FunctionNameType

required

The function.

 

UserRightsList

 

<xs:complexType name="UserRightsList">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="unbounded" name="UserRights" xmlns:q1="http://webservices.micros.com/og/4.3/Security/" type="q1:UserRightItem" />

</xs:sequence>

<xs:attribute name="SystemId" xmlns:q2="http://webservices.micros.com/og/4.3/Security/" type="q2:SystemIdType" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

SystemId

attribute

SystemIdType

none

The system ID.

UserRights

element

UserRightItem

optional / multiple

A collection of UserRights elements.

 

UserSystemRightsProfile

 

<xs:complexType name="UserSystemRightsProfile">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="UserGroups" xmlns:q1="http://webservices.micros.com/og/4.3/Security/" type="q1:ArrayOfUserGroupItem" />

<xs:element minOccurs="0" maxOccurs="1" name="UserRights" xmlns:q2="http://webservices.micros.com/og/4.3/Security/" type="q2:UserRightsList" />

</xs:sequence>

<xs:attribute name="SystemId" xmlns:q3="http://webservices.micros.com/og/4.3/Security/" type="q3:SystemIdType" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

SystemId

attribute

SystemIdType

none

The system ID.

UserGroups

element

ArrayOfUserGroupItem

optional

The groups the user has rights to.

UserRights

element

UserRightsList

optional

The user rights.

 

VaultedCardType

 

<xs:complexType name="VaultedCardType">

<xs:attribute name="vaultedCardID" type="xs:string" />

<xs:attribute name="lastFourDigits" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

vaultedCardID

attribute

string

none

The vaulted card ID.

lastFourDigits

attribute

string

none

The last four digits of the vaulted card ID.