Oracle® Hospitality OPERA Web Self-Service

Unit Owners 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. 9

Audience. 9

Customer Support 9

Documentation.. 9

Revision History. 9

1    Functional Overview.. 11

2    AddProfileToContract 13

AddProfileToContractRequest 13

AddProfileToContractResponse. 14

3    CreateContract 16

CreateContractResponse. 22

4    DeleteProfileFromContract 24

DeleteProfileFromContractRequest 24

DeleteProfileFromContractResponse. 25

5    FetchAuthorizedProfiles. 26

FetchAuthorizedProfilesRequest 26

FetchAuthorizedProfilesResponse. 27

6    FetchContract 31

FetchContractsRequest 31

FetchContractsResponse. 32

7    FetchContractDetails. 35

FetchContractDetailsRequest 35

FetchContractDetailsResponse. 36

8    OVOS_DEDUCTION_CODES. 45

OVOS_DEDUCTION_CODES Request 45

OVOS_DEDUCTION_CODES Response. 45

OVOS_DOCUMENT_TYPES Request 46

OVOS_DOCUMENT_TYPES Response. 46

OVOS_INSURANCE_TYPES Request 47

OVOS_INSURANCE_TYPES Response. 48

OVOS_REVENUE_POOLS Request 48

OVOS_REVENUE_POOLS Response. 49

OVOS_TRX_CODES Request 50

OVOS_TRX_CODES Response. 50

9    OwnedUnitAvailability. 59

OwnedUnitAvailabilityRequest 59

OwnedUnitAvailabilityResponse. 60

10  OwnerStatementDetails. 63

OwnerStatementDetailsRequest 63

OwnerStatementDetailsResponse. 64

11  UpdateContract 66

UpdateContractRequest 66

UpdateContractResponse. 74

12  UpdateProfileInContract 76

UpdateProfileInContractRequest 76

UpdateProfileInContractResponse. 77

13  Complex and Simple Type Definitions. 79

AdditionalBedAmount 79

AdditionalBedType. 79

AdditionalDetail 79

AdditionalDetailType. 80

AdditionalGuestAmount 81

Address. 82

AgeQualifyingCode. 83

AmenityInfo. 83

Amount 83

ArrayOfAdditionalBedAmount 84

ArrayOfAdditionalDetail 84

ArrayOfAdditionalGuestAmount 84

ArrayOfAmenity. 85

ArrayOfAwardPointsToExpire. 85

ArrayOfComment 86

ArrayOfContractDeduction.. 86

ArrayOfContractDocument 86

ArrayOfContractElement 87

ArrayOfContractFees. 87

ArrayOfContractFractional 87

ArrayOfContractPoints. 88

ArrayOfContractRestriction.. 88

ArrayOfContractTask. 88

ArrayOfGdsTotalPricingTax. 89

ArrayOfGovernmentID.. 89

ArrayOfGuarantee. 89

ArrayOfGuaranteeAccepted.. 90

ArrayOfIDPair. 90

ArrayOfInsurancePolicy. 90

ArrayOfKeyWord.. 91

ArrayOfNameAddress. 91

ArrayOfNameCreditCard.. 91

ArrayOfNameEmail 92

ArrayOfNameMembership.. 92

ArrayOfNamePhone. 93

ArrayOfNegotiatedRate. 93

ArrayOfPackageElement 93

ArrayOfPreference. 94

ArrayOfPrivacyOptionType. 94

ArrayOfRate. 94

ArrayOfRelatedProfileListRelatedProfiles. 95

ArrayOfRentalContract 95

ArrayOfRoomFeature. 95

ArrayOfRelatedProfile. 96

ArrayOfRoomRate. 96

ArrayOfRelatedProfileListRelatedProfiles. 97

ArrayOfRentalContract 97

ArrayOfRoomFeature. 97

ArrayOfText 98

ArrayOfTextElement 98

ArrayOfUniqueID.. 98

ArrayOfUnitContract 99

ArrayOfUnitRate. 99

ArrayOfUserDefinedValue. 99

AwardPointsToExpire. 100

BlackList 100

BlackListFlag. 100

CancelDateTime. 101

Comment 101

Commission.. 102

Company. 103

CompanyCompanyType. 103

ContractDeduction.. 104

ContractDocument 104

ContractElement 105

ContractFees. 105

ContractFractional 106

ContractMiscellaneous. 107

ContractPoints. 107

ContractProfileType. 108

ContractRestriction.. 108

ContractRestrictionRestriction.. 110

ContractRestrictionType. 110

ContractTask. 111

ContractProfileType. 111

CreditCard.. 112

Customer. 113

DepositRequirement 114

DescriptiveText 114

Discount 115

DiscountType. 115

EncryptedSwipe. 115

GdsFlags. 116

GdsTotalPricing. 116

GdsTotalPricingTax. 117

Gender. 118

GovernmentID.. 118

Guarantee. 119

GuaranteeAccepted.. 120

GuestCount 121

GuestCountList 121

HotelReference. 122

IDPair. 122

InsurancePolicy. 122

KeyWord.. 123

Membership.. 123

NameAddress. 125

NameCreditCard.. 126

NameEmail 126

NameMembership.. 127

NamePhone. 129

NativeName. 130

NegotiatedRate. 130

PackageDetailCharges. 131

PackageElement 132

Paragraph.. 133

PersonName. 134

Phone. 135

PhonePhoneData. 135

Preference. 136

PrivacyOptionType. 137

PrivacyOptionTypeOptionType. 137

PrivacyOptionTypeOptionValue. 138

Profile. 138

ProfileUserGroup.. 141

Rate. 141

RateOccurrenceType. 143

RatePlan.. 143

RelatedProfile. 146

RelatedProfileListRelatedProfiles. 147

RentalContract 148

ResultStatus. 149

ResultStatusFlag. 150

Room... 150

RoomFeature. 151

RoomRate. 151

RoomType. 153

StayHistoryData. 155

Text 155

TextElement 156

TextList 156

TimeSpan.. 156

UniqueID.. 157

UniqueIDType. 157

UnitContract 158

UnitContractDetails. 160

UnitContractStatus. 162

UnitRate. 162

UserDefinedValue. 162

UserGroupType. 163

VaultedCardType. 163


Preface

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

The OPERA Vacation Ownership System (OVOS) seamlessly integrates into the OPERA Enterprise Solution, giving OVOS the rich functionality already available with other OPERA products. In addition, the OPERA Vacation Ownership System offers many features specific to the mixed-use and vacation ownership environment, including full contract terms configurability and rules-based operation, to ensure the flexibility required to meet a wide spectrum of business needs.

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 Unit Owners functionality in OPERA via 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

February 2007

·         Initial Release

March 2007

·         Revised

June 2007

·         Replaced XML messages for both the FetchContractDetails and FetchAuthorizedProfiles responses to reflect primary address information now returned.

December 2007

·         Regenerated and replaced descriptions.

March 2009

·         Updated all message samples as part of SDK update.

December 2012

·         Added OWS UnitOwners has been enhanced to handle contract management via OWS.

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 Unit Owners Web Service:

 

Function

Description

AddProfileToContract

Adds a profile to a contract, given the guest name, requesting name, contract, and resort identifiers, and the relationship of the guest to the contract owner.

CreateContract

Create a contract.

DeleteContract

Delete a contract.

DeleteProfileFromContract

Removes a profile from a contract, given the guest name, requesting name, resort, and resort identifiers.

FetchAuthorizedProfiles

Retrieves a list of contracts, given the name, resort, and/or contract identifiers. Contracts of the owner, co-owners, and family/friends are included. Information about the contract type, unit, effective dates, rate plans, and attached profiles is provided.

FetchContract

Retrieves a contract, given at least the name identifier. The resort and contract identifiers and the requestor role (primary-owner, co-owner, or friends-and-family) are also allowed, and are returned. Information about the contract type, unit, effective dates, rate plans, and attached profiles is provided.

FetchContractDetails

Retrieves details of a contract, given the name and resort identifiers. The contract identifier is also allowed and is returned. Information includes financial arrangements, restrictions, contract documents, and insurance policies in addition to information about the contract type, unit, effective dates, rate plans, and attached profiles.

OwnedUnitAvailability

Retrieves unit availability by contract, given at least the name identifier and stay date range. Contract and resort identifiers as well as a list of guest counts and the room type code are also allowed. For each contract, information includes the contract identifier, type, unit, effective dates, rate plans, and attached profiles, as well as a list of room types with rate details.

OwnerStatementDetails

Retrieves the file names of the owner statement and summary information, given the name and resort identifiers and the stay date range.

UpdateContract

Update the contract with new details.

UpdateProfileInContract

Modifies a family/friend guest profile, given the guest name, requestor name, contract, and resort identifiers as well as the relationship of the requestor.

 

 

 


 

2 AddProfileToContract

Adds a profile to a contract, given the guest name, requesting name, contract, resort identifiers, and the relationship of the guest to the contract owner.

 

Soap Action: http://webservices.micros.com/ows/5.1/UnitOwners.wsdl#AddProfileToContract

AddProfileToContractRequest

 

<?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:c="http://webservices.micros.com/og/4.3/Common/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:r="http://webservices.micros.com/og/4.3/Reservation/" xmlns:hc="http://webservices.micros.com/og/4.3/HotelCommon/" xmlns:n="http://webservices.micros.com/og/4.3/Name/">
  <soap:Header>
    <OGHeader transactionID="987698737" primaryLangID="E" timeStamp="2009-01-13T14:48:16.0718750-05: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>
    <AddProfileToContractRequest xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">
      <NameId type="INTERNAL">3909328</NameId>
      <RequesterNameId type="INTERNAL">5758088</RequesterNameId>
      <ContractId type="INTERNAL">85001</ContractId>
      <Resort>RESORT</Resort>
      <Relationship>BROTHER</Relationship>
    </AddProfileToContractRequest>
  </soap:Body>
</soap:Envelope>

AddProfileToContractRequest

 

<xs:complexType name="AddProfileToContractRequest">

<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="RequesterNameId" xmlns:q2="http://webservices.micros.com/og/4.3/Common/" type="q2:UniqueID" />

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

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameId

element

UniqueID

optional

The OPERA NameID for the individual guest.

RequesterNameId

element

UniqueID

optional

The OPERA NameID for the requester.

ContractId

element

UniqueID

optional

The contract ID.

Resort

element

string

optional

The resort ID.

Relationship

element

string

optional

The relationship of the individual to the owner.

 

AddProfileToContractResponse

 

<?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="987698737" timeStamp="2009-01-13T14:48:16.071875-05: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/UnitOwners.wsdl#AddProfileToContractResponse</wsa:Action>
    <wsa:MessageID>urn:uuid:8af2b480-0a40-4d52-9431-a396fb12aa4e</wsa:MessageID>
    <wsa:RelatesTo>urn:uuid:1536accc-978f-484d-ad89-582fa292dc18</wsa:RelatesTo>
    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
  </soap:Header>
  <soap:Body>
    <AddProfileToContractResponse xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">
      <Result resultStatusFlag="SUCCESS" />
    </AddProfileToContractResponse>
  </soap:Body>
</soap:Envelope>

AddProfileToContractResponse

 

<xs:complexType name="AddProfileToContractResponse">

<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 called function.

 

 


 

3 CreateContract

Soap Action: http://webservices.micros.com/ows/5.1/UnitOwners.wsdl#CreateContract

 

<?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="32868696" primaryLangID="E" timeStamp="2009-03-13T14:48:16.0718750-05: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>
    <CreateContractRequest xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">
      <ContractDetails>
        <HotelReference hotelCode="RESORT" xmlns="http://webservices.micros.com/og/4.3/UnitOwners/" />
        <ContractNumber xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
        </ContractNumber>
        <Unit xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <RoomNumber xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">102</RoomNumber>
        </Unit>
        <ValidDates xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2013-07-21T00:00:00</StartDate>
          <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2014-12-31T00:00:00</EndDate>
        </ValidDates>
        <AuthorizedProfiles xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <RelatedProfiles ContractProfileType="PRIMARYOWNER" taxId="342385675" primary="true" changeUnit="false" revenuePercentage="80" generalExciseTax="false" transientAccommodationTax="false" accountCode="25434" CommissionPercentage="100">
            <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>
            <Phones xmlns="http://webservices.micros.com/og/4.3/Name/">
              <NamePhone phoneType="HOME" phoneRole="PHONE">
                <PhoneNumber xmlns="http://webservices.micros.com/og/4.3/Common/">1234567890</PhoneNumber>
              </NamePhone>
            </Phones>
            <EMails xmlns="http://webservices.micros.com/og/4.3/Name/">
              <NameEmail operaId="323956">name@example.com</NameEmail>
            </EMails>
          </RelatedProfiles>
          <RelatedProfiles ContractProfileType="CO-OWNER" revenuePercentage="20">
            <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>
            <Phones xmlns="http://webservices.micros.com/og/4.3/Name/">
              <NamePhone phoneType="HOME" phoneRole="PHONE">
                <PhoneNumber xmlns="http://webservices.micros.com/og/4.3/Common/">1234567890</PhoneNumber>
              </NamePhone>
            </Phones>
            <EMails xmlns="http://webservices.micros.com/og/4.3/Name/">
              <NameEmail operaId="323958">name@example.com</NameEmail>
            </EMails>
          </RelatedProfiles>
          <RelatedProfiles ContractProfileType="FRIENDS_AND_FAMILY" Relationship="FAMILY">
            <Customer xmlns="http://webservices.micros.com/og/4.3/Name/">
              <PersonName>
                <firstName xmlns="http://webservices.micros.com/og/4.3/Common/">Jane</firstName>
                <lastName xmlns="http://webservices.micros.com/og/4.3/Common/">Smith</lastName>
              </PersonName>
            </Customer>
          </RelatedProfiles>
          <RelatedProfiles ContractProfileType="FRIENDS_AND_FAMILY" Relationship="FRIEND">
            <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>
          </RelatedProfiles>
        </AuthorizedProfiles>
        <ContractType xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">U</ContractType>
        <RentalProgram xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">true</RentalProgram>
        <Status xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">Negotiated</Status>
        <TemplateCode xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">2</TemplateCode>
        <ModifiedUnit xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">false</ModifiedUnit>
        <Restrictions xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <Restriction>
            <RestrictionType>AF</RestrictionType>
            <Dates>
              <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2006-10-21T00:00:00</StartDate>
              <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2006-10-24T00:00:00</EndDate>
            </Dates>
            <MaximumNights>2</MaximumNights>
            <Day1>Y</Day1>
            <Day2>Y</Day2>
            <Day3>Y</Day3>
            <Day4>Y</Day4>
            <Day5>Y</Day5>
            <Day6>Y</Day6>
            <Day7>Y</Day7>
            <CompNights>2</CompNights>
          </Restriction>
          <Restriction>
            <RestrictionType>MR</RestrictionType>
            <Dates>
              <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2007-07-20T00:00:00</StartDate>
              <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2007-07-24T00:00:00</EndDate>
            </Dates>
            <MinimumRate>200</MinimumRate>
            <Day1>Y</Day1>
            <Day2>Y</Day2>
            <Day3>Y</Day3>
            <Day4>Y</Day4>
            <Day5>Y</Day5>
            <Day6>Y</Day6>
            <Day7>Y</Day7>
            <CompNights>0</CompNights>
          </Restriction>
          <Restriction>
            <RestrictionType>CN</RestrictionType>
            <Dates>
              <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2008-07-20T00:00:00</StartDate>
              <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2008-07-28T00:00:00</EndDate>
            </Dates>
            <MaximumNights>3</MaximumNights>
            <UsedNights>1</UsedNights>
            <Day1>Y</Day1>
            <Day2>Y</Day2>
            <Day3>Y</Day3>
            <Day4>Y</Day4>
            <Day5>Y</Day5>
            <Day6>Y</Day6>
            <Day7>Y</Day7>
            <CompNights>3</CompNights>
          </Restriction>
          <Restriction>
            <RestrictionType>PC</RestrictionType>
            <Dates>
              <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2009-07-20T00:00:00</StartDate>
              <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2009-07-27T00:00:00</EndDate>
            </Dates>
            <Day1>Y</Day1>
            <Day2>Y</Day2>
            <Day3>Y</Day3>
            <Day4>Y</Day4>
            <Day5>Y</Day5>
            <Day6>Y</Day6>
            <Day7>Y</Day7>
            <CompNights>0</CompNights>
            <OwnerMaximum>2</OwnerMaximum>
            <AuthMaximum>0</AuthMaximum>
            <Rate>100</Rate>
          </Restriction>
        </Restrictions>
        <RentalContracts xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <RentalContract>
            <Dates>
              <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2006-07-21T00:00:00</StartDate>
              <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2020-07-20T00:00:00</EndDate>
            </Dates>
            <OwnerRevenueShare>100</OwnerRevenueShare>
            <RevenueShareFormula>N</RevenueShareFormula>
            <CommByOwner>10</CommByOwner>
            <AutoRenewalDate>2020-07-20</AutoRenewalDate>
            <AutoRenewalMonths>12</AutoRenewalMonths>
            <LongTerm>false</LongTerm>
            <GraceMonths>2</GraceMonths>
            <RevenuePool>TESTPOOL</RevenuePool>
          </RentalContract>
        </RentalContracts>
        <Deductions xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <Deduction>
            <DeductionCode>MARKETING</DeductionCode>
            <Rule>A</Rule>
            <Amount>20</Amount>
            <Formula>F</Formula>
            <Sequence>1</Sequence>
          </Deduction>
        </Deductions>
        <Fees xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <Fee>
            <FeeCode>TRANSPORT</FeeCode>
            <Frequency>W</Frequency>
            <Amount>10</Amount>
            <TransactionCode>2170</TransactionCode>
            <AutoPost>Y</AutoPost>
            <PostTo>O</PostTo>
            <OccupiedBy>A</OccupiedBy>
          </Fee>
        </Fees>
        <Tasks xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <Task>
            <TaskCode>CARPET</TaskCode>
            <Amount>10</Amount>
            <TaskRhythm>D</TaskRhythm>
            <TransactionCode>2100</TransactionCode>
            <PostTo>O</PostTo>
            <OccupiedBy>A</OccupiedBy>
          </Task>
        </Tasks>
        <ContractDocuments xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <ContractDocument>
            <DocumentType>CONTRACT</DocumentType>
            <Description>
              <Text xmlns="http://webservices.micros.com/og/4.3/Common/">
                <TextElement>rental contract</TextElement>
              </Text>
            </Description>
            <DateReceived>2006-07-21</DateReceived>
          </ContractDocument>
        </ContractDocuments>
        <InsurancePolicies xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <Insurance>
            <PolicyNumber>2342422432</PolicyNumber>
            <InsuranceType>HUR</InsuranceType>
            <EffectiveDates>
              <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2006-07-21T00:00:00</StartDate>
              <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2007-07-20T00:00:00</EndDate>
            </EffectiveDates>
            <Company>
              <Company xmlns="http://webservices.micros.com/og/4.3/Name/">
                <CompanyName>My Insurance Co.</CompanyName>
                <CompanyType>TRAVEL_AGENT</CompanyType>
              </Company>
            </Company>
            <Required_For_Rental>true</Required_For_Rental>
          </Insurance>
        </InsurancePolicies>
        <Miscellaneous xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <ContractDate>2006-07-21</ContractDate>
          <EstimatedClosingDate>2007-07-20</EstimatedClosingDate>
          <RealEstateAgent>My Real Estate Agent</RealEstateAgent>
          <SalesAssociate>My Sales Associate</SalesAssociate>
          <PurchasePrice>200000</PurchasePrice>
          <Comments>this is a test comment</Comments>
        </Miscellaneous>
      </ContractDetails>
    </CreateContractRequest>
  </soap:Body>
</soap:Envelope>

 

CreateContractRequest

 

<xs:complexType name="CreateContractRequest">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

ContractDetails

element

UnitContractDetails

optional

The unit contract details.

 

CreateContractResponse

 

<xs:complexType name="CreateContractResponse">

<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="ContractId" xmlns:q2="http://webservices.micros.com/og/4.3/Common/" type="q2:UniqueID" />

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

The Result.

ContractId

element

UniqueID

optional

The unique Contract ID number.

ContractNo

element

UniqueID

optional

The unique Contract Number.

 


 

4 DeleteProfileFromContract

Removes a profile from a contract, given the guest name, requesting name, resort, and resort identifiers.

 

Soap Action: http://webservices.micros.com/ows/5.1/UnitOwners.wsdl#DeleteProfileFromContract

DeleteProfileFromContractRequest

 

<?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:c="http://webservices.micros.com/og/4.3/Common/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:r="http://webservices.micros.com/og/4.3/Reservation/" xmlns:hc="http://webservices.micros.com/og/4.3/HotelCommon/" xmlns:n="http://webservices.micros.com/og/4.3/Name/">
  <soap:Header>
    <OGHeader transactionID="0987079877" primaryLangID="E" timeStamp="2009-03-13T14:48:16.0718750-05: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>
    <DeleteProfileFromContractRequest xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">
      <NameId type="INTERNAL">3909328</NameId>
      <RequesterNameId type="INTERNAL">5758088</RequesterNameId>
      <ContractId type="INTERNAL">85001</ContractId>
      <Resort>RESORT</Resort>
    </DeleteProfileFromContractRequest>
  </soap:Body>
</soap:Envelope>

 

DeleteProfileFromContractRequest

 

<xs:complexType name="DeleteProfileFromContractRequest">

<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="RequesterNameId" xmlns:q2="http://webservices.micros.com/og/4.3/Common/" type="q2:UniqueID" />

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameId

element

UniqueID

optional

The OPERA NameID for the individual guest.

RequesterNameId

element

UniqueID

optional

The OPERA NameID for the requester.

ContractId

element

UniqueID

optional

The contract ID.

Resort

element

string

optional

The resort ID.

DeleteProfileFromContractResponse

 

<?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="0987079877" primaryLangID="E" timeStamp="2009-03-13T14:48:59.0709750-05:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

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

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

            </OGHeader>

      </soap:Header>

      <soap:Body>

            <DeleteProfileFromContractResponse xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">

                  <Result resultStatusFlag="SUCCESS"/>

            </DeleteProfileFromContractResponse>

      </soap:Body>

</soap:Envelope>

 

DeleteProfileFromContractResponse

 

<xs:complexType name="DeleteProfileFromContractResponse">

<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

The primary indication of the success or failure of the called function.

 


5 FetchAuthorizedProfiles

Retrieves a list of contracts, given the name, resort, and/or contract identifiers. Contracts of the owner, co-owners, and family/friends are included. Information about the contract type, unit, effective dates, rate plans, and attached profiles is provided.

 

Soap Action: http://webservices.micros.com/ows/5.1/UnitOwners.wsdl#FetchAuthorizedProfiles

FetchAuthorizedProfilesRequest

 

<?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:c="http://webservices.micros.com/og/4.3/Common/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:r="http://webservices.micros.com/og/4.3/Reservation/" xmlns:hc="http://webservices.micros.com/og/4.3/HotelCommon/" xmlns:n="http://webservices.micros.com/og/4.3/Name/">
  <soap:Header>
    <OGHeader transactionID="43986969" primaryLangID="E" timeStamp="2009-03-13T15:48:16.0718750-05: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>
    <FetchAuthorizedProfilesRequest xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">
      <NameId type="INTERNAL">5758088</NameId>
      <Resort chainCode="CHA" hotelCode="RESORT" />
      <ContractId type="INTERNAL">85001</ContractId>
    </FetchAuthorizedProfilesRequest>
  </soap:Body>
</soap:Envelope>

FetchAuthorizedProfilesRequest

 

<xs:complexType name="FetchAuthorizedProfilesRequest">

<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="Resort" xmlns:q2="http://webservices.micros.com/og/4.3/HotelCommon/" type="q2:HotelReference" />

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameId

element

UniqueID

optional

The OPERA NameID for the individual guest.

Resort

element

HotelReference

optional

The resort code.

ContractId

element

UniqueID

optional

The contract ID.

FetchAuthorizedProfilesResponse

 

<?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="43986969" timeStamp="2009-03-13T16:48:16.071875-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/UnitOwners.wsdl#FetchAuthorizedProfilesResponse</wsa:Action>
    <wsa:MessageID>urn:uuid:294c6fd3-e227-4416-9ffe-62503b3e3c45</wsa:MessageID>
    <wsa:RelatesTo>urn:uuid:3ae7f77b-ab08-41f5-a1ff-faa60f49a87e</wsa:RelatesTo>
    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
  </soap:Header>
  <soap:Body>
    <FetchAuthorizedProfilesResponse xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">
      <Result resultStatusFlag="SUCCESS" />
      <Contracts>
        <Contracts xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <ContractId type="EXTERNAL">85001</ContractId>
          <HotelReference hotelCode="HOTEL" />
          <AuthorizedProfiles>
            <RelatedProfiles ContractProfileType="PRIMARYOWNER">
              <ProfileIDs xmlns="http://webservices.micros.com/og/4.3/Name/">
                <UniqueID type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/Common/">5758088</UniqueID>
              </ProfileIDs>
              <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 operaId="5043871">
                  <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>
              <Phones xmlns="http://webservices.micros.com/og/4.3/Name/">
                <NamePhone phoneType="HOME" phoneRole="PHONE" operaId="1111698">
                  <PhoneNumber xmlns="http://webservices.micros.com/og/4.3/Common/">1234567890</PhoneNumber>
                </NamePhone>
              </Phones>
              <EMails xmlns="http://webservices.micros.com/og/4.3/Name/">
                <NameEmail operaId="1111699">name@example.com</NameEmail>
              </EMails>
            </RelatedProfiles>
            <RelatedProfiles ContractProfileType="CO-OWNER">
              <ProfileIDs xmlns="http://webservices.micros.com/og/4.3/Name/">
                <UniqueID type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/Common/">5758089</UniqueID>
              </ProfileIDs>
              <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 operaId="5043872">
                  <AddressLine xmlns="http://webservices.micros.com/og/4.3/Common/">1111 Anytown</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>
              <Phones xmlns="http://webservices.micros.com/og/4.3/Name/">
                <NamePhone phoneType="HOME" phoneRole="PHONE" operaId="1111700">
                  <PhoneNumber xmlns="http://webservices.micros.com/og/4.3/Common/">1234567890</PhoneNumber>
                </NamePhone>
              </Phones>
              <EMails xmlns="http://webservices.micros.com/og/4.3/Name/">
                <NameEmail operaId="1111701">name@example.com</NameEmail>
              </EMails>
            </RelatedProfiles>
            <RelatedProfiles ContractProfileType="FRIENDS_AND_FAMILY" Relationship="FAMILY">
              <ProfileIDs xmlns="http://webservices.micros.com/og/4.3/Name/">
                <UniqueID type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/Common/">5758090</UniqueID>
              </ProfileIDs>
              <Customer xmlns="http://webservices.micros.com/og/4.3/Name/">
                <PersonName>
                  <firstName xmlns="http://webservices.micros.com/og/4.3/Common/">Jane</firstName>
                  <lastName xmlns="http://webservices.micros.com/og/4.3/Common/">Smith</lastName>
                </PersonName>
              </Customer>
            </RelatedProfiles>
            <RelatedProfiles ContractProfileType="FRIENDS_AND_FAMILY" Relationship="FRIEND">
              <ProfileIDs xmlns="http://webservices.micros.com/og/4.3/Name/">
                <UniqueID type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/Common/">5758091</UniqueID>
              </ProfileIDs>
              <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>
            </RelatedProfiles>
          </AuthorizedProfiles>
        </Contracts>
      </Contracts>
    </FetchAuthorizedProfilesResponse>
  </soap:Body>
</soap:Envelope>

 

FetchAuthorizedProfilesResponse

 

<xs:complexType name="FetchAuthorizedProfilesResponse">

<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="Contracts" xmlns:q2="http://webservices.micros.com/og/4.3/UnitOwners/" type="q2:ArrayOfUnitContract" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

The primary indication of the success or failure of the called function.

Contracts

element

ArrayOfUnitContract

optional

A collection of UnitContract elements.

 


 

6 FetchContract

Retrieves a contract, given at least the name identifier. The resort and contract identifiers and the requestor role (primary-owner, co-owner, or friends-and-family) are also allowed, and are returned. Information about the contract type, unit, effective dates, rate plans, and attached profiles is provided.

 

Soap Action: http://webservices.micros.com/ows/5.1/UnitOwners.wsdl#FetchContract

FetchContractsRequest

 

<?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:c="http://webservices.micros.com/og/4.3/Common/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:r="http://webservices.micros.com/og/4.3/Reservation/" xmlns:hc="http://webservices.micros.com/og/4.3/HotelCommon/" xmlns:n="http://webservices.micros.com/og/4.3/Name/">

  <soap:Header>

    <OGHeader transactionID="709823549760" primaryLangID="E" timeStamp="2009-03-13T14:48:16.0718750-05:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

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

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

    </OGHeader>

  </soap:Header>

  <soap:Body>

    <FetchContractsRequest xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">

      <NameId type="INTERNAL">2517582</NameId>

      <Resort>RESORT</Resort>

      <RequesterRole>PRIMARYOWNER</RequesterRole>

    </FetchContractsRequest>

  </soap:Body>

</soap:Envelope>

 

FetchContractsRequest

 

<xs:complexType name="FetchContractsRequest">

<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="Resort" type="xs:string" />

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

<xs:element minOccurs="0" maxOccurs="1" name="RequesterRole" xmlns:q3="http://webservices.micros.com/og/4.3/UnitOwners/" type="q3:ContractProfileType" />

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

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

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

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

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameId

element

UniqueID

optional

The internal OPERA NameID.

Resort

element

string

optional

The resort code.

ContractId

element

UniqueID

optional

The contract ID.

RequesterRole

element

ContractProfileType

optional

The role of the requester, such as Owner or Friends and Family.

BeginDate

element

date

optional

The begin date.

RoomType

element

string

optional

The room type.

RoomNo

element

string

optional

The room number.

Status

element

string

optional

The status.

RevenuePool

element

string

optional

The revenue pool.

OnlyRental

element

boolean

optional

The only rental.

 

FetchContractsResponse

 

<?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="709823549760" timeStamp="2009-03-13T15:48:16.071875-04:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

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

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

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

    <wsa:MessageID>urn:uuid:479af22a-eba7-43e2-a2d9-3564537bdfbd</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:c132beb0-6a99-4373-bc23-ac15b1f2017f</wsa:RelatesTo>

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

  </soap:Header>

  <soap:Body>

    <FetchContractsResponse xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">

      <Result resultStatusFlag="SUCCESS" />

      <Contracts>

        <Contracts xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">

          <ContractId type="EXTERNAL">1001</ContractId>

          <HotelReference hotelCode="HOTEL" />

          <ContractNumber>9</ContractNumber>

          <Unit>

            <RoomNumber xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">99400</RoomNumber>

            <RoomType roomTypeCode="MLST" xmlns="http://webservices.micros.com/og/4.3/HotelCommon/" />

          </Unit>

          <PrimaryOwner>

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

              <UniqueID type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/Common/">2517582</UniqueID>

            </ProfileIDs>

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

              <PersonName>

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

              </PersonName>

            </Customer>

          </PrimaryOwner>

          <ContractType>U</ContractType>

        </Contracts>

      </Contracts>

    </FetchContractsResponse>

  </soap:Body>

</soap:Envelope>

 

FetchContractsResponse

 

<xs:complexType name="FetchContractsResponse">

<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="Contracts" xmlns:q2="http://webservices.micros.com/og/4.3/UnitOwners/" type="q2:ArrayOfUnitContract" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

The primary indication of the success or failure of the called function.

Contracts

element

ArrayOfUnitContract

optional

A collection of UnitContract elements.


7 FetchContractDetails

Retrieves details of a contract, given the name and resort identifiers. The contract identifier is also allowed and is returned. Information includes financial arrangements, restrictions, contract documents, and insurance policies in addition to information about the contract type, unit, effective dates, rate plans, and attached profiles.

 

Soap Action: http://webservices.micros.com/ows/5.1/UnitOwners.wsdl#FetchContractDetails

FetchContractDetailsRequest

 

<?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:c="http://webservices.micros.com/og/4.3/Common/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:r="http://webservices.micros.com/og/4.3/Reservation/" xmlns:hc="http://webservices.micros.com/og/4.3/HotelCommon/" xmlns:n="http://webservices.micros.com/og/4.3/Name/">
  <soap:Header>
    <OGHeader transactionID="32868696" primaryLangID="E" timeStamp="2009-03-13T14:48:16.0718750-05: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>
    <FetchContractDetailsRequest xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">
      <NameId type="INTERNAL">5758088</NameId>
      <ContractId type="INTERNAL">85001</ContractId>
      <Resort>RESORT</Resort>
    </FetchContractDetailsRequest>
  </soap:Body>
</soap:Envelope>

 

FetchContractDetailsRequest

 

<xs:complexType name="FetchContractDetailsRequest">

<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="ContractId" xmlns:q2="http://webservices.micros.com/og/4.3/Common/" type="q2:UniqueID" />

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameId

element

UniqueID

optional

The internal OPERA NameID.

ContractId

element

UniqueID

optional

The contract number.

Resort

element

string

optional

The resort ID.

 

FetchContractDetailsResponse

 

<?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="32868696" timeStamp="2009-03-13T15:48:16.071875-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/UnitOwners.wsdl#FetchContractDetailsResponse</wsa:Action>
    <wsa:MessageID>urn:uuid:7042486e-de7a-45c5-b269-df4b4b231610</wsa:MessageID>
    <wsa:RelatesTo>urn:uuid:eac9ddd0-29fe-4444-a6fc-ddaa9f0dd82a</wsa:RelatesTo>
    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
  </soap:Header>
  <soap:Body>
    <FetchContractDetailsResponse xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">
      <Result resultStatusFlag="SUCCESS" />
      <Contracts>
        <ContractId type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">85001</ContractId>
        <HotelReference hotelCode="HOTEL" xmlns="http://webservices.micros.com/og/4.3/UnitOwners/" />
        <ContractNumber xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">58</ContractNumber>
        <Unit xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <RoomNumber xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">102</RoomNumber>
          <RoomType roomTypeCode="10084" xmlns="http://webservices.micros.com/og/4.3/HotelCommon/" />
        </Unit>
        <ValidDates xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2013-07-21T00:00:00</StartDate>
          <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2020-12-31T00:00:00</EndDate>
        </ValidDates>
        <PrimaryOwner taxId="342385675" primary="true" changeUnit="false" revenuePercentage="80" include1099="false" xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <ProfileIDs xmlns="http://webservices.micros.com/og/4.3/Name/">
            <UniqueID type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/Common/">5758088</UniqueID>
          </ProfileIDs>
          <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>
        </PrimaryOwner>
        <AuthorizedProfiles xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <RelatedProfiles ContractProfileType="PRIMARYOWNER" taxId="342385675" primary="true" changeUnit="false" revenuePercentage="80" include1099="false" CommissionPercentage="100" recordId="110501" systemStatus="QUERIED">
            <ProfileIDs xmlns="http://webservices.micros.com/og/4.3/Name/">
              <UniqueID type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/Common/">5758088</UniqueID>
            </ProfileIDs>
            <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 operaId="5043871">
                <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>
            <Phones xmlns="http://webservices.micros.com/og/4.3/Name/">
              <NamePhone phoneType="HOME" phoneRole="PHONE" operaId="1111698">
                <PhoneNumber xmlns="http://webservices.micros.com/og/4.3/Common/">1234567890</PhoneNumber>
              </NamePhone>
            </Phones>
            <EMails xmlns="http://webservices.micros.com/og/4.3/Name/">
              <NameEmail operaId="1111699">name@example.com</NameEmail>
            </EMails>
          </RelatedProfiles>
          <RelatedProfiles ContractProfileType="CO-OWNER" primary="true" changeUnit="false" revenuePercentage="20" include1099="false" generalExciseTax="false" transientAccommodationTax="false" recordId="110502" systemStatus="QUERIED">
            <ProfileIDs xmlns="http://webservices.micros.com/og/4.3/Name/">
              <UniqueID type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/Common/">5758089</UniqueID>
            </ProfileIDs>
            <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 operaId="5043872">
                <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>
            <Phones xmlns="http://webservices.micros.com/og/4.3/Name/">
              <NamePhone phoneType="HOME" phoneRole="PHONE" operaId="1111700">
                <PhoneNumber xmlns="http://webservices.micros.com/og/4.3/Common/">1234567890</PhoneNumber>
              </NamePhone>
            </Phones>
            <EMails xmlns="http://webservices.micros.com/og/4.3/Name/">
              <NameEmail operaId="1111701">name@example.com</NameEmail>
            </EMails>
          </RelatedProfiles>
          <RelatedProfiles ContractProfileType="FRIENDS_AND_FAMILY" Relationship="FAMILY" primary="true" changeUnit="false" include1099="false" generalExciseTax="false" transientAccommodationTax="false" recordId="110503" systemStatus="QUERIED">
            <ProfileIDs xmlns="http://webservices.micros.com/og/4.3/Name/">
              <UniqueID type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/Common/">5758090</UniqueID>
            </ProfileIDs>
            <Customer xmlns="http://webservices.micros.com/og/4.3/Name/">
              <PersonName>
                <firstName xmlns="http://webservices.micros.com/og/4.3/Common/">Jane</firstName>
                <lastName xmlns="http://webservices.micros.com/og/4.3/Common/">Smith</lastName>
              </PersonName>
            </Customer>
          </RelatedProfiles>
          <RelatedProfiles ContractProfileType="FRIENDS_AND_FAMILY" Relationship="FRIEND" primary="true" changeUnit="false" include1099="false" generalExciseTax="false" transientAccommodationTax="false" recordId="110504" systemStatus="QUERIED">
            <ProfileIDs xmlns="http://webservices.micros.com/og/4.3/Name/">
              <UniqueID type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/Common/">5758091</UniqueID>
            </ProfileIDs>
            <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>
          </RelatedProfiles>
        </AuthorizedProfiles>
        <ContractType xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">U</ContractType>
        <RentalProgram xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">true</RentalProgram>
        <Status xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">Negotiated</Status>
        <TemplateCode xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">2</TemplateCode>
        <ModifiedUnit xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">false</ModifiedUnit>
        <Restrictions xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <Restriction>
            <RecordId>51001</RecordId>
            <RestrictionType>AF</RestrictionType>
            <Dates>
              <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2006-10-21T00:00:00</StartDate>
              <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2006-10-24T00:00:00</EndDate>
            </Dates>
            <MaximumNights>2</MaximumNights>
            <UsedNights>0</UsedNights>
            <Day1>Y</Day1>
            <Day2>Y</Day2>
            <Day3>Y</Day3>
            <Day4>Y</Day4>
            <Day5>Y</Day5>
            <Day6>Y</Day6>
            <Day7>Y</Day7>
            <SystemStatus>QUERIED</SystemStatus>
            <CompNights>2</CompNights>
          </Restriction>
          <Restriction>
            <RecordId>51002</RecordId>
            <RestrictionType>MR</RestrictionType>
            <Dates>
              <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2007-07-20T00:00:00</StartDate>
              <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2007-07-24T00:00:00</EndDate>
            </Dates>
            <MaximumNights>0</MaximumNights>
            <MinimumRate>200</MinimumRate>
            <UsedNights>0</UsedNights>
            <Day1>Y</Day1>
            <Day2>Y</Day2>
            <Day3>Y</Day3>
            <Day4>Y</Day4>
            <Day5>Y</Day5>
            <Day6>Y</Day6>
            <Day7>Y</Day7>
            <SystemStatus>QUERIED</SystemStatus>
            <CompNights>0</CompNights>
          </Restriction>
          <Restriction>
            <RecordId>51003</RecordId>
            <RestrictionType>CN</RestrictionType>
            <Dates>
              <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2008-07-20T00:00:00</StartDate>
              <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2008-07-28T00:00:00</EndDate>
            </Dates>
            <MaximumNights>3</MaximumNights>
            <UsedNights>1</UsedNights>
            <Day1>Y</Day1>
            <Day2>Y</Day2>
            <Day3>Y</Day3>
            <Day4>Y</Day4>
            <Day5>Y</Day5>
            <Day6>Y</Day6>
            <Day7>Y</Day7>
            <SystemStatus>QUERIED</SystemStatus>
            <CompNights>3</CompNights>
          </Restriction>
          <Restriction>
            <RecordId>51004</RecordId>
            <RestrictionType>PC</RestrictionType>
            <Dates>
              <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2009-07-20T00:00:00</StartDate>
              <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2009-07-27T00:00:00</EndDate>
            </Dates>
            <MaximumNights>0</MaximumNights>
            <UsedNights>0</UsedNights>
            <Day1>Y</Day1>
            <Day2>Y</Day2>
            <Day3>Y</Day3>
            <Day4>Y</Day4>
            <Day5>Y</Day5>
            <Day6>Y</Day6>
            <Day7>Y</Day7>
            <SystemStatus>QUERIED</SystemStatus>
            <CompNights>0</CompNights>
            <OwnerMaximum>2</OwnerMaximum>
            <AuthMaximum>0</AuthMaximum>
            <Rate>100</Rate>
          </Restriction>
        </Restrictions>
        <RentalContracts xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <RentalContract>
            <RecordId>66501</RecordId>
            <Dates>
              <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2006-07-21T00:00:00</StartDate>
              <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2020-07-20T00:00:00</EndDate>
            </Dates>
            <OwnerRevenueShare>100</OwnerRevenueShare>
            <RevenueShareFormula>N</RevenueShareFormula>
            <CommByOwner>10</CommByOwner>
            <AutoRenewalDate>2020-07-20</AutoRenewalDate>
            <AutoRenewalMonths>12</AutoRenewalMonths>
            <ResvMaxNights>0</ResvMaxNights>
            <LongTerm>false</LongTerm>
            <SystemStatus>QUERIED</SystemStatus>
            <GraceMonths>2</GraceMonths>
            <RevenuePool>TESTPOOL</RevenuePool>
          </RentalContract>
        </RentalContracts>
        <Deductions xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <Deduction>
            <RecordId>30001</RecordId>
            <DeductionCode>MARKETING</DeductionCode>
            <Rule>A</Rule>
            <Amount>20</Amount>
            <Formula>F</Formula>
            <Sequence>1</Sequence>
            <SystemStatus>QUERIED</SystemStatus>
          </Deduction>
        </Deductions>
        <Fees xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <Fee>
            <RecordId>50251</RecordId>
            <FeeCode>TRANSPORT</FeeCode>
            <Frequency>W</Frequency>
            <Amount>10</Amount>
            <TransactionCode>2170</TransactionCode>
            <AutoPost>Y</AutoPost>
            <PostTo>O</PostTo>
            <OccupiedBy>A</OccupiedBy>
            <SystemStatus>QUERIED</SystemStatus>
          </Fee>
        </Fees>
        <Tasks xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <Task>
            <RecordId>41251</RecordId>
            <TaskCode>CARPET</TaskCode>
            <Amount>10</Amount>
            <TaskRhythm>D</TaskRhythm>
            <TransactionCode>2100</TransactionCode>
            <PostTo>O</PostTo>
            <OccupiedBy>A</OccupiedBy>
            <SystemStatus>QUERIED</SystemStatus>
          </Task>
        </Tasks>
        <ContractDocuments xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <ContractDocument>
            <RecordId>8501</RecordId>
            <DocumentType>CONTRACT</DocumentType>
            <Description>
              <Text xmlns="http://webservices.micros.com/og/4.3/Common/">
                <TextElement>rental contract</TextElement>
              </Text>
            </Description>
            <DateReceived>2006-07-21</DateReceived>
            <SystemStatus>QUERIED</SystemStatus>
          </ContractDocument>
        </ContractDocuments>
        <Miscellaneous xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
          <ContractDate>2006-07-21</ContractDate>
          <EstimatedClosingDate>2007-07-20</EstimatedClosingDate>
          <RealEstateAgent>My Real Estate Agent</RealEstateAgent>
          <SalesAssociate>My Sales Associate</SalesAssociate>
          <PurchasePrice>200000</PurchasePrice>
          <Comments>this is a test comment</Comments>
        </Miscellaneous>
      </Contracts>
    </FetchContractDetailsResponse>
  </soap:Body>
</soap:Envelope>

 

FetchContractDetailsResponse

 

<xs:complexType name="FetchContractDetailsResponse">

<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="Contracts" xmlns:q2="http://webservices.micros.com/og/4.3/UnitOwners/" type="q2:UnitContractDetails" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

The primary indication of the success or failure of the called function.

Contracts

element

UnitContractDetails

optional

The contract details.

 

 


 

8 OVOS_DEDUCTION_CODES

OVOS_DEDUCTION_CODES Request

<?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 primaryLangID="EN" timeStamp="2012-11-27T10:28:16.783-05:00" transactionID="615f53e7-c3d0-4b53-9974-d79f8208c883" channelValidation="true" xmlns="http://webservices.micros.com/og/4.3/Core/">
      <Origin entityID="OWS" systemType="WEB" />
      <Destination entityID="PMS" systemType="PMS" />
    </OGHeader>
  </soap:Header>
  <soap:Body>
    <LovRequest xmlns="http://webservices.micros.com/ows/5.1/Information.wsdl">
      <LovQuery2>
        <LovIdentifier>OVOS_DEDUCTION_CODES</LovIdentifier>
        <LovQueryQualifier qualifierType="HOST">WEST</LovQueryQualifier>
        <LovQueryQualifier qualifierType="RESORT">RESORT</LovQueryQualifier>
      </LovQuery2>
    </LovRequest>
  </soap:Body>
</soap:Envelope>

 

OVOS_DEDUCTION_CODES Response

<?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="615f53e7-c3d0-4b53-9974-d79f8208c883" timeStamp="2012-11-27T10:28:16.783-05:00" primaryLangID="EN" channelValidation="true" xmlns="http://webservices.micros.com/og/4.3/Core/">
      <Origin entityID="PMS" systemType="PMS" />
      <Destination entityID="OWS" systemType="WEB" />
    </OGHeader>
    <wsa:Action>http://webservices.micros.com/ows/5.1/Information.wsdl#QueryLovResponse</wsa:Action>
    <wsa:MessageID>urn:uuid:5cd3f92e-4a0b-4927-b58a-7382fd03a495</wsa:MessageID>
    <wsa:RelatesTo>urn:uuid:7f6fac0a-c8c0-48c7-bf2e-9cb5e972f7fa</wsa:RelatesTo>
    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
  </soap:Header>
  <soap:Body>
    <LovResponse xmlns:c="http://webservices.micros.com/og/4.3/Core/" xmlns:hc="http://webservices.micros.com/og/4.3/HotelCommon/" xmlns="http://webservices.micros.com/ows/5.1/Information.wsdl">
      <Result resultStatusFlag="SUCCESS" />
      <LovQueryResult>
        <LovValue description="Deduction 1">DED 1</LovValue>
        <LovValue description="Deduction 2">DED 2</LovValue>
      </LovQueryResult>
    </LovResponse>
  </soap:Body>
</soap:Envelope>

 

OVOS_DOCUMENT_TYPES Request

<?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 primaryLangID="EN" timeStamp="2012-11-27T10:28:16.783-05:00" transactionID="615f53e7-c3d0-4b53-9974-d79f8208c883" channelValidation="true" xmlns="http://webservices.micros.com/og/4.3/Core/">
      <Origin entityID="OWS" systemType="WEB" />
      <Destination entityID="PMS" systemType="PMS" />
    </OGHeader>
  </soap:Header>
  <soap:Body>
    <LovRequest xmlns="http://webservices.micros.com/ows/5.1/Information.wsdl">
      <LovQuery2>
        <LovIdentifier>OVOS_DOCUMENT_TYPES</LovIdentifier>
        <LovQueryQualifier qualifierType="HOST">WEST</LovQueryQualifier>
        <LovQueryQualifier qualifierType="RESORT">RESORT</LovQueryQualifier>
      </LovQuery2>
    </LovRequest>
  </soap:Body>
</soap:Envelope>

 

OVOS_DOCUMENT_TYPES Response

<?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="615f53e7-c3d0-4b53-9974-d79f8208c883" timeStamp="2012-11-27T10:28:16.783-05:00" primaryLangID="EN" channelValidation="true" xmlns="http://webservices.micros.com/og/4.3/Core/">
      <Origin entityID="PMS" systemType="PMS" />
      <Destination entityID="OWS" systemType="WEB" />
    </OGHeader>
    <wsa:Action>http://webservices.micros.com/ows/5.1/Information.wsdl#QueryLovResponse</wsa:Action>
    <wsa:MessageID>urn:uuid:f33fc8f1-b95f-4634-9316-d22bd4bd01f5</wsa:MessageID>
    <wsa:RelatesTo>urn:uuid:b3a4383a-c73d-4a45-bee5-f2b35f84d00c</wsa:RelatesTo>
    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
  </soap:Header>
  <soap:Body>
    <LovResponse xmlns:c="http://webservices.micros.com/og/4.3/Core/" xmlns:hc="http://webservices.micros.com/og/4.3/HotelCommon/" xmlns="http://webservices.micros.com/ows/5.1/Information.wsdl">
      <Result resultStatusFlag="SUCCESS" />
      <LovQueryResult>
        <LovValue description="By Laws">BYLAW</LovValue>
        <LovValue description="Document 1">DOC1</LovValue>
      </LovQueryResult>
    </LovResponse>
  </soap:Body>
</soap:Envelope>

OVOS_INSURANCE_TYPES Request

<?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 primaryLangID="EN" timeStamp="2012-11-27T10:28:16.783-05:00" transactionID="615f53e7-c3d0-4b53-9974-d79f8208c883" channelValidation="true" xmlns="http://webservices.micros.com/og/4.3/Core/">
      <Origin entityID="OWS" systemType="WEB" />
      <Destination entityID="PMS" systemType="PMS" />
    </OGHeader>
  </soap:Header>
  <soap:Body>
    <LovRequest xmlns="http://webservices.micros.com/ows/5.1/Information.wsdl">
      <LovQuery2>
        <LovIdentifier>OVOS_INSURANCE_TYPES</LovIdentifier>
        <LovQueryQualifier qualifierType="HOST">WEST</LovQueryQualifier>
        <LovQueryQualifier qualifierType="RESORT">RESORT</LovQueryQualifier>
      </LovQuery2>
    </LovRequest>
  </soap:Body>
</soap:Envelope>

OVOS_INSURANCE_TYPES Response

<?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="615f53e7-c3d0-4b53-9974-d79f8208c883" timeStamp="2012-11-27T10:28:16.783-05:00" primaryLangID="EN" channelValidation="true" xmlns="http://webservices.micros.com/og/4.3/Core/">
      <Origin entityID="PMS" systemType="PMS" />
      <Destination entityID="OWS" systemType="WEB" />
    </OGHeader>
    <wsa:Action>http://webservices.micros.com/ows/5.1/Information.wsdl#QueryLovResponse</wsa:Action>
    <wsa:MessageID>urn:uuid:01cc93c0-0a94-459a-a6b2-41f3d4e82b44</wsa:MessageID>
    <wsa:RelatesTo>urn:uuid:f9a30e8f-bac7-4430-9d01-1dc4234e6f21</wsa:RelatesTo>
    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
  </soap:Header>
  <soap:Body>
    <LovResponse xmlns:c="http://webservices.micros.com/og/4.3/Core/" xmlns:hc="http://webservices.micros.com/og/4.3/HotelCommon/" xmlns="http://webservices.micros.com/ows/5.1/Information.wsdl">
      <Result resultStatusFlag="SUCCESS" />
      <LovQueryResult>
        <LovValue description="Insurance 1">INS1</LovValue>
        <LovValue description="Home Owners Insurance">HOME</LovValue>
      </LovQueryResult>
    </LovResponse>
  </soap:Body>
</soap:Envelope>

 

OVOS_REVENUE_POOLS Request

<?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 primaryLangID="EN" timeStamp="2012-11-27T10:28:16.783-05:00" transactionID="615f53e7-c3d0-4b53-9974-d79f8208c883" channelValidation="true" xmlns="http://webservices.micros.com/og/4.3/Core/">
      <Origin entityID="OWS" systemType="WEB" />
      <Destination entityID="PMS" systemType="PMS" />
    </OGHeader>
  </soap:Header>
  <soap:Body>
    <LovRequest xmlns="http://webservices.micros.com/ows/5.1/Information.wsdl">
      <LovQuery2>
        <LovIdentifier>OVOS_REVENUE_POOLS</LovIdentifier>
        <LovQueryQualifier qualifierType="HOST">WEST</LovQueryQualifier>
        <LovQueryQualifier qualifierType="RESORT">RESORT</LovQueryQualifier>
      </LovQuery2>
    </LovRequest>
  </soap:Body>
</soap:Envelope>

 

OVOS_REVENUE_POOLS Response

<?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="615f53e7-c3d0-4b53-9974-d79f8208c883" timeStamp="2012-11-27T10:28:16.783-05:00" primaryLangID="EN" channelValidation="true" xmlns="http://webservices.micros.com/og/4.3/Core/">
      <Origin entityID="PMS" systemType="PMS" />
      <Destination entityID="OWS" systemType="WEB" />
    </OGHeader>
    <wsa:Action>http://webservices.micros.com/ows/5.1/Information.wsdl#QueryLovResponse</wsa:Action>
    <wsa:MessageID>urn:uuid:b2686c3f-d7a8-4981-b104-176d35644b7b</wsa:MessageID>
    <wsa:RelatesTo>urn:uuid:01e3c820-d556-4016-a7fe-7352a7737d35</wsa:RelatesTo>
    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
  </soap:Header>
  <soap:Body>
    <LovResponse xmlns:c="http://webservices.micros.com/og/4.3/Core/" xmlns:hc="http://webservices.micros.com/og/4.3/HotelCommon/" xmlns="http://webservices.micros.com/ows/5.1/Information.wsdl">
      <Result resultStatusFlag="SUCCESS" />
      <LovQueryResult>
        <LovValue description="Value1">VALUE1</LovValue>
        <LovValue description="VIC">VIC</LovValue>
      </LovQueryResult>
    </LovResponse>
  </soap:Body>
</soap:Envelope>

OVOS_TRX_CODES Request

<?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 primaryLangID="EN" timeStamp="2012-11-27T10:28:16.783-05:00" transactionID="615f53e7-c3d0-4b53-9974-d79f8208c883" channelValidation="true" xmlns="http://webservices.micros.com/og/4.3/Core/">
      <Origin entityID="OWS" systemType="WEB" />
      <Destination entityID="PMS" systemType="PMS" />
    </OGHeader>
  </soap:Header>
  <soap:Body>
    <LovRequest xmlns="http://webservices.micros.com/ows/5.1/Information.wsdl">
      <LovQuery2>
        <LovIdentifier>OVOS_TRX_CODES</LovIdentifier>
        <LovQueryQualifier qualifierType="HOST">WEST</LovQueryQualifier>
        <LovQueryQualifier qualifierType="RESORT">RESORT</LovQueryQualifier>
      </LovQuery2>
    </LovRequest>
  </soap:Body>
</soap:Envelope>

 

OVOS_TRX_CODES Response

<?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="615f53e7-c3d0-4b53-9974-d79f8208c883" timeStamp="2012-11-27T10:28:16.783-05:00" primaryLangID="EN" channelValidation="true" xmlns="http://webservices.micros.com/og/4.3/Core/">
      <Origin entityID="PMS" systemType="PMS" />
      <Destination entityID="OWS" systemType="WEB" />
    </OGHeader>
    <wsa:Action>http://webservices.micros.com/ows/5.1/Information.wsdl#QueryLovResponse</wsa:Action>
    <wsa:MessageID>urn:uuid:cadc2783-6435-4f15-a4d0-7b37f3e22234</wsa:MessageID>
    <wsa:RelatesTo>urn:uuid:c7d0fffd-4a46-4e42-aa37-1fe8de28bc4a</wsa:RelatesTo>
    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
  </soap:Header>
  <soap:Body>
    <LovResponse xmlns:c="http://webservices.micros.com/og/4.3/Core/" xmlns:hc="http://webservices.micros.com/og/4.3/HotelCommon/" xmlns="http://webservices.micros.com/ows/5.1/Information.wsdl">
      <Result resultStatusFlag="SUCCESS" />
      <LovQueryResult qualifierType="DEFAULT_PRICE" qualifierValue="26">
        <LovValue description="Breakfast inc">1002</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE">
        <LovValue description="Dinner AP">1003</LovValue>
        <LovValue description="UDF LuxuryTax_on_published_rate">1004</LovValue>
        <LovValue description="New trx for BE">1006</LovValue>
        <LovValue description="Hotel Lodging with GET Tax">1008</LovValue>
        <LovValue description="Room">1009</LovValue>
        <LovValue description="Group Room Revenue">1010</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE" qualifierValue="5">
        <LovValue description="Room Fee">1011</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE">
        <LovValue description="Room">10111</LovValue>
        <LovValue description="Food">10112</LovValue>
        <LovValue description="Package">10113</LovValue>
        <LovValue description="Pkg Allott">10114</LovValue>
        <LovValue description="AR Finance Charge">1012</LovValue>
        <LovValue description="Group Room Revenue - Leisure">1015</LovValue>
        <LovValue description="Mirjamtestgenerates">1016</LovValue>
        <LovValue description="Extra - Room Charge">1018</LovValue>
        <LovValue description="Room Charge">1020</LovValue>
        <LovValue description="SCR 136563">1021</LovValue>
        <LovValue description="SCR 136563 -2">1022</LovValue>
        <LovValue description="Room Charge Test">1025</LovValue>
        <LovValue description="Test">1026</LovValue>
        <LovValue description="Adj Test">1027</LovValue>
        <LovValue description="Lodging">1030</LovValue>
        <LovValue description="Room Charge with City tax">1031</LovValue>
        <LovValue description="City tax inclusive">1032</LovValue>
        <LovValue description="City tax with Tax Type">1033</LovValue>
        <LovValue description="ADJ - Transient Room Revenue">1050</LovValue>
        <LovValue description="my test3">1099</LovValue>
        <LovValue description="Transient No Show Revenue">1100</LovValue>
        <LovValue description="Room Charge">1110</LovValue>
        <LovValue description="Adj- Room Charge">11101</LovValue>
        <LovValue description="Deutscher Transaktions code">1111</LovValue>
        <LovValue description="Multiple Trx codes for rate header">11223</LovValue>
        <LovValue description="ADJ - Transient No Show Revenue">1150</LovValue>
        <LovValue description="Levy">1151</LovValue>
        <LovValue description="Group Room Revenue">1200</LovValue>
        <LovValue description="Inclusive Room Revenue">1210</LovValue>
        <LovValue description="Accomm with tax type">1215</LovValue>
        <LovValue description="123123123">123123123</LovValue>
        <LovValue description="123123123001">123123123001</LovValue>
        <LovValue description="Test">1233</LovValue>
        <LovValue description="Test">1234</LovValue>
        <LovValue description="ADJ - Group Room Revenue">1250</LovValue>
        <LovValue description="ADJ - Inclusive Room Revenue">1260</LovValue>
        <LovValue description="Resort Fee">1270</LovValue>
        <LovValue description="Resort Fee Tax">1271</LovValue>
        <LovValue description="Room Charge">1273</LovValue>
        <LovValue description="Group No Show Revenue">1300</LovValue>
        <LovValue description="ADJ - Group No Show Revenue">1350</LovValue>
        <LovValue description="Room Revenue">1500</LovValue>
        <LovValue description="ADJ -Room Revenue">1505</LovValue>
        <LovValue description="State Tax - 10%">1510</LovValue>
        <LovValue description="ADJ - State Tax - 10%">1515</LovValue>
        <LovValue description="City Tax - 5%">1520</LovValue>
        <LovValue description="ADJ - City Tax - 5%">1525</LovValue>
        <LovValue description="O - Room Charge">1600</LovValue>
        <LovValue description="O - Food">1601</LovValue>
        <LovValue description="O - Beverage">1602</LovValue>
        <LovValue description="O - Park Tickets">1603</LovValue>
        <LovValue description="O - Golf Course View">1604</LovValue>
        <LovValue description="O - Green Fees">1605</LovValue>
        <LovValue description="O - Parking Space">1606</LovValue>
        <LovValue description="O - Misc">1609</LovValue>
        <LovValue description="O - Fee 1">1700</LovValue>
        <LovValue description="O - Fee 2">1701</LovValue>
        <LovValue description="O - Fee 3">1702</LovValue>
        <LovValue description="O - Fee 4">1703</LovValue>
        <LovValue description="O - Fee 5">1704</LovValue>
        <LovValue description="O - Fee 6">1705</LovValue>
        <LovValue description="O - Deduction 1">1800</LovValue>
        <LovValue description="Example">1805</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE" qualifierValue="50">
        <LovValue description="O - Housekeeping 1">1850</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE">
        <LovValue description="Test BOF">19910</LovValue>
        <LovValue description="Lobby Bar Food">2000</LovValue>
        <LovValue description="Lobby Bar Food Tax type">2001</LovValue>
        <LovValue description="rollaway bed">2002</LovValue>
        <LovValue description="Lobby Bar Beverage">2010</LovValue>
        <LovValue description="Lobby Bar Miscellaneous">2020</LovValue>
        <LovValue description="Excl with 0%">2021</LovValue>
        <LovValue description="Incl With 0%">2022</LovValue>
        <LovValue description="Lobby Bar Gratuity">2030</LovValue>
        <LovValue description="ADJ - Lobby Bar Food">2050</LovValue>
        <LovValue description="ADJ - Lobby Bar Beverage">2060</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE" qualifierValue="0">
        <LovValue description="Internet Connection">2064</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE">
        <LovValue description="Brunch Charge">2065</LovValue>
        <LovValue description="PROFITTO">2068</LovValue>
        <LovValue description="LOSSO">2069</LovValue>
        <LovValue description="ADJ - Lobby Bar Miscellaneous">2070</LovValue>
        <LovValue description="Pet Care">2075</LovValue>
        <LovValue description="ADJ - Lobby Bar Gratuity">2080</LovValue>
        <LovValue description="Bistro - Food">2090</LovValue>
        <LovValue description="Bistro Beverage">2094</LovValue>
        <LovValue description="Room Service Food extra long description testing for the transaction code attach">2100</LovValue>
        <LovValue description="HOTEL Breakfast">2101</LovValue>
        <LovValue description="HOTEL Off Set package">2102</LovValue>
        <LovValue description="Room Service Beverage">2110</LovValue>
        <LovValue description="Normal trx code">211111112</LovValue>
        <LovValue description="Room Service Delivery">2120</LovValue>
        <LovValue description="Room Service Gratuity">2130</LovValue>
        <LovValue description="ADJ - Room Service Food">2150</LovValue>
        <LovValue description="ADJ - Room Service Beverage">2160</LovValue>
        <LovValue description="ADJ - Room Service Delivery">2170</LovValue>
        <LovValue description="ADJ - Room Service Gratuity">2180</LovValue>
        <LovValue description="Restaurant Food">2200</LovValue>
        <LovValue description="Restaurant Beverage">2210</LovValue>
        <LovValue description="IFC Restaurant Charge">2215</LovValue>
        <LovValue description="Restaurant Gratuity">2220</LovValue>
        <LovValue description="ADJ - Restaurant Food">2250</LovValue>
        <LovValue description="ADJ- Restaurant Beverage">2260</LovValue>
        <LovValue description="ADJ - Restaurant Gratuity">2270</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE" qualifierValue="12.25">
        <LovValue description="Minibar - Food">2300</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE">
        <LovValue description="Minibar - Beverage">2310</LovValue>
        <LovValue description="Minibar - Miscellaneous">2320</LovValue>
        <LovValue description="ADJ - Minibar Food">2350</LovValue>
        <LovValue description="ADJ - Minibar Beverage">2360</LovValue>
        <LovValue description="ADJ - Minibar Miscellaneous">2370</LovValue>
        <LovValue description="SCR 156804 Trx 1">2400</LovValue>
        <LovValue description="SCR 156804 Trx 2">2407</LovValue>
        <LovValue description="SCR 156804 Tax">2409</LovValue>
        <LovValue description="Banquet Food &amp; Beverage">2500</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE" qualifierValue="450">
        <LovValue description="Banquet Entertainment">2510</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE" qualifierValue="2">
        <LovValue description="Banquet Audio Visual">2520</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE">
        <LovValue description="Banquet Room Rental">2530</LovValue>
        <LovValue description="ADJ - Banquet Charges">2550</LovValue>

        <LovValue description="For Included in Rate Package">2600</LovValue>
        <LovValue description="Breakfast for Package">2601</LovValue>
        <LovValue description="Food For Package alternate">2602</LovValue>
        <LovValue description="Package Incl tax food">2605</LovValue>
        <LovValue description="For Combined Line Package">2700</LovValue>
        <LovValue description="SCR 144700_2">2710</LovValue>
        <LovValue description="For Separate Line Package">2800</LovValue>
        <LovValue description="SCR 149429_alt1">2801</LovValue>
        <LovValue description="SCR 149429_alt2">2802</LovValue>
        <LovValue description="Custom Rhythm - Night trx code">2850</LovValue>
        <LovValue description="For Floating Allowance Package">2900</LovValue>
        <LovValue description="Frank Example">2999</LovValue>
        <LovValue description="For Next Day Package">3000</LovValue>
        <LovValue description="Copies">3010</LovValue>
        <LovValue description="Shipping">3020</LovValue>
        <LovValue description="Secretarial Services">3030</LovValue>
        <LovValue description="ADJ - Business Center">3050</LovValue>
        <LovValue description="Other 1">3098</LovValue>
        <LovValue description="Others 2">3099</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE" qualifierValue="10">
        <LovValue description="Fax">3100</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE">
        <LovValue description="Testing large codes">34234234234242</LovValue>
        <LovValue description="SCR 144700">3501</LovValue>
        <LovValue description="Local Telephone">4000</LovValue>
        <LovValue description="Long Distance Telephone">4010</LovValue>
        <LovValue description="Internet Access">4020</LovValue>
        <LovValue description="ADJ - Local Telephone">4050</LovValue>
        <LovValue description="Car Wash">4051</LovValue>
        <LovValue description="ADJ - Long Distance Telephon">4060</LovValue>
        <LovValue description="ADJ - Internet Access">4070</LovValue>
        <LovValue description="Mini Bar">4500</LovValue>
        <LovValue description="F&amp;B 1">4501</LovValue>
        <LovValue description="Greens Fees">5000</LovValue>
        <LovValue description="Green Fees 2">5005</LovValue>
        <LovValue description="Cart Fee">5010</LovValue>
        <LovValue description="Rental Shoes/Clubs">5020</LovValue>
        <LovValue description="Massage">5024</LovValue>
        <LovValue description="ADJ - Greens Fee">5050</LovValue>
        <LovValue description="ADJ - Cart Fee">5060</LovValue>
        <LovValue description="ADJ - Rental Shoes/Clubs">5070</LovValue>
        <LovValue description="Training Transaction code">5656</LovValue>
        <LovValue description="Training Trx code Tax Type">5657</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE" qualifierValue="30">
        <LovValue description="Standard Package Reserve">6000</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE">
        <LovValue description="Refrigerator">6010</LovValue>
        <LovValue description="Microwave">6020</LovValue>
        <LovValue description="Laundry">6030</LovValue>
        <LovValue description="In Room Movie">6040</LovValue>
        <LovValue description="Shoe Shining Machine">6045</LovValue>
        <LovValue description="ADJ - Rollaway/Refrigerator/Microwave">6050</LovValue>
        <LovValue description="Non hotel supplies">6075</LovValue>
        <LovValue description="ADJ - Laundry">6080</LovValue>
        <LovValue description="ADJ - In Room Movie">6090</LovValue>
        <LovValue description="GET">6100</LovValue>
        <LovValue description="TAT">6200</LovValue>
        <LovValue description="Test Fee">6605</LovValue>
        <LovValue description="Test Trx 4234324">66362</LovValue>
        <LovValue description="test">6655</LovValue>
        <LovValue description="MW test Code">6660</LovValue>
        <LovValue description="Test OVOS Fee">66658</LovValue>
        <LovValue description="Cancellation Penalty">6666</LovValue>
        <LovValue description="Test">6700</LovValue>
        <LovValue description="Test SCR 118919">6759</LovValue>
        <LovValue description="SCR test">67814</LovValue>
        <LovValue description="Old Balance Conversion">7000</LovValue>
        <LovValue description="A/R Credit Card Transfer">7010</LovValue>
        <LovValue description="accom_tax">7070</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE" secondaryQualifierType="Y" secondaryQualifierValue="Y">
        <LovValue description="Owner Revenue Posting">7070I</LovValue>
        <LovValue description="Commission Posting to Owner">7080I</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE">
        <LovValue description="Testing">7110</LovValue>
        <LovValue description="Testing Ownership Fee">7112</LovValue>
        <LovValue description="- Avenue Tax">7201</LovValue>
        <LovValue description="Package">7500</LovValue>
        <LovValue description="Package Profit – EXCL">7501</LovValue>
        <LovValue description="Package Loss – EXCL">7502</LovValue>
        <LovValue description="Pkg with generates">7506</LovValue>
        <LovValue description="Pkg gra with generates">7509</LovValue>
        <LovValue description="Paid out 2">7520</LovValue>
        <LovValue description="SCR 156804 Trx 3">7701</LovValue>
        <LovValue description="Test">7766</LovValue>
        <LovValue description="SCR 138449">7777</LovValue>
        <LovValue description="CC Surcharge">7778</LovValue>
        <LovValue description="test">7800</LovValue>
        <LovValue description=" City Tax">8001</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE" qualifierValue="10">
        <LovValue description="Tax 2">8002</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE">
        <LovValue description="City Tax">8003</LovValue>
        <LovValue description="Service Charges">8010</LovValue>
        <LovValue description="Luxury Tax on Published Rate">8020</LovValue>
        <LovValue description="ANYTOWN CITY TAX">8021</LovValue>
        <LovValue description="ADJ - F&amp;B Tax - 4%">8050</LovValue>
        <LovValue description="TaX Testx">8051</LovValue>
        <LovValue description="- Avenue BF gratuity">8101</LovValue>
        <LovValue description="Sales Tax - 6%">8210</LovValue>
        <LovValue description="ADJ - Sales Tax - 6%">8260</LovValue>
        <LovValue description="Room Tax - 6%">8300</LovValue>
        <LovValue description="Occupancy Tax">8310</LovValue>
        <LovValue description="ADJ - Room Tax - 6%">8350</LovValue>
        <LovValue description="ADJ - Occupancy Tax - 4%">8360</LovValue>
        <LovValue description="Tax 5.5">8361</LovValue>
        <LovValue description="Tax 19.6">8362</LovValue>
        <LovValue description="DB FEE">8400</LovValue>
        <LovValue description="Service Fee">8500</LovValue>
        <LovValue description="Management Split">8501</LovValue>
        <LovValue description="ADJ - Ski Rentals">8502</LovValue>
        <LovValue description="ADJ - Ski School">8503</LovValue>
        <LovValue description="ADJ - Heli Skiing">8504</LovValue>
        <LovValue description="ADJ - Ski Racing">8505</LovValue>
        <LovValue description="General Excise Tax">8599</LovValue>
        <LovValue description="Transient Accommodation tax">8600</LovValue>
        <LovValue description="Lift Tickets">8601</LovValue>
        <LovValue description="Ski Rentals">8602</LovValue>
        <LovValue description="Ski School">8603</LovValue>
        <LovValue description="Helicopter Skiing">8604</LovValue>
        <LovValue description="Ski Racing Clinic">8605</LovValue>
        <LovValue description="Transient Accomodation Tax 7.25">8700</LovValue>
        <LovValue description="General Excise Tax 4.166">8701</LovValue>
        <LovValue description="Resort Fee">8711</LovValue>
        <LovValue description="State Tax">8712</LovValue>
        <LovValue description="test">87878</LovValue>
        <LovValue description="Tax A">8881</LovValue>
        <LovValue description="Tax B">8882</LovValue>
        <LovValue description="Tax Type Test">8888</LovValue>
        <LovValue description="Caddy Service">88892</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE" qualifierValue="10">
        <LovValue description="O - Tax">8900</LovValue>
      </LovQueryResult>
      <LovQueryResult qualifierType="DEFAULT_PRICE">
        <LovValue description="GET">8901</LovValue>
        <LovValue description="TAT">8902</LovValue>
        <LovValue description="Test trx 3">9009</LovValue>
        <LovValue description="test11">9012</LovValue>
        <LovValue description="Test Code">91111</LovValue>
        <LovValue description="Package Profit">9200</LovValue>
        <LovValue description="Package Loss">9250</LovValue>
        <LovValue description="Parking">9251</LovValue>
        <LovValue description="Test Tex">9501</LovValue>
        <LovValue description="Bora Test1">9873</LovValue>
        <LovValue description="Bora Tax2">9875</LovValue>
        <LovValue description="Back Office 2">9876</LovValue>
        <LovValue description="Tax 9.7 %">9889</LovValue>
        <LovValue description="Rooms">9890</LovValue>
        <LovValue description="tax5">9891</LovValue>
        <LovValue description="Rooms tax5">9892</LovValue>
        <LovValue description="Tax">99912</LovValue>
        <LovValue description="Rounding Difference">9999</LovValue>
      </LovQueryResult>
    </LovResponse>
  </soap:Body>
</soap:Envelope>


9 OwnedUnitAvailability

Retrieves details of a contract, given the name and resort identifiers. The contract identifier is also allowed and is returned. Information includes financial arrangements, restrictions, contract documents, and insurance policies in addition to information about the contract type, unit, effective dates, rate plans, and attached profiles.

 

Soap Action: http://webservices.micros.com/ows/5.1/UnitOwners.wsdl#OwnedUnitAvailability

OwnedUnitAvailabilityRequest

 

<?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:c="http://webservices.micros.com/og/4.3/Common/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:r="http://webservices.micros.com/og/4.3/Reservation/" xmlns:hc="http://webservices.micros.com/og/4.3/HotelCommon/" xmlns:n="http://webservices.micros.com/og/4.3/Name/">
  <soap:Header>
    <OGHeader transactionID="09698798" primaryLangID="E" timeStamp="2009-03-13T14:48:16.0718750-05: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>
    <OwnedUnitAvailabilityRequest xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">
      <NameId type="INTERNAL">5758088</NameId>
      <StayDates>
        <hc:StartDate>2013-04-15T00:00:00.0000000-05:00</hc:StartDate>
        <hc:EndDate>2013-04-16T00:00:00.0000000-05:00</hc:EndDate>
      </StayDates>
      <ContractId type="INTERNAL">85001</ContractId>
      <Resort chainCode="CHA" hotelCode="HOTEL" />
      <GuestCounts>
        <hc:GuestCount ageQualifyingCode="ADULT" count="1" />
        <hc:GuestCount ageQualifyingCode="CHILD" count="0" />
      </GuestCounts>
      <RoomTypeCode>CK</RoomTypeCode>
    </OwnedUnitAvailabilityRequest>
  </soap:Body>
</soap:Envelope>

OwnedUnitAvailabilityRequest

<xs:complexType name="OwnedUnitAvailabilityRequest">

<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="StayDates" xmlns:q2="http://webservices.micros.com/og/4.3/HotelCommon/" type="q2:TimeSpan" />

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

<xs:element minOccurs="0" maxOccurs="1" name="Resort" xmlns:q4="http://webservices.micros.com/og/4.3/HotelCommon/" type="q4:HotelReference" />

<xs:element minOccurs="0" maxOccurs="1" name="GuestCounts" xmlns:q5="http://webservices.micros.com/og/4.3/HotelCommon/" type="q5:GuestCountList" />

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameId

element

UniqueID

optional

The internal OPERA NameID.

StayDates

element

TimeSpan

optional

The stay dates.

ContractId

element

UniqueID

optional

The contract ID.

Resort

element

HotelReference

optional

The resort.

GuestCounts

element

GuestCountList

optional

The number of guests.

RoomTypeCode

element

string

optional

The room type code.

 

OwnedUnitAvailabilityResponse

 

<?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="09698798" primaryLangID="E" timeStamp="2009-03-13T14:48:16.0718750-05:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

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

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

            </OGHeader>

      </soap:Header>

      <soap:Body>

            <OwnedUnitAvailabilityResponse xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">

                  <Result resultStatusFlag="SUCCESS"/>

                  <Contracts>

                        <UnitRates xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">

                              <Unit>

                                    <ContractId type="EXTERNAL">1001</ContractId>

                                    <Unit>

                                          <RoomNumber xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">1004</RoomNumber>

                                          <RoomDescription xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">

                                                <Text>Superior King - City</Text>

                                          </RoomDescription>

                                          <RoomType roomTypeCode="SKC" xmlns="http://webservices.micros.com/og/4.3/HotelCommon/"/>

                                    </Unit>

                              </Unit>

                              <Rates>

                                    <RoomRate roomTypeCode="SKC" ratePlanCode="OWN" xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">

                                          <Rates>

                                                <Rate>

                                                      <Base currencyCode="USD">0</Base>

                                                      <AdditionalGuestAmounts>

                                                            <AdditionalGuestAmount additionalGuestType="ADULT">

                                                                  <Amount currencyCode="USD">0</Amount>

                                                            </AdditionalGuestAmount>

                                                            <AdditionalGuestAmount additionalGuestType="CHILD">

                                                                  <Amount currencyCode="USD">0</Amount>

                                                            </AdditionalGuestAmount>

                                                      </AdditionalGuestAmounts>

                                                </Rate>

                                          </Rates>

                                    </RoomRate>

                              </Rates>

                        </UnitRates>

                  </Contracts>

            </OwnedUnitAvailabilityResponse>

      </soap:Body>

</soap:Envelope>

 

OwnedUnitAvailabilityResponse

 

<xs:complexType name="OwnedUnitAvailabilityResponse">

<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="Contracts" xmlns:q2="http://webservices.micros.com/og/4.3/UnitOwners/" type="q2:ArrayOfUnitRate" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

The primary indication of the success or failure of the called function.

Contracts

element

ArrayOfUnitRate

optional

A collection of unit UnitRate elements.

 


10    OwnerStatementDetails

Retrieves the file names of the owner statement and summary information, given the name and resort identifiers and the stay date range.

 

Soap Action: http://webservices.micros.com/ows/5.1/UnitOwners.wsdl#OwnerStatementDetails

OwnerStatementDetailsRequest

 

<?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:c="http://webservices.micros.com/og/4.3/Common/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"

               xmlns:r="http://webservices.micros.com/og/4.3/Reservation/" xmlns:hc="http://webservices.micros.com/og/4.3/HotelCommon/" xmlns:n="http://webservices.micros.com/og/4.3/Name/">

      <soap:Header>

            <OGHeader transactionID="998768998737" primaryLangID="E" timeStamp="2009-03-13T14:59:16.0718750-05:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

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

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

            </OGHeader>

      </soap:Header>

      <soap:Body>

            <OwnerStatementDetailsRequest xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">

                  <NameId type="INTERNAL">2517582</NameId>

                  <StayDates>

                        <hc:StartDate>2008-01-01T00:00:00.0000000-05:00</hc:StartDate>

                        <hc:EndDate>2009-04-16T00:00:00.0000000-05:00</hc:EndDate>

                  </StayDates>

                  <Resort>SEFIVE</Resort>

            </OwnerStatementDetailsRequest>

      </soap:Body>

</soap:Envelope>

 

OwnerStatementDetailsRequest

 

<xs:complexType name="OwnerStatementDetailsRequest">

<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="StayDates" xmlns:q2="http://webservices.micros.com/og/4.3/HotelCommon/" type="q2:TimeSpan" />

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameId

Element

UniqueID

optional

The internal OPERA NameID.

StayDates

element

TimeSpan

optional

The dates of the stay.

Resort

element

string

optional

The resort ID.

 

OwnerStatementDetailsResponse

 

<?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:c="http://webservices.micros.com/og/4.3/Common/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:r="http://webservices.micros.com/og/4.3/Reservation/" xmlns:hc="http://webservices.micros.com/og/4.3/HotelCommon/" xmlns:n="http://webservices.micros.com/og/4.3/Name/">

               xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">

      <soap:Header>

            <OGHeader transactionID="998768998737" primaryLangID="E" timeStamp="2009-03-13T14:59:16.0718750-05:00" xmlns="http://webservices.micros.com/og/4.3/Core/">

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

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

            </OGHeader>

            <wsa:Action>http://webservices.micros.com/ows/5.1/UnitOwners.wsdl#OwnerStatementDetailsResponse</wsa:Action>

            <wsa:MessageID>uuid:c0604900-56f1-4bf5-9a29-a0f2605b028c</wsa:MessageID>

            <wsa:RelatesTo>uuid:bc214918-da43-42f3-834d-e2f59ad5071f</wsa:RelatesTo>

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

            <wsse:Security>

                  <wsu:Timestamp wsu:Id="Timestamp-2970e84f-08f2-4254-9c4d-99348d52bce0">

                        <wsu:Created>2009-03-13T14:59:16Z</wsu:Created>

                        <wsu:Expires>2009-03-13T14:01:40Z</wsu:Expires>

                  </wsu:Timestamp>

            </wsse:Security>

      </soap:Header>

      <soap:Body>

            <OwnerStatementDetailsResponse xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">

                  <Result resultStatusFlag="SUCCESS"/>

                  <StatementFileName>c:\reports\sample_owner_statement4875218.PDF</StatementFileName>

                  <SummaryFileName>c:\reports\sample_owner_summary4875219.PDF</SummaryFileName>

            </OwnerStatementDetailsResponse>

      </soap:Body>

</soap:Envelope>

 

OwnerStatementDetailsResponse

 

<xs:complexType name="OwnerStatementDetailsResponse">

<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="StatementFileName" type="xs:string" />

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

The primary indication of the success or failure of the called function.

StatementFileName

element

string

optional

The statement file name.

SummaryFileName

element

string

optional

The summary file name.

 

 


 

11    UpdateContract

Soap Action: http://webservices.micros.com/ows/5.1/UnitOwners.wsdl#UpdateContract

UpdateContractRequest

<?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="32868696" primaryLangID="E" timeStamp="2009-03-13T14:48:16.0718750-05:00" xmlns="http://webservices.micros.com/og/4.3/Core/">
            <Origin entityID="OWS" systemType="WEB"/>
            <Destination entityID="TI" systemType="ORS"/>
        </OGHeader>
    </soap:Header>
    <soap:Body>
        <UpdateContractRequest xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">
            <ContractDetails>
                <ContractId type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">517</ContractId>
                <HotelReference hotelCode="HOTEL" xmlns="http://webservices.micros.com/og/4.3/UnitOwners/"/>
                <ContractNumber xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">50506060</ContractNumber>
                <Unit xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
                    <RoomNumber xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">1003</RoomNumber>
                    <RoomType roomTypeCode="13970" xmlns="http://webservices.micros.com/og/4.3/HotelCommon/"/>
                </Unit>
                <ValidDates xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
                    <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2006-07-21T00:00:00</StartDate>
                    <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2020-12-31T00:00:00</EndDate>
                </ValidDates>
                <PrimaryOwner taxId="342385675" primary="true" changeUnit="false" revenuePercentage="80" include1099="false" xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
                    <ProfileIDs xmlns="http://webservices.micros.com/og/4.3/Name/">
                        <UniqueID type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/Common/">5635524</UniqueID>
                    </ProfileIDs>
                    <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>
                </PrimaryOwner>
                <AuthorizedProfiles xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
                    <RelatedProfiles ContractProfileType="PRIMARYOWNER" taxId="342385675" primary="true" changeUnit="false" revenuePercentage="80" include1099="false" CommissionPercentage="100" recordId="535" systemStatus="CHANGED">
                        <ProfileIDs xmlns="http://webservices.micros.com/og/4.3/Name/">
                            <UniqueID type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/Common/">5635524</UniqueID>
                        </ProfileIDs>
                        <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 operaId="1031357">
                                <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>
                        <Phones xmlns="http://webservices.micros.com/og/4.3/Name/">
                            <NamePhone phoneType="HOME" phoneRole="PHONE" operaId="325511">
                                <PhoneNumber xmlns="http://webservices.micros.com/og/4.3/Common/">1234567890</PhoneNumber>
                            </NamePhone>
                        </Phones>
                        <EMails xmlns="http://webservices.micros.com/og/4.3/Name/">
                            <NameEmail operaId="325512">name@example.com</NameEmail>
                        </EMails>
                    </RelatedProfiles>
                    <RelatedProfiles ContractProfileType="CO-OWNER" primary="true" changeUnit="false" revenuePercentage="20" include1099="false" generalExciseTax="false" transientAccommodationTax="false" recordId="536" systemStatus="CHANGED">
                        <ProfileIDs xmlns="http://webservices.micros.com/og/4.3/Name/">
                            <UniqueID type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/Common/">5635525</UniqueID>
                        </ProfileIDs>
                        <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 operaId="1031358">
                                <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>
                        <Phones xmlns="http://webservices.micros.com/og/4.3/Name/">
                            <NamePhone phoneType="HOME" phoneRole="PHONE" operaId="325513">
                                <PhoneNumber xmlns="http://webservices.micros.com/og/4.3/Common/">1234567890</PhoneNumber>
                            </NamePhone>
                        </Phones>
                        <EMails xmlns="http://webservices.micros.com/og/4.3/Name/">
                            <NameEmail operaId="325514">name@example.com</NameEmail>
                        </EMails>
                    </RelatedProfiles>
                    <RelatedProfiles ContractProfileType="FRIENDS_AND_FAMILY" Relationship="FAMILY" primary="true" changeUnit="false" include1099="false" generalExciseTax="false" transientAccommodationTax="false" recordId="537" systemStatus="CHANGED">
                        <ProfileIDs xmlns="http://webservices.micros.com/og/4.3/Name/">
                            <UniqueID type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/Common/">5635526</UniqueID>
                        </ProfileIDs>
                        <Customer xmlns="http://webservices.micros.com/og/4.3/Name/">
                            <PersonName>
                                <firstName xmlns="http://webservices.micros.com/og/4.3/Common/">Jane</firstName>
                                <lastName xmlns="http://webservices.micros.com/og/4.3/Common/">Smith</lastName>
                            </PersonName>
                        </Customer>
                    </RelatedProfiles>
                    <RelatedProfiles ContractProfileType="FRIENDS_AND_FAMILY" Relationship="FRIEND" primary="true" changeUnit="false" include1099="false" generalExciseTax="false" transientAccommodationTax="false" recordId="538" systemStatus="CHANGED">
                        <ProfileIDs xmlns="http://webservices.micros.com/og/4.3/Name/">
                            <UniqueID type="EXTERNAL" xmlns="http://webservices.micros.com/og/4.3/Common/">5635527</UniqueID>
                        </ProfileIDs>
                        <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>
                    </RelatedProfiles>
                </AuthorizedProfiles>
                <ContractType xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">U</ContractType>
                <RentalProgram xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">true</RentalProgram>
                 <Status xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">Negotiated</Status>
                <TemplateCode xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">2</TemplateCode>
                <ModifiedUnit xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">false</ModifiedUnit>
                <Restrictions xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
                    <Restriction>
                        <RecordId>275</RecordId>
                        <RestrictionType>AF</RestrictionType>
                        <Dates>
                            <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2006-10-21T00:00:00</StartDate>
                            <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2006-10-24T00:00:00</EndDate>
                        </Dates>
                        <MaximumNights>2</MaximumNights>
                        <UsedNights>0</UsedNights>
                        <Day1>Y</Day1>
                        <Day2>Y</Day2>
                        <Day3>Y</Day3>
                        <Day4>Y</Day4>
                        <Day5>Y</Day5>
                        <Day6>Y</Day6>
                        <Day7>Y</Day7>
                        <SystemStatus>CHANGED</SystemStatus>
                        <CompNights>2</CompNights>
                    </Restriction>
                    <Restriction>
                        <RecordId>276</RecordId>
                        <RestrictionType>MR</RestrictionType>
                        <Dates>
                            <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2007-07-20T00:00:00</StartDate>
                            <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2007-07-24T00:00:00</EndDate>
                        </Dates>
                        <MaximumNights>0</MaximumNights>
                        <MinimumRate>200</MinimumRate>
                        <UsedNights>0</UsedNights>
                        <Day1>Y</Day1>
                        <Day2>Y</Day2>
                        <Day3>Y</Day3>
                        <Day4>Y</Day4>
                        <Day5>Y</Day5>
                        <Day6>Y</Day6>
                        <Day7>Y</Day7>
                        <SystemStatus>CHANGED</SystemStatus>
                        <CompNights>0</CompNights>
                    </Restriction>
                    <Restriction>
                        <RecordId>277</RecordId>
                        <RestrictionType>CN</RestrictionType>
                        <Dates>
                            <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2008-07-20T00:00:00</StartDate>
                            <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2008-07-28T00:00:00</EndDate>
                        </Dates>
                        <MaximumNights>3</MaximumNights>
                        <UsedNights>1</UsedNights>
                        <Day1>Y</Day1>
                        <Day2>Y</Day2>
                        <Day3>Y</Day3>
                        <Day4>Y</Day4>
                        <Day5>Y</Day5>
                        <Day6>Y</Day6>
                        <Day7>Y</Day7>
                        <SystemStatus>CHANGED</SystemStatus>
                        <CompNights>3</CompNights>
                    </Restriction>
                    <Restriction>
                        <RecordId>278</RecordId>
                        <RestrictionType>PC</RestrictionType>
                        <Dates>
                            <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2009-07-20T00:00:00</StartDate>
                            <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2009-07-27T00:00:00</EndDate>
                        </Dates>
                        <MaximumNights>0</MaximumNights>
                        <UsedNights>0</UsedNights>
                        <Day1>Y</Day1>
                        <Day2>Y</Day2>
                        <Day3>Y</Day3>
                        <Day4>Y</Day4>
                        <Day5>Y</Day5>
                        <Day6>Y</Day6>
                        <Day7>Y</Day7>
                        <SystemStatus>CHANGED</SystemStatus>
                        <CompNights>0</CompNights>
                        <OwnerMaximum>2</OwnerMaximum>
                        <AuthMaximum>0</AuthMaximum>
                        <Rate>100</Rate>
                    </Restriction>
                </Restrictions>
                <RentalContracts xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
                    <RentalContract>
                        <RecordId>255</RecordId>
                        <Dates>
                            <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2006-07-21T00:00:00</StartDate>
                            <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2020-07-20T00:00:00</EndDate>
                        </Dates>
                        <OwnerRevenueShare>100</OwnerRevenueShare>
                        <RevenueShareFormula>N</RevenueShareFormula>
                        <CommByOwner>10</CommByOwner>
                        <AutoRenewalDate>2020-07-20</AutoRenewalDate>
                        <AutoRenewalMonths>12</AutoRenewalMonths>
                        <ResvMaxNights>0</ResvMaxNights>
                        <LongTerm>false</LongTerm>
                        <SystemStatus>CHANGED</SystemStatus>
                        <GraceMonths>2</GraceMonths>
                        <RevenuePool>TESTPOOL</RevenuePool>
                    </RentalContract>
                </RentalContracts>
                <Deductions xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
                    <Deduction>
                        <RecordId>255</RecordId>
                        <DeductionCode>MARKETING</DeductionCode>
                        <Rule>A</Rule>
                        <Amount>20</Amount>
                        <Formula>F</Formula>
                        <Sequence>1</Sequence>
                        <SystemStatus>CHANGED</SystemStatus>
                    </Deduction>
                </Deductions>
                <Fees xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
                    <Fee>
                        <RecordId>255</RecordId>
                        <FeeCode>TRANSPORT</FeeCode>
                        <Frequency>W</Frequency>
                        <Amount>10</Amount>
                        <TransactionCode>2170</TransactionCode>
                        <AutoPost>Y</AutoPost>
                        <PostTo>O</PostTo>
                        <OccupiedBy>A</OccupiedBy>
                        <SystemStatus>CHANGED</SystemStatus>
                    </Fee>
                </Fees>
                <Tasks xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
                    <Task>
                        <RecordId>255</RecordId>
                        <TaskCode>CARPET</TaskCode>
                        <Amount>10</Amount>
                        <TaskRhythm>D</TaskRhythm>
                        <TransactionCode>2100</TransactionCode>
                        <PostTo>O</PostTo>
                        <OccupiedBy>A</OccupiedBy>
                        <SystemStatus>CHANGED</SystemStatus>
                    </Task>
                </Tasks>
                <ContractDocuments xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
                    <ContractDocument>
                        <RecordId>255</RecordId>
                        <DocumentType>CONTRACT</DocumentType>
                        <Description>
                            <Text xmlns="http://webservices.micros.com/og/4.3/Common/">
                                <TextElement>rental contract</TextElement>
                            </Text>
                        </Description>
                        <DateReceived>2006-07-21</DateReceived>
                        <SystemStatus>CHANGED</SystemStatus>
                    </ContractDocument>
                </ContractDocuments>
                <InsurancePolicies xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
                    <Insurance>
                        <RecordId>255</RecordId>
                        <PolicyNumber>2342422432</PolicyNumber>
                        <InsuranceType>HUR</InsuranceType>
                        <EffectiveDates>
                            <StartDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2006-07-21T00:00:00</StartDate>
                            <EndDate xmlns="http://webservices.micros.com/og/4.3/HotelCommon/">2007-07-20T00:00:00</EndDate>
                        </EffectiveDates>
                        <Company>
                            <Company xmlns="http://webservices.micros.com/og/4.3/Name/">
                                <CompanyName>Insurance Co.</CompanyName>
                                <CompanyType>TRAVEL_AGENT</CompanyType>
                            </Company>
                        </Company>
                        <Required_For_Rental>true</Required_For_Rental>
                        <SystemStatus>CHANGED</SystemStatus>
                    </Insurance>
                </InsurancePolicies>
                <Miscellaneous xmlns="http://webservices.micros.com/og/4.3/UnitOwners/">
                    <ContractDate>2006-07-21</ContractDate>
                    <EstimatedClosingDate>2007-07-20</EstimatedClosingDate>
                    <RealEstateAgent>My Real Estate Agent</RealEstateAgent>
                    <SalesAssociate>My Sales Associate</SalesAssociate>
                    <PurchasePrice>200000</PurchasePrice>
                    <Comments>this is a test comment</Comments>
                </Miscellaneous>
            </ContractDetails>
        </UpdateContractRequest>
    </soap:Body>
</soap:Envelope>

 

UpdateContractRequest

 

<xs:complexType name="UpdateContractRequest">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

ContractDetails

element

UnitContractDetails

optional

The contract details.

 

UpdateContractResponse

<?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="32868696" timeStamp="2009-03-13T15:48:16.071875-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/UnitOwners.wsdl#UpdateContractResponse</wsa:Action>
    <wsa:MessageID>urn:uuid:fb2859e8-9836-4ee2-b6d1-0608ac40d459</wsa:MessageID>
    <wsa:RelatesTo>urn:uuid:6e105c86-97cb-45d1-adbe-21c6673db3fb</wsa:RelatesTo>
    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
  </soap:Header>
  <soap:Body>
    <UpdateContractResponse xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">
      <Result resultStatusFlag="SUCCESS" />
      <ContractId type="INTERNAL">64753</ContractId>
      <ContractNo type="INTERNAL">16</ContractNo>
    </UpdateContractResponse>
  </soap:Body>
</soap:Envelope>

 

UpdateContractResponse

 

<xs:complexType name="UpdateContractResponse">

<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="ContractId" xmlns:q2="http://webservices.micros.com/og/4.3/Common/" type="q2:UniqueID" />

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Result

element

ResultStatus

optional

The result status.

ContractId

element

UniqueID

optional

The contract ID.

ContractNo

element

UniqueID

optional

The contract number.

 


12    UpdateProfileInContract

Modifies a family/friend guest profile, given the guest name, requestor name, contract, and resort identifiers as well as the relationship of the requestor.

 

Soap Action: http://webservices.micros.com/ows/5.1/UnitOwners.wsdl#UpdateProfileInContract

UpdateProfileInContractRequest

 

<?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:c="http://webservices.micros.com/og/4.3/Common/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:r="http://webservices.micros.com/og/4.3/Reservation/" xmlns:hc="http://webservices.micros.com/og/4.3/HotelCommon/" xmlns:n="http://webservices.micros.com/og/4.3/Name/">
  <soap:Header>
    <OGHeader transactionID="43878937" primaryLangID="E" timeStamp="2009-03-13T14:48:16.0718750-05: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>
    <UpdateProfileInContractRequest xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">
      <NameId type="INTERNAL">5758090</NameId>
      <RequesterNameId type="INTERNAL">5758088</RequesterNameId>
      <ContractId type="INTERNAL">85001</ContractId>
      <Resort>RESORT</Resort>
      <Relationship>FRIEND</Relationship>
    </UpdateProfileInContractRequest>
  </soap:Body>
</soap:Envelope>

 

UpdateProfileInContractRequest

 

<xs:complexType name="UpdateProfileInContractRequest">

<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="RequesterNameId" xmlns:q2="http://webservices.micros.com/og/4.3/Common/" type="q2:UniqueID" />

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

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameId

element

UniqueID

optional

The OPERA NameID for the individual guest.

RequesterNameId

element

UniqueID

optional

The OPERA NameID for the requester.

ContractId

element

UniqueID

optional

The contract ID.

Resort

element

string

optional

The resort ID

Relationship

element

string

optional

The relationship of the individual to the owner.

 

UpdateProfileInContractResponse

 

<?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="43878937" timeStamp="2009-03-13T15:48:16.071875-04:00" primaryLangID="E" xmlns="http://webservices.micros.com/og/4.3/Core/">

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

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

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

    <wsa:MessageID>urn:uuid:8076a70e-d3b3-4df3-8c10-3d26be9cb35c</wsa:MessageID>

    <wsa:RelatesTo>urn:uuid:62a41d00-8e6d-4dbd-aed4-e33c7d347cc4</wsa:RelatesTo>

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

  </soap:Header>

  <soap:Body>

    <UpdateProfileInContractResponse xmlns="http://webservices.micros.com/ows/5.1/UnitOwners.wsdl">

      <Result resultStatusFlag="SUCCESS" />

    </UpdateProfileInContractResponse>

  </soap:Body>

</soap:Envelope>

 

UpdateProfileInContractResponse

 

<xs:complexType name="UpdateProfileInContractResponse">

<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

The primary indication of the success or failure of the called function.

 


13    Complex and Simple Type Definitions

AdditionalBedAmount

 

<xs:complexType name="AdditionalBedAmount">

<xs:sequence>

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

</xs:sequence>

<xs:attribute name="extraBedType" xmlns:q2="http://webservices.micros.com/og/4.3/HotelCommon/" type="q2:AdditionalBedType" use="required" />

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

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

extraBedType

attribute

AdditionalBedType

required

The extra bed type.

otherExtraBedType

attribute

string

none

If ‘OTHER’ is selected as the extra bed type, then this is the other type.

quantity

attribute

int

none

The quantity.

Amount

element

Amount

optional

The chargeable amount per extra bed of this type.

AdditionalBedType

 

<xs:simpleType name="AdditionalBedType">

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

<xs:enumeration value="ADULT" />

<xs:enumeration value="CHILD" />

<xs:enumeration value="CRIB" />

<xs:enumeration value="OTHER" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

AdditionalBedType

enumeration

string

 

The possible values are ADULT, CHILD, CRIB, and OTHER.

AdditionalDetail

 

<xs:complexType name="AdditionalDetail">

<xs:sequence>

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

</xs:sequence>

<xs:attribute name="detailType" xmlns:q2="http://webservices.micros.com/og/4.3/HotelCommon/" type="q2:AdditionalDetailType" use="required" />

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

detailType

attribute

AdditionalDetailType

required

The additional detail type.

otherDetailType

attribute

string

none

If OTHER is selected as the detail type, then this is the other type.

AdditionalDetailDescription

element

Paragraph

optional

A paragraph providing additional detail text.

AdditionalDetailType

 

<xs:simpleType name="AdditionalDetailType">

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

<xs:enumeration value="RateRules" />

<xs:enumeration value="MarketingInformation" />

<xs:enumeration value="DepositPolicy" />

<xs:enumeration value="Promotion" />

<xs:enumeration value="CommissionPolicy" />

<xs:enumeration value="GuaranteePolicy" />

<xs:enumeration value="Miscellaneous" />

<xs:enumeration value="PackageOptions" />

<xs:enumeration value="PenaltyPolicy" />

<xs:enumeration value="TASpecialRequest" />

<xs:enumeration value="TaxInformation" />

<xs:enumeration value="CancelPolicy" />

<xs:enumeration value="ProprietaryGDSCode" />

<xs:enumeration value="Other" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

AdditionalDetailType

enumeration

string

 

The possible values are RateRules, MarketingInformation, DepositPolicy, Promotion, CommissionPolicy, GuaranteePolicy, Miscellaneous, PackageOptions, PenaltyPolicy, TASpecialRequest, TaxInformation, CancelPolicy, ProprietaryGDSCode, and Other.

AdditionalGuestAmount

 

<xs:complexType name="AdditionalGuestAmount">

<xs:sequence>

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

</xs:sequence>

<xs:attribute name="additionalGuestType" xmlns:q2="http://webservices.micros.com/og/4.3/HotelCommon/" type="q2:AgeQualifyingCode" use="required" />

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

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

additionalGuestType

attribute

AgeQualifyingCode

required

The age qualifying code.

otherAdditionalGuestType

attribute

string

none

If ‘OTHER’ is selected as the age qualifying code, then this is the other code.

quantity

attribute

int

none

Not used in this context.

Amount

element

Amount

optional

The chargeable amount per extra guest of this type.

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:element minOccurs="0" maxOccurs="1" name="barCode" type="xs:string" />

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

</xs:sequence>

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

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

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

addressType

attribute

string

none

Contains up to five lines of address information, including the street address, box number, and mailstop.

otherAddressType

attribute

string

none

The city name.

languageCode

attribute

string

none

The language code.

AddressLine

element

string

optional / multiple

The state or province code.

cityName

element

string

optional

The country code.

stateProv

element

string

optional

The postal or zip code.

countryCode

element

string

optional

The address type code for this address.

postalCode

element

string

optional

Not used in this context.

barCode

element

string

optional

The bar code.

cityExtension

element

string

optional

The city extension.

AgeQualifyingCode

 

<xs:simpleType name="AgeQualifyingCode">

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

<xs:enumeration value="ADULT" />

<xs:enumeration value="CHILD" />

<xs:enumeration value="OTHER" />

<xs:enumeration value="CHILDBUCKET1" />

<xs:enumeration value="CHILDBUCKET2" />

<xs:enumeration value="CHILDBUCKET3" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

AgeQualifyingCode

enumeration

string

 

The possible values are ADULT, CHILD, OTHER, CHILDBUCKET1, CHILDBUCKET2, and CHILDBUCKET3.

AmenityInfo

<xs:complexType name="AmenityInfo">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Amenities

element

ArrayOfAmenity

optional

The list of amenities.

Amount

 

<xs:complexType name="Amount">

<xs:simpleContent>

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

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

<xs:attribute name="decimals" type="xs:short" />

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

</xs:extension>

</xs:simpleContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Amount

extension

double

 

The amount.

currencyCode

attribute

string

none

The currency code of the value specified in the root amount.

decimals

attribute

short

none

The decimals.

currencyText

attribute

string

none

The currency text.

ArrayOfAdditionalBedAmount

 

<xs:complexType name="ArrayOfAdditionalBedAmount">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

AdditionalBedAmount

element

AdditionalBedAmount

optional / multiple

The number of additional beds.

ArrayOfAdditionalDetail

 

<xs:complexType name="ArrayOfAdditionalDetail">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

AdditionalDetail

element

AdditionalDetail

optional / multiple

If the parent element exists, at least one AdditionalDetail element is required.

ArrayOfAdditionalGuestAmount

 

<xs:complexType name="ArrayOfAdditionalGuestAmount">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

AdditionalGuestAmount

element

AdditionalGuestAmount

optional / multiple

Not used in a General Availability response. In a Detail Availability response, this will be populated if additional guest amounts are attached to rate.

ArrayOfAmenity

 

<xs:complexType name="ArrayOfAmenity">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Amenity

element

Amenity

optional / multiple

Amenity.

ArrayOfAwardPointsToExpire

 

<xs:complexType name="ArrayOfAwardPointsToExpire">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

AwardPointsToExpire

element

AwardPointsToExpire

optional / multiple

The award points to expire.

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.

ArrayOfContractDeduction

 

<xs:complexType name="ArrayOfContractDeduction">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Deduction

element

ContractDeduction

optional / multiple

The contract deduction.

ArrayOfContractDocument

 

<xs:complexType name="ArrayOfContractDocument">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

ContractDocument

element

ContractDocument

optional / multiple

The contract document.

ArrayOfContractElement

 

<xs:complexType name="ArrayOfContractElement">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

ContractElements

element

ContractElement

optional / multiple

The contract elements.

ArrayOfContractFees

 

<xs:complexType name="ArrayOfContractFees">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Fee

element

ContractFees

optional / multiple

The contract fee.

ArrayOfContractFractional

 

<xs:complexType name="ArrayOfContractFractional">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

ContractFractionals

element

ContractFractional

optional / multiple

The contract fractionals.

ArrayOfContractPoints

 

<xs:complexType name="ArrayOfContractPoints">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Point

element

ContractPoints

optional / multiple

The contract points.

ArrayOfContractRestriction

 

<xs:complexType name="ArrayOfContractRestriction">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Restriction

element

ContractRestriction

optional / multiple

The contract restriction.

ArrayOfContractTask

 

<xs:complexType name="ArrayOfContractTask">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Task

element

ContractTask

optional / multiple

The contract task.

ArrayOfGdsTotalPricingTax

 

<xs:complexType name="ArrayOfGdsTotalPricingTax">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

GdsTotalPricingTax

element

GdsTotalPricingTax

optional / multiple

The GDS total pricing tax.

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.

ArrayOfGuarantee

 

<xs:complexType name="ArrayOfGuarantee">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Guarantee

element

Guarantee

optional / multiple

The contract guarantee.

ArrayOfGuaranteeAccepted

 

<xs:complexType name="ArrayOfGuaranteeAccepted">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

GuaranteeAccepted

element

GuaranteeAccepted

optional / multiple

The contract accepted guarantee.

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.

ArrayOfInsurancePolicy

 

<xs:complexType name="ArrayOfInsurancePolicy">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Insurance

element

InsurancePolicy

optional / multiple

The insurance policy information.

ArrayOfKeyWord

 

<xs:complexType name="ArrayOfKeyWord">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

KeyWord

element

KeyWord

optional / multiple

The list of keywords.

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

A collection of NameMembership records retrieved for the subject profile.

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

A collection of NamePhone elements.

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.

ArrayOfPackageElement

 

<xs:complexType name="ArrayOfPackageElement">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Package

element

PackageElement

optional / multiple

The list of package 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 PrivacyOption elements.

ArrayOfRate

 

<xs:complexType name="ArrayOfRate">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Rate

element

Rate

optional / multiple

A collection of Rate elements.

ArrayOfRelatedProfileListRelatedProfiles

 

<xs:complexType name="ArrayOfRelatedProfileListRelatedProfiles">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

 

Name

Type

Data Type

Use

Comments

RelatedProfiles

element

RelatedProfileListRelatedProfiles

optional / multiple

The related profiles list.

ArrayOfRentalContract

 

<xs:complexType name="ArrayOfRentalContract">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

 

Name

Type

Data Type

Use

Comments

RentalContract

element

RentalContract

optional / multiple

The rental contract.

ArrayOfRoomFeature

 

<xs:complexType name="ArrayOfRoomFeature">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Features

element

RoomFeature

optional / multiple

The room features.

ArrayOfRelatedProfile

 

<xs:complexType name="ArrayOfRelatedProfile">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

 

Name

Type

Data Type

Use

Comments

RelatedProfiles

element

RelatedProfile

optional / multiple

A collection of RelatedProfiles elements.

ArrayOfRoomRate

 

<xs:complexType name="ArrayOfRoomRate">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

 

Name

Type

Data Type

Use

Comments

RoomRate

element

RoomRate

optional / multiple

Collection of RoomRate elements, which in this context contain a single RoomRate.

ArrayOfRelatedProfileListRelatedProfiles

 

<xs:complexType name="ArrayOfRelatedProfileListRelatedProfiles">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

 

Name

Type

Data Type

Use

Comments

RelatedProfiles

element

RelatedProfileListRelatedProfiles

optional / multiple

The related list of profiles.

ArrayOfRentalContract

 

<xs:complexType name="ArrayOfRentalContract">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

RentalContract

element

RentalContract

optional / multiple

The rental contract.

ArrayOfRoomFeature

 

<xs:complexType name="ArrayOfRoomFeature">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Features

element

RoomFeature

optional / multiple

The room features.

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

A collection of TextElement elements.

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

Contains text error message string(s).

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.

ArrayOfUnitContract

 

<xs:complexType name="ArrayOfUnitContract">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Contracts

element

UnitContract

optional / multiple

A collection of unit contract elements.

ArrayOfUnitRate

 

<xs:complexType name="ArrayOfUnitRate">

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

UnitRates

element

UnitRate

optional / multiple

A collection of UnitRate 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

Not used in this context.

AwardPointsToExpire

 

<xs:complexType name="AwardPointsToExpire">

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

<xs:attribute name="totalToExpire" type="xs:double" use="required" />

<xs:attribute name="expireByDate" type="xs:double" />

</xs:complexType>

 

 

Name

Type

Data Type

Use

Comments

expirationDate

attribute

date

required

The expiration date.

totalToExpire

attribute

double

required

The total award points set to expire.

expireByDate

attribute

double

none

The expire by date.

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

 

Indicates whether a guest or company is blacklisted.

flag

attribute

BlackListFlag

none

The blacklist flag.

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.

CancelDateTime

 

<xs:complexType name="CancelDateTime">

<xs:simpleContent>

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

<xs:attribute name="period" type="xs:duration" />

</xs:extension>

</xs:simpleContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

CancelDateTime

extension

dateTime

 

The date and time of the cancellation.

period

attribute

duration

none

The difference between the check-in time applied to the arrival date and the date and time specified in this element.

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:attribute name="commentType" type="xs:string" />

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

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

</xs:extension>

</xs:complexContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Comment

extension

DescriptiveText

 

Descriptive 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 ID.

insertDate

attribute

dateTime

none

The insert date.

updateUser

attribute

string

none

The user ID.

updateDate

attribute

dateTime

none

The update date.

inactiveDate

attribute

date

none

The inactive date.

commentType

attribute

string

none

The comment type.

globalYn

attribute

string

none

Global Yes / No.

internalYn

attribute

string

none

Internal Yes  / No.

Commission

 

<xs:complexType name="Commission">

<xs:sequence>

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

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

</xs:sequence>

<xs:attribute name="percent" type="xs:decimal" />

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

percent

attribute

decimal

none

If the commission is a percentage value, then the value is indicated in this attribute.

currencyCode

attribute

string

none

If the commission is a percentage value, this is the currency in which the commission should/will be paid.

CommissionPayableAmount

element

Amount

optional

The value of the commission payment.

Comment

element

Paragraph

optional

Not used in this context.

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

The commission code.

CompanyName

element

string

optional

The company name.

CompanyType

element

CompanyCompanyType

required

The company type.

CompanyID

element

string

optional

The company ID.

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.

ContractDeduction

 

<xs:complexType name="ContractDeduction">

<xs:sequence>

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

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

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

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

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

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

<xs:element minOccurs="0" maxOccurs="1" name="Sequence" type="xs:integer" />

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

RecordId

element

long

optional

The record ID.

DeductionCode

element

string

optional

The deduction code.

Rule

element

string

optional

The rule.

Amount

element

Amount

optional

The amount.

Formula

element

string

optional

The formula.

OccupiedBy

element

string

optional

Occupied by.

Sequence

element

integer

optional

The sequence.

SystemStatus

element

string

optional

The system status.

ContractDocument

 

<xs:complexType name="ContractDocument">

<xs:sequence>

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

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

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

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

RecordId

element

long

optional

The record ID.

DocumentType

element

string

optional

The document type.

Description

element

DescriptiveText

optional

The description.

DateReceived

element

date

optional

The date received.

SystemStatus

element

string

optional

The system status.

ContractElement

 

<xs:complexType name="ContractElement">

<xs:sequence>

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

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

<xs:element minOccurs="1" maxOccurs="1" name="Multiplier" type="xs:double" />

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

RecordId

element

long

optional

The record ID.

Code

element

string

optional

The code.

Multiplier

element

double

required

The multiplier.

SystemStatus

element

string

optional

The system status.

ContractFees

 

<xs:complexType name="ContractFees">

<xs:sequence>

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

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

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

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

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

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

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

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

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

RecordId

element

long

optional

The record ID.

FeeCode

element

string

optional

The fee code.

Frequency

element

string

optional

The frequency.

Formula

element

string

optional

The formula.

Amount

element

Amount

optional

The amount.

TransactionCode

element

string

optional

The transaction code.

AutoPost

element

string

optional

The auto post.

PostTo

element

string

optional

Post to.

OccupiedBy

element

string

optional

Occupied by.

SystemStatus

element

string

optional

The system status.

ContractFractional

 

<xs:complexType name="ContractFractional">

<xs:sequence>

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

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

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

<xs:element minOccurs="0" maxOccurs="1" name="RevenuePercentage" type="xs:double" />

<xs:element minOccurs="0" maxOccurs="1" name="CommissionPercentage" type="xs:double" />

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

RecordId

element

long

optional

The record ID.

Dates

element

TimeSpan

optional

The dates.

RepeatEndDate

element

date

optional

The repeat end date.

RevenuePercentage

element

double

optional

The revenue percentage.

CommissionPercentage

element

double

optional

The commission percentage.

Profiles

element

RelatedProfile

optional

The profiles.

SystemStatus

element

string

optional

The system status.

ContractMiscellaneous

 

<xs:complexType name="ContractMiscellaneous">

<xs:sequence>

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

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

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

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

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

ContractDate

element

date

optional

The contract date.

EstimatedClosingDate

element

date

optional

The estimated closing date.

RealEstateAgent

element

string

optional

The real estate agent.

SalesAssociate

element

string

optional

The sales associate.

PurchasePrice

element

Amount

optional

The purchase price.

Comments

element

Text

optional

The comments.

ContractPoints

 

<xs:complexType name="ContractPoints">

<xs:sequence>

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

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

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

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

<xs:element minOccurs="0" maxOccurs="1" name="Points" type="xs:double" />

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

RecordId

element

long

optional

The record ID.

PointType

element

string

optional

The point type.

Dates

element

TimeSpan

optional

The dates.

RateCode

element

string

optional

The rate code.

Points

element

double

optional

The points.

SystemStatus

element

string

optional

The system status.

ContractProfileType

 

<xs:simpleType name="ContractProfileType">

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

<xs:enumeration value="PRIMARYOWNER" />

<xs:enumeration value="CO-OWNER" />

<xs:enumeration value="FRIENDS_AND_FAMILY" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

ContractProfileType

enumeration

string

 

The possible values are PRIMARYOWNER, CO-OWNER and FRIENDS_AND_FAMILY.

ContractRestriction

 

<xs:complexType name="ContractRestriction">

<xs:sequence>

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

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

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

<xs:element minOccurs="0" maxOccurs="1" name="MaximumNights" type="xs:integer" />

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

<xs:element minOccurs="0" maxOccurs="1" name="UsedNights" type="xs:integer" />

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

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

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

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

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

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

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

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

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

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

<xs:element minOccurs="0" maxOccurs="1" name="CompNights" type="xs:integer" />

<xs:element minOccurs="0" maxOccurs="1" name="OwnerMaximum" type="xs:double" />

<xs:element minOccurs="0" maxOccurs="1" name="AuthMaximum" type="xs:double" />

<xs:element minOccurs="0" maxOccurs="1" name="AdjustmentValue" type="xs:double" />

<xs:element minOccurs="0" maxOccurs="1" name="Rate" type="xs:double" />

</xs:sequence>

<xs:attribute name="type" xmlns:q3="http://webservices.micros.com/og/4.3/UnitOwners/" type="q3:ContractRestrictionType" />

<xs:attribute name="restriction" xmlns:q4="http://webservices.micros.com/og/4.3/UnitOwners/" type="q4:ContractRestrictionRestriction" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

type

Attribute

ContractRestrictionType

none

The contract restriction type.

restriction

Attribute

ContractRestrictionRestriction

none

The contract restriction.

RecordId

Element

long

optional

The record ID.

RestrictionType

Element

string

optional

The restriction type.

Dates

Element

TimeSpan

optional

The dates.

MaximumNights

Element

integer

optional

The maximum rate.

MinimumRate

Element

Amount

optional

The minimum rate.

UsedNights

Element

integer

optional

The used nights.

ParentId

Element

long

optional

The parent ID.

Day1

Element

string

optional

Day1

Day2

Element

string

optional

Day2

Day3

Element

string

optional

Day3

Day4

Element

string

optional

Day4

Day5

Element

string

optional

Day5

Day6

Element

string

optional

Day6

Day7

Element

string

optional

Day7

SystemStatus

Element

string

optional

The system status.

AdjustmentReason

Element

string

optional

The adjustment reason.

CompNights

Element

integer

optional

The comp nights.

OwnerMaximum

Element

double

optional

The owner maximum.

AuthMaximum

Element

double

optional

The auth maximum.

AdjustmentValue

Element

double

optional

The adjustment value.

Rate

Element

double

optional

The rate.

ContractRestrictionRestriction

 

<xs:simpleType name="ContractRestrictionRestriction">

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

<xs:enumeration value="BlackOut" />

<xs:enumeration value="AdvanceBooking" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

ContractRestrictionRestriction

enumeration

string

 

The possible values are BlackOut and AdvanceBooking.

ContractRestrictionType

 

<xs:simpleType name="ContractRestrictionType">

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

<xs:enumeration value="Owner" />

<xs:enumeration value="AuthorizedUser" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

ContractRestrictionType

enumeration

string

 

The possible values are Owner and AuthorizedUser.

ContractTask

 

<xs:complexType name="ContractTask">

<xs:sequence>

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

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

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

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

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

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

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

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

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

<xs:element minOccurs="0" maxOccurs="1" name="Sequence" type="xs:integer" />

<xs:element minOccurs="0" maxOccurs="1" name="Nights" type="xs:integer" />

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

RecordId

element

long

optional

The record ID.

TaskCode

element

string

optional

The task code.

Amount

element

Amount

optional

The amount.

TaskRhythm

element

string

optional

The task rhythm.

TransactionCode

element

string

optional

The transaction code.

PostTo

element

string

optional

Post to.

OccupiedBy

element

string

optional

Occupied by.

PostingRule

element

string

optional

The posting rule.

SystemStatus

element

string

optional

The system status.

Sequence

element

integer

optional

The sequence.

Nights

element

integer

optional

The nights.

ContractProfileType

 

<xs:simpleType name="ContractProfileType">

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

<xs:enumeration value="PRIMARYOWNER" />

<xs:enumeration value="CO-OWNER" />

<xs:enumeration value="FRIENDS_AND_FAMILY" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

ContractProfileType

enumeration

string

 

The possible values are PRIMARYOWNER, CO-OWNER, and FRIENDS_AND_FAMILY.

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:choice minOccurs="1" maxOccurs="1">

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

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

<xs:element minOccurs="0" maxOccurs="1" name="Track2" 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:element minOccurs="0" maxOccurs="1" name="EncryptedSwipe" xmlns:q2="http://webservices.micros.com/og/4.3/Common/" type="q2:EncryptedSwipe" />

</xs:sequence>

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

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

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

cardType

attribute

string

none

The type of payment card (i.e. credit, Debit, voucher, etc.)

otherCardType

attribute

string

none

Not used in this context.

chipAndPin

attribute

boolean

none

The chip and pin information.

cardCode

element

string

optional

The credit card vendor code (i.e. VA, AX, etc.).

cardHolderName

element

string

optional

The name on the face of the card.

cardNumber

element

string

optional

The card number.

VaultedCardData

element

VaultedCardType

optional

The vaulted card data.

seriesCode

element

string

optional

The card series code.

Track2

element

string

optional

Track 2 information.

effectiveDate

element

date

optional

Not used in this context.

expirationDate

element

date

required

The card expiration date.

EncryptedSwipe

element

EncryptedSwipe

optional

The encrypted swipe.

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:attribute name="profileType" type="xs:string" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

gender

attribute

Gender

none

The gender.

birthDate

attribute

date

none

The birth date.

profileType

attribute

string

none

The profile type.

PersonName

element

PersonName

optional

The person’s name.

NativeName

element

NativeName

optional

The native name.

BusinessTitle

element

string

optional

The business title.

GovernmentIDList

element

ArrayOfGovernmentID

optional

A collection of government ID elements.

DepositRequirement

 

<xs:complexType name="DepositRequirement">

<xs:sequence>

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

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

DepositAmount

element

Amount

optional

The required deposit amount.

DueDate

element

date

optional

The due date.

DepositDueAmount

element

Amount

optional

The deposit amount due.

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

Not used in this context.

Text

element

ArrayOfTextElement

optional

A text-list object containing check-in or check-out information.

Url

element

anyURI

optional

Not used in this context.

Discount

 

<xs:complexType name="Discount">

<xs:sequence>

<xs:element minOccurs="1" maxOccurs="1" name="DiscountAmount" type="xs:double" />

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

DiscountAmount

element

double

required

The discount amount.

DiscountType

element

DiscountType

required

The discount type.

DiscountReason

element

string

optional

The discount reason.

DiscountType

 

<xs:simpleType name="DiscountType">

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

<xs:enumeration value="FLAT" />

<xs:enumeration value="PERCENT" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

DiscountType

enumeration

string

 

The possible values are FLAT and PERCENT.

EncryptedSwipe

 

<xs:complexType name="EncryptedSwipe">

<xs:sequence>

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

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

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

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

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

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

TrackIndicator

element

string

optional

The track indicator.

SwiperType

element

string

optional

The swiper type.

SwiperID

element

string

optional

The swiper ID.

MaskedPAN

element

string

optional

The masked pan.

Track1

element

string

optional

The track 1.

Track2

element

string

optional

The track 2.

KeySerialNumber

element

string

optional

The key serial number.

GdsFlags

 

<xs:complexType name="GdsFlags">

<xs:sequence>

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

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

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

</xs:sequence>

</xs:complexType>

 

 

Name

Type

Data Type

Use

Comments

LateArrivalTime

element

string

optional

The late arrival time.

CancellationCode

element

string

optional

The cancellation code.

GuarCancelFlag

element

string

optional

The guar cancel flag.

GdsTotalPricing

 

<xs:complexType name="GdsTotalPricing">

<xs:sequence>

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

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

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

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

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

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

</xs:sequence>

</xs:complexType>

 

 

Name

Type

Data Type

Use

Comments

TotalInclusiveRoomRate

element

Amount

optional

The total inclusive room rate.

TotalExclusiveRoomRate

element

Amount

optional

The total exclusive room rate.

TotalTax

element

Amount

optional

The total tax.

TotalSurCharge

element

Amount

optional

The total surcharge.

TaxQualifier

element

string

optional

The tax qualifier.

MatchingQualifier

element

string

optional

The matching qualifier.

GdsTotalPricingTax

 

<xs:complexType name="GdsTotalPricingTax">

<xs:sequence>

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

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

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

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

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

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

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

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

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

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

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

</xs:sequence>

<xs:attribute name="decimals" type="xs:short" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

decimals

attribute

short

none

The decimals.

EffectiveStartDate

element

date

required

The effective start date.

EffectiveEndDate

element

date

required

The effective end date.

TaxOrFeeOrder

element

string

optional

Tax or fee order.

TaxOrFeeBasis

element

string

optional

Tax or fee basis.

TaxOrFeeAmount

element

string

optional

The tax or fee amount.

TaxOrFeeApplication

element

string

optional

The tax or fee application.

TaxOrFeeTypeCode

element

string

optional

The tax or fee type code.

ChargeType

element

string

optional

The charge type.

TaxDescription

element

string

optional

The tax description.

CurrencyCode

element

string

optional

The currency code.

TaxOrFeeIncluded

element

string

optional

The tax or fee included.

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:attribute name="documentID" type="xs:int" />

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

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

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

documentType

attribute

string

none

The type of ID.

documentNumber

attribute

string

none

The ID 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 country of issue.

documentID

attribute

int

none

The document ID.

resort

attribute

string

none

The resort.

primary

attribute

boolean

none

The primary.

displaySequence

attribute

int

none

The display sequence.

Guarantee

 

<xs:complexType name="Guarantee">

<xs:sequence>

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

<xs:element minOccurs="0" maxOccurs="1" name="Deadline" type="xs:dateTime" />

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

</xs:sequence>

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

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

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

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

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

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

guaranteeType

attribute

string

none

The guarantee type.

mandatoryDeposit

attribute

boolean

none

The mandatory deposit.

cancellationRequired

attribute

boolean

none

The cancellation Required.

creditCardRequired

attribute

boolean

none

The Required Credit card.

paymentType

attribute

string

none

The payment type.

requirementCode

attribute

string

none

The requirement code.

GuaranteesAccepted

element

ArrayOfGuaranteeAccepted

optional

The Guarantees Accepted.

Deadline

element

dateTime

optional

The deadline.

GuaranteeDescription

element

Paragraph

optional

The Guarantee Description.

GuaranteeAccepted

 

<xs:complexType name="GuaranteeAccepted">

<xs:sequence>

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

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

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

</xs:sequence>

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

agentPhone

attribute

string

none

The agent phone.

GuaranteeCreditCard

element

CreditCard

optional

The Guarantee Credit Card.

GuaranteeTravelAgent

element

UniqueID

optional

The Guarantee Travel Agent.

GuaranteeCompany

element

UniqueID

optional

The Guarantee Company.

GuestCount

 

<xs:complexType name="GuestCount">

<xs:attribute name="ageQualifyingCode" xmlns:q1="http://webservices.micros.com/og/4.3/HotelCommon/" type="q1:AgeQualifyingCode" />

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

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

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

ageQualifyingCode

attribute

AgeQualifyingCode

none

This value specifies the age qualifying code.

otherAgeQualifyingCode

attribute

string

none

If the age qualifying code value is set to other, then this is the other code.

age

attribute

int

none

Reserved for future use.

count

attribute

int

none

The number of guests in this age bracket or of this age.

GuestCountList

 

<xs:complexType name="GuestCountList">

<xs:sequence>

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

</xs:sequence>

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

isPerRoom

attribute

boolean

none

The number of guests allowed per room.

GuestCount

element

GuestCount

optional / multiple

The total number of guests.

HotelReference

 

<xs:complexType name="HotelReference">

<xs:simpleContent>

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

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

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

</xs:extension>

</xs:simpleContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

HotelReference

extension

string

 

References the hotel to include in the query. This is more for informational purposes.

chainCode

attribute

string

none

The chain code.

hotelCode

attribute

string

none

The hotel code.

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 OPERA ID.

externalId

attribute

string

none

The external ID.

InsurancePolicy

 

<xs:complexType name="InsurancePolicy">

<xs:sequence>

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

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

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

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

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

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

RecordId

element

long

optional

The record ID.

PolicyNumber

element

string

optional

The policy number.

InsuranceType

element

string

optional

The insurance type.

EffectiveDates

element

TimeSpan

optional

The effective dates.

Company

element

Profile

optional

The company.

Required_For_Rental

element

boolean

optional

The required for rental.

SystemStatus

element

string

optional

The system status.

KeyWord

 

<xs:complexType name="KeyWord">

<xs:sequence>

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Type

element

string

optional

The keyword type.

Value

element

string

optional

The keyword value.

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="membershipNextLevel" 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:double" />

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

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

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

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

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

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

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

membershipType

element

string

optional

The membership type.

membershipNumber

element

string

optional

The membership number.

membershipLevel

element

string

optional

The membership level.

membershipNextLevel

element

string

optional

The next membership level.

memberName

element

string

optional

The member’s name.

effectiveDate

element

date

optional

The effective date.

expirationDate

element

date

optional

The expiration date.

currentPoints

element

double

optional

The current number of points.

enrollmentCode

element

string

optional

The enrollment code.

ResvNameId

element

ArrayOfUniqueID

optional

The reservation name ID.

membershipid

element

UniqueID

optional

The membership ID.

transferPoints

element

long

optional

Transfer points.

enrollmentSource

element

string

optional

The enrollment source.

enrolledAt

element

string

optional

Enrolled at.

awardPointsToExpires

element

ArrayOfAwardPointsToExpire

optional

The award points to expire.

inactive

element

boolean

optional

Inactive status.

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 NameAddress extension.

operaId

attribute

long

none

Not used in this context.

externalId

attribute

string

none

Not used in this context.

primary

attribute

boolean

none

An indication of whether or not this address should be considered as the guest / entity’s “primary” address.

displaySequence

attribute

int

none

If provided, the system attempts to display this specific address in the order sequence indicated.

insertUser

attribute

string

none

Not used in this context.

insertDate

attribute

dateTime

none

Not used in this context.

updateUser

attribute

string

none

Not used in this context.

updateDate

attribute

dateTime

none

Not used in this context.

inactiveDate

attribute

date

none

Not used in this context.

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

 

Not used in this context.

operaId

attribute

long

none

Not used in this context.

externalId

attribute

string

none

Not used in this context.

primary

attribute

boolean

none

Not used in this context.

displaySequence

attribute

int

none

Not used in this context.

insertUser

attribute

string

none

Not used in this context.

insertDate

attribute

dateTime

none

Not used in this context.

updateUser

attribute

string

none

Not used in this context.

updateDate

attribute

dateTime

none

Not used in this context.

inactiveDate

attribute

date

none

Not used in this context.

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:attribute name="emailType" type="xs:string" />

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

</xs:extension>

</xs:simpleContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

NameEmail

extension

string

 

Email information.

operaId

attribute

long

none

The internal OPERA ID. It is returned by any calling system when attempting to update or delete this email.

externalId

attribute

string

none

Not used in this context.

primary

attribute

boolean

none

An indication of whether or not this email is considered to be the guest’s “primary” email.

displaySequence

attribute

int

none

If specified, 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 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.

emailType

attribute

string

none

The email type.

emailFormat

attribute

string

none

The email format.

NameMembership

 

<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:attribute name="extension" type="xs:string" />

</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 to be the guest’s “primary” membership.

preferred

Attribute

boolean

none

An indication of whether or not the guest is a preferred member.

central

Attribute

boolean

none

Not used in this context.

membershipClass

Attribute

string

none

Not used in this context.

pointsLabel

Attribute

string

none

Not used in this context.

status

Attribute

string

none

Not used in this context.

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 that the record was last modified.

inactiveDate

Attribute

date

none

Not used in this context.

usedInReservation

Attribute

boolean

none

The reservation used in.

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

 

Phone information.

operaId

attribute

long

none

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

externalId

attribute

string

none

Not used in this context.

primary

attribute

boolean

none

An indication of whether or not this number is considered to be the guest/entity’s “primary” phone number.

displaySequence

attribute

int

none

If specified, 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 the record was originally created.

updateUser

attribute

string

none

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

updateDate

attribute

dateTime

none

The date and time the record was last modified.

inactiveDate

attribute

date

none

Not used in this context.

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 guest’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 actual internal value assigned to the record in OPERA. Not used in this context.

resortCode

attribute

string

none

Not used in this context.

rateCode

attribute

string

none

The rate code.

commissionCode

attribute

string

none

The commission code.

beginDate

attribute

date

none

The effective date.

endDate

attribute

date

none

The expiration date.

displaySequence

attribute

int

none

The display sequence.

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.

PackageDetailCharges

 

<xs:complexType name="PackageDetailCharges">

<xs:sequence>

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

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

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

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

StartDate

element

date

optional

The start date.

EndDate

element

date

optional

The end date.

Allowance

element

Amount

optional

The allowance.

Amount

element

Amount

optional

The amount.

TaxAmount

element

Amount

optional

The tax amount.

PackageElement

 

<xs:complexType name="PackageElement">

<xs:sequence>

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

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

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

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

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

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

<xs:element minOccurs="0" maxOccurs="unbounded" name="PackageDetails" xmlns:q7="http://webservices.micros.com/og/4.3/HotelCommon/" type="q7:PackageDetailCharges" />

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

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

</xs:sequence>

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

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

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

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

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

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

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

<xs:attribute name="startTime" type="xs:time" />

<xs:attribute name="endTime" type="xs:time" />

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

<xs:attribute name="totalDepositAmount" type="xs:double" />

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

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

packageCode

attribute

string

none

The package code.

calculationRule

attribute

string

none

The calculation rule.

postingRhythm

attribute

string

none

The posting rhythm.

quantity

attribute

int

none

The quantity.

includedInRate

attribute

boolean

none

The included rate.

addRateSeprateLine

attribute

boolean

none

To add rate to a seprate line.

addRateCombinedLine

attribute

boolean

none

To add a rate to a combined line.

startTime

attribute

time

none

The start time.

endTime

attribute

time

none

The end time.

sellSeparate

attribute

boolean

none

To sell separate.

totalDepositAmount

attribute

double

none

The total deposit amount.

source

attribute

string

none

The source.

taxIncluded

attribute

boolean

none

The tax included.

Amount

element

Amount

optional

The amount.

PackageAmount

element

Amount

optional

The package amount.

TaxAmount

element

Amount

optional

The tax amount.

Allowance

element

Amount

optional

The allowance.

Description

element

DescriptiveText

optional / multiple

The dscription.

ShortDescription

element

DescriptiveText

optional / multiple

The short description.

PackageDetails

element

PackageDetailCharges

optional / multiple

The package details.

StartDate

element

date

optional

The start date.

EndDate

element

date

optional

The end date.

Paragraph

 

<xs:complexType name="Paragraph">

<xs:sequence>

<xs:choice minOccurs="0" maxOccurs="unbounded">

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

<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:Text" />

</xs:choice>

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

URL

element

anyURI

optional

Not used in this context.

Image

element

string

optional

Not used in this context.

Text

element

Text

optional

Text.

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:element minOccurs="0" maxOccurs="1" name="accountName2" type="xs:string" />

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

</xs:sequence>

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

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

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

nameOrdered

attribute

string

none

The display sequence.

familiarName

attribute

string

none

The familiar name.

active

attribute

boolean

none

Active indicator.

nameTitle

element

string

optional / multiple

The title, if applicable.

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.

accountName2

element

string

optional

Account name 2.

accountName3

element

string

optional

Account name 3.

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:attribute name="primaryPhone" type="xs:boolean" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

phoneType

attribute

string

none

The type of the number provided, such as HOME or BUSINESS (Validated).

phoneRole

attribute

string

none

The role of the phone device, such as PHONE, EMAIL, or FAX.

primaryPhone

attribute

boolean

none

The primary phone.

PhoneNumber

element

string

optional

The phone number, including all required country and area code prefixes.

PhoneData

element

PhonePhoneData

optional

Not used in this context.

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

Not used in this context.

preferenceType

attribute

string

none

Not used in this context.

otherPreferenceType

attribute

string

none

Not used in this context.

preferenceValue

attribute

string

none

Not used in this context.

insertUser

attribute

string

none

Not used in this context.

insertDate

attribute

dateTime

none

Not used in this context.

updateUser

attribute

string

none

Not used in this context.

updateDate

attribute

dateTime

none

Not used in this context.

inactiveDate

attribute

date

none

Not used in this context.

PreferenceDescription

element

DescriptiveText

optional

Not used in this context.

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

A collection of OptionType elements.

OptionValue

attribute

PrivacyOptionTypeOptionValue

required

The privacy option value selected.

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="Company" xmlns:q2="http://webservices.micros.com/og/4.3/Name/" type="q2:Company" />

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

</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:element minOccurs="0" maxOccurs="1" name="StayHistory" xmlns:q16="http://webservices.micros.com/og/4.3/Name/" type="q16:StayHistoryData" />

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

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

<xs:element minOccurs="0" maxOccurs="1" name="Features" xmlns:q19="http://webservices.micros.com/og/4.3/HotelCommon/" type="q19:ArrayOfRoomFeature" />

</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:attribute name="active" type="xs:boolean" />

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

nameType

attribute

string

none

The name type.

protected

attribute

boolean

none

An indication of whether or not the profile is protected.

languageCode

attribute

string

none

The language code.

nationality

attribute

string

none

The nationality.

vipCode

attribute

string

none

The VIP code.

taxExempt

attribute

boolean

none

The tax exempt number.

insertUser

attribute

string

none

The user ID.

insertDate

attribute

dateTime

none

The date.

updateUser

attribute

string

none

The user ID.

updateDate

attribute

dateTime

none

The update date.

inactiveDate

attribute

date

none

The inactive date.

active

attribute

boolean

none

Indicates active.

ProfileIDs

element

ArrayOfUniqueID

optional

A collection of UniqueID elements.

Customer

element

Customer

optional

The customer.

Company

element

Company

optional

The company name.

CreditCards

element

ArrayOfNameCreditCard

optional

Credit card information.

Addresses

element

ArrayOfNameAddress

optional

Address information.

Blacklist

element

BlackList

optional

Blacklist information.

Phones

element

ArrayOfNamePhone

optional

Phone number information.

Preferences

element

ArrayOfPreference

optional

Preference information.

EMails

element

ArrayOfNameEmail

optional

Email information.

Memberships

element

ArrayOfNameMembership

optional

Membership information.

NegotiatedRates

element

ArrayOfNegotiatedRate

optional

Negotiated rates information.

Comments

element

ArrayOfComment

optional

Comments.

UserDefinedValues

element

ArrayOfUserDefinedValue

optional

Any user defined values.

Privacy

element

ArrayOfPrivacyOptionType

optional

Privacy information.

UserGroup

element

ProfileUserGroup

optional

The user group profile.

StayHistory

element

StayHistoryData

optional

The stay history.

Id

element

GovernmentID

optional

The ID.

KeyWord

element

ArrayOfKeyWord

optional

The keyword.

Features

element

ArrayOfRoomFeature

optional

The features.

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.

Rate

 

<xs:complexType name="Rate">

<xs:sequence>

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

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

<xs:element minOccurs="0" maxOccurs="1" name="AdditionalBedAmounts" xmlns:q3="http://webservices.micros.com/og/4.3/HotelCommon/" type="q3:ArrayOfAdditionalBedAmount" />

<xs:element minOccurs="0" maxOccurs="1" name="GdsTotalPricingTaxes" xmlns:q4="http://webservices.micros.com/og/4.3/HotelCommon/" type="q4:ArrayOfGdsTotalPricingTax" />

<xs:element minOccurs="0" maxOccurs="1" name="Points" type="xs:double" />

</xs:sequence>

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

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

<xs:attribute name="rateOccurrence" xmlns:q5="http://webservices.micros.com/og/4.3/HotelCommon/" type="q5:RateOccurrenceType" />

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

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

insertUser

attribute

string

none

The insert user.

effectiveDate

attribute

date

none

Not used in a General Availability response. In a Detail Availability response, if there are rate amount changes throughout the length of stay, this date becomes required.

expirationDate

attribute

date

none

Not used in a General Availability response. In a Detail Availability response, if there are rate amount changes throughout the length of stay, this date becomes required.

rateOccurrence

attribute

RateOccurrenceType

none

For this interface instance this will always be set to “Daily”.

otherRateOccurrence

attribute

string

none

Not used in this context.

rateChangeIndicator

attribute

boolean

none

If there is a change in the rate amount at any point throughout the duration of the stay, this flag must be set.

Base

element

Amount

optional

The anticipated daily or base rate for the stay.

AdditionalGuestAmounts

element

ArrayOfAdditionalGuestAmount

optional

Not used in a General Availability response. In a Detail Availability response, this will be populated if additional guest amounts are attached to rate.

AdditionalBedAmounts

element

ArrayOfAdditionalBedAmount

optional

Not used in a General Availability response. In a Detail Availability response, this will be populated if additional bed amounts are attached to the rate.

GdsTotalPricingTaxes

element

ArrayOfGdsTotalPricingTax

optional

The list of GDS total pricing tax.

RateOccurrenceType

 

<xs:simpleType name="RateOccurrenceType">

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

<xs:enumeration value="DAILY" />

<xs:enumeration value="WEEKLY" />

<xs:enumeration value="OTHER" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

RateOccurrenceType

enumeration

string

 

The possible values are DAILY, WEEKLY, and OTHER.

RatePlan

 

<xs:complexType name="RatePlan">

<xs:sequence>

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

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

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

<xs:element minOccurs="0" maxOccurs="1" name="AdditionalDetails" xmlns:q4="http://webservices.micros.com/og/4.3/HotelCommon/" type="q4:ArrayOfAdditionalDetail" />

<xs:element minOccurs="0" maxOccurs="1" name="CancellationDateTime" xmlns:q5="http://webservices.micros.com/og/4.3/HotelCommon/" type="q5:CancelDateTime" />

<xs:element minOccurs="0" maxOccurs="1" name="DepositRequired" xmlns:q6="http://webservices.micros.com/og/4.3/HotelCommon/" type="q6:DepositRequirement" />

<xs:element minOccurs="0" maxOccurs="1" name="GdsFlags" xmlns:q7="http://webservices.micros.com/og/4.3/HotelCommon/" type="q7:GdsFlags" />

<xs:element minOccurs="0" maxOccurs="1" name="GuaranteeDetails" xmlns:q8="http://webservices.micros.com/og/4.3/HotelCommon/" type="q8:ArrayOfGuarantee" />

<xs:element minOccurs="0" maxOccurs="1" name="MealPlanCodes" xmlns:q9="http://webservices.micros.com/og/4.3/HotelCommon/" type="q9:AmenityInfo" />

<xs:element minOccurs="0" maxOccurs="1" name="Packages" xmlns:q10="http://webservices.micros.com/og/4.3/HotelCommon/" type="q10:ArrayOfPackageElement" />

<xs:element minOccurs="0" maxOccurs="1" name="Discount" xmlns:q11="http://webservices.micros.com/og/4.3/HotelCommon/" type="q11:Discount" />

</xs:sequence>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

ratePlanCategory

attribute

string

none

The channel converted rate category.

ratePlanCode

attribute

string

none

The channel converted rate code for the rate room pair.

promotionCode

attribute

string

none

If the booking is made under a promotion code, that promotion code will be indicated in this attribute.

qualifyingIdType

attribute

string

none

Not used in this context.

qualifyingIdValue

attribute

string

none

Not used in this context.

effectiveDate

attribute

date

none

Not used in this context.

expirationDate

attribute

date

none

Not used in this context.

hold

attribute

boolean

none

Not used in this context.

commissionYn

attribute

boolean

none

Commission Yes or No.

mandatoryDeposit

attribute

boolean

none

Not used in this context.

suppressRate

attribute

boolean

none

Supress rate.

ratePlanName

attribute

string

none

The rate plan name.

awardType

attribute

string

none

The award type.

redemRate

attribute

boolean

none

The redem rate.

commissionCode

attribute

string

none

The commission code.

asbRateCycle

attribute

string

none

The asb rate cycle.

hasPackage

attribute

boolean

none

The has package.

taxInclusive

attribute

boolean

none

Theinclusive tax.

blockName

attribute

string

none

The block name.

rankRate

attribute

boolean

none

The rank rate.

rateTypeIndicator

attribute

string

none

The rate type indicator.

postingRhythm

attribute

string

none

The posting rhythm.

RatePlanDescription

element

Paragraph

optional

A paragraph-type description of the rate plan.

Commission

element

Commission

optional

Not used in this context.

AdditionalDetails

element

ArrayOfAdditionalDetail

optional

Not used in this context.

CancellationDateTime

element

CancelDateTime

optional

Not used in this context.

DepositRequired

element

DepositRequirement

optional

Not used in this context.

GdsFlags

element

GdsFlags

optional

The GDS flags.

GuaranteeDetails

element

ArrayOfGuarantee

optional

The list of guarantee details.

MealPlanCodes

element

AmenityInfo

optional

The meal plan codes.

Packages

element

ArrayOfPackageElement

optional

The packages.

Discount

element

Discount

optional

The discount.

RelatedProfile

 

<xs:complexType name="RelatedProfile">

<xs:complexContent mixed="false">

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

<xs:attribute name="ContractProfileType" xmlns:q2="http://webservices.micros.com/og/4.3/UnitOwners/" type="q2:ContractProfileType" />

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

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

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

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

<xs:attribute name="revenuePercentage" type="xs:double" />

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

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

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

<xs:attribute name="accountCode" type="xs:unsignedLong" />

<xs:attribute name="CommissionPercentage" type="xs:double" />

</xs:extension>

</xs:complexContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

RelatedProfile

extension

Profile

 

The profile related to the contract.

ContractProfileType

attribute

ContractProfileType

none

The contract profile type.

Relationship

attribute

string

none

The relationship of the profile to the contract. (Owner, Co-Owner, or Friends & Family).

taxId

attribute

string

none

The tax ID.

primary

attribute

boolean

none

The primary.

changeUnit

attribute

boolean

none

The change unit.

revenuePercentage

attribute

double

none

The revenue percentage.

include1099

attribute

boolean

none

Indicated to include the 1099.

generalExciseTax

attribute

boolean

none

The general Excise Tax.

transientAccommodationTax

attribute

boolean

none

The transient accommodation tax.

accountCode

attribute

unsignedLong

none

The account code.

CommissionPercentage

attribute

double

none

The commission percentage.

RelatedProfileListRelatedProfiles

 

<xs:complexType name="RelatedProfileListRelatedProfiles">

<xs:complexContent mixed="false">

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

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

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

</xs:extension>

</xs:complexContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

RelatedProfileListRelatedProfiles

extension

RelatedProfile

 

The related profile list.

recordId

attribute

long

none

The record ID.

systemStatus

attribute

string

none

The system status.

RentalContract

 

<xs:complexType name="RentalContract">

<xs:sequence>

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

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

<xs:element minOccurs="0" maxOccurs="1" name="OwnerRevenueShare" type="xs:double" />

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

<xs:element minOccurs="0" maxOccurs="1" name="CommByOwner" type="xs:double" />

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

<xs:element minOccurs="0" maxOccurs="1" name="AutoRenewalMonths" type="xs:integer" />

<xs:element minOccurs="0" maxOccurs="1" name="ResvMaxNights" type="xs:integer" />

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

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

<xs:element minOccurs="0" maxOccurs="1" name="GraceMonths" type="xs:double" />

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

RecordId

element

long

optional

The record ID.

Dates

element

TimeSpan

optional

The dates.

OwnerRevenueShare

element

double

optional

The owner revenue share.

RevenueShareFormula

element

string

optional

The revenue share formula.

CommByOwner

element

double

optional

The community by owner.

AutoRenewalDate

element

date

optional

The Auto renewal date.

AutoRenewalMonths

element

integer

optional

The auto renewal months.

ResvMaxNights

element

integer

optional

The reservation max. nights.

LongTerm

element

boolean

optional

Indicates long term.

SystemStatus

element

string

optional

The system status.

GraceMonths

element

double

optional

The grace months.

RevenuePool

element

string

optional

The revenue pool.

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.

Room

 

<xs:complexType name="Room">

<xs:sequence>

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

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

RoomNumber

element

string

optional

The room number.

RoomDescription

element

Paragraph

optional

A description of the room.

RoomType

element

RoomType

optional

The room type.

RoomFeature

 

<xs:complexType name="RoomFeature">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="FeatureID" type="xs:double" />

</xs:sequence>

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

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

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Feature

attribute

string

none

The room feature.

Description

attribute

string

none

The feature description.

AttachPreferenceToProfile

attribute

boolean

none

The attach preference to the profile.

FeatureID

element

double

optional

The feature ID.

RoomRate

 

<xs:complexType name="RoomRate">

<xs:sequence>

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

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

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

<xs:element minOccurs="0" maxOccurs="1" name="TotalPoints" type="xs:double" />

<xs:element minOccurs="0" maxOccurs="1" name="GdsTotalPricing" xmlns:q4="http://webservices.micros.com/og/4.3/HotelCommon/" type="q4:GdsTotalPricing" />

<xs:element minOccurs="0" maxOccurs="1" name="Packages" xmlns:q5="http://webservices.micros.com/og/4.3/HotelCommon/" type="q5:ArrayOfPackageElement" />

</xs:sequence>

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

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

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

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

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

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

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

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

roomTypeCode

attribute

string

none

The channel converted room type code.

ratePlanCode

attribute

string

none

The channel converted rate code for the subject rate room pair.

effectiveDate

attribute

date

none

Not used in this context.

expirationDate

attribute

date

none

Not used in this context.

suppressRate

attribute

boolean

none

The supress rate.

redemRate

attribute

boolean

none

The redem rate.

hasPackage

attribute

boolean

none

Indicates has package.

pointsChangeIndicator

attribute

boolean

none

The points change indicator.

Rates

element

ArrayOfRate

optional

A collection of rate objects. In the case of General Availability, only one rate element will be present. In the case of a Detail Availability response, there may be more than one.

InvBlockDescription

element

Paragraph

optional

Reserved for future use.

Total

element

Amount

optional

The Total element, containing the anticipated total amount of the stay.

TotalPoints

element

double

optional

The total points.

GdsTotalPricing

element

GdsTotalPricing

optional

The GDS total pricing.

Packages

element

ArrayOfPackageElement

optional

The list of package elements.

RoomType

 

<xs:complexType name="RoomType">

<xs:sequence>

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

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

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

<xs:element minOccurs="0" maxOccurs="1" name="RoomToChargeDescription" xmlns:q3="http://webservices.micros.com/og/4.3/HotelCommon/" type="q3:Paragraph" />

<xs:element minOccurs="0" maxOccurs="1" name="RoomToChargeShortDescription" xmlns:q4="http://webservices.micros.com/og/4.3/HotelCommon/" type="q4:Paragraph" />

<xs:element minOccurs="0" maxOccurs="1" name="AmenityInfo" xmlns:q5="http://webservices.micros.com/og/4.3/HotelCommon/" type="q5:AmenityInfo" />

<xs:element minOccurs="0" maxOccurs="1" name="RoomFeatures" xmlns:q6="http://webservices.micros.com/og/4.3/HotelCommon/" type="q6:ArrayOfRoomFeature" />

</xs:sequence>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

roomTypeCode

attribute

string

none

The channel converted room type code.

feature

attribute

string

none

The room feature.

upgradeFromCode

attribute

string

none

The room type upgrade.

invBlockCode

attribute

string

none

The number of rooms available at the time the transaction is made.

numberOfUnits

attribute

int

none

For this interface instance, this will always be set to a default value of “true”.

isRoom

attribute

boolean

none

Not used in this context.

effectiveDate

attribute

date

none

Not used in this context.

expirationDate

attribute

date

none

Not used in this context.

roomTypeName

attribute

string

none

The room type name.

roomToChargeCode

attribute

string

none

The room to charge code.

roomToChargeName

attribute

string

none

The room to charge name.

roomStatus

attribute

string

none

The room status.

roomClass

attribute

string

none

The room class.

pseudoRoom

attribute

boolean

none

The pseudo room.

roomServiceStatus

attribute

string

none

The room service status.

minimumRoomsAvailable

attribute

int

none

The minimum rooms available.

RoomTypeDescription

element

Paragraph

optional

A paragraph containing the description of the room type.

RoomTypeShortDescription

element

Paragraph

optional

The room type short  descripton.

RoomNumber

element

string

optional / multiple

The room number.

RoomToChargeDescription

element

Paragraph

optional

The room to charge description.

RoomToChargeShortDescription

element

Paragraph

optional

The room to charge short description.

AmenityInfo

element

AmenityInfo

optional

The amenity informaiton.

RoomFeatures

element

ArrayOfRoomFeature

optional

The room features.

StayHistoryData

 

<xs:complexType name="StayHistoryData">

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="LastStay" type="xs:dateTime" />

<xs:element minOccurs="0" maxOccurs="1" name="TotalNumberOfStays" type="xs:unsignedInt" />

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

LastStay

element

dateTime

optional

The last stay.

TotalNumberOfStays

element

unsignedInt

optional

The total number of stays.

LastRoomNumber

element

string

optional

The last room number.

LastRate

element

Amount

optional

The last rate.

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

 

The error message text.

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

 

Text.

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.

TimeSpan

 

<xs:complexType name="TimeSpan">

<xs:sequence>

<xs:element minOccurs="1" maxOccurs="1" name="StartDate" type="xs:dateTime" />

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

<xs:element minOccurs="0" maxOccurs="1" name="Duration" type="xs:duration" />

<xs:element minOccurs="1" maxOccurs="1" name="EndDate" type="xs:dateTime" />

</xs:choice>

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

StartDate

element

dateTime

required

The arrival date of the stay.

Duration

element

duration

optional

The duration of the stay.

EndDate

element

dateTime

required

The departure date of the stay.

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

 

If the parent element is present, it must contain at least one UniqueID element.

type

attribute

UniqueIDType

required

The internal OPERA reservation ID.

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.

UnitContract

 

<xs:complexType name="UnitContract">

<xs:sequence>

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

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

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

<xs:element minOccurs="0" maxOccurs="1" name="Unit" xmlns:q3="http://webservices.micros.com/og/4.3/HotelCommon/" type="q3:Room" />

<xs:element minOccurs="0" maxOccurs="1" name="RatePlan" xmlns:q4="http://webservices.micros.com/og/4.3/HotelCommon/" type="q4:RatePlan" />

<xs:element minOccurs="0" maxOccurs="1" name="ValidDates" xmlns:q5="http://webservices.micros.com/og/4.3/HotelCommon/" type="q5:TimeSpan" />

<xs:element minOccurs="0" maxOccurs="1" name="PrimaryOwner" xmlns:q6="http://webservices.micros.com/og/4.3/UnitOwners/" type="q6:RelatedProfile" />

<xs:element minOccurs="0" maxOccurs="1" name="AuthorizedProfiles" xmlns:q7="http://webservices.micros.com/og/4.3/UnitOwners/" type="q7:ArrayOfRelatedProfileListRelatedProfiles" />

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

<xs:element minOccurs="0" maxOccurs="1" name="RequesterContractProfileType" xmlns:q8="http://webservices.micros.com/og/4.3/UnitOwners/" type="q8:ContractProfileType" />

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

<xs:element minOccurs="0" maxOccurs="1" name="Status" xmlns:q9="http://webservices.micros.com/og/4.3/UnitOwners/" type="q9:UnitContractStatus" />

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

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

ContractId

element

UniqueID

optional

The contract ID number.

HotelReference

element

HotelReference

optional

The hotel reference number.

ContractNumber

element

string

optional

The contract number.

Unit

element

Room

optional

The unit number.

RatePlan

element

RatePlan

optional

The rate plan.

ValidDates

element

TimeSpan

optional

The valid dates of the contract.

PrimaryOwner

element

RelatedProfile

optional

The name of the primary owner.

AuthorizedProfiles

element

ArrayOfRelatedProfile

optional

User profiles that are authorized on the contract.

ContractType

element

string

optional

The type of contract.

RequesterContractProfileType

element

ContractProfileType

optional

The type of requester contract profile.

RentalProgram

element

boolean

optional

An indication of whether or not this is part of the rental program.

Status

element

UnitContractStatus

optional

The unit contracty status.

TemplateCode

element

string

optional

The template code.

IgnoreTemplateUpdate

element

boolean

optional

Ingore the template update.

FractionalOwners

element

boolean

optional

The fractional owners.

UnitContractDetails

 

<xs:complexType name="UnitContractDetails">

<xs:complexContent mixed="false">

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

<xs:sequence>

<xs:element minOccurs="0" maxOccurs="1" name="RevenueShare" type="xs:double" />

<xs:element minOccurs="0" maxOccurs="1" name="CommissionShare" type="xs:double" />

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

<xs:element minOccurs="0" maxOccurs="1" name="Restrictions" type="q1:ArrayOfContractRestriction" />

<xs:element minOccurs="0" maxOccurs="1" name="RentalContracts" type="q1:ArrayOfRentalContract" />

<xs:element minOccurs="0" maxOccurs="1" name="Deductions" type="q1:ArrayOfContractDeduction" />

<xs:element minOccurs="0" maxOccurs="1" name="Fees" type="q1:ArrayOfContractFees" />

<xs:element minOccurs="0" maxOccurs="1" name="Tasks" type="q1:ArrayOfContractTask" />

<xs:element minOccurs="0" maxOccurs="1" name="Points" type="q1:ArrayOfContractPoints" />

<xs:element minOccurs="0" maxOccurs="1" name="ContractDocuments" type="q1:ArrayOfContractDocument" />

<xs:element minOccurs="0" maxOccurs="1" name="InsurancePolicies" type="q1:ArrayOfInsurancePolicy" />

<xs:element minOccurs="0" maxOccurs="1" name="Elements" type="q1:ArrayOfContractElement" />

<xs:element minOccurs="0" maxOccurs="1" name="Fractionals" type="q1:ArrayOfContractFractional" />

<xs:element minOccurs="0" maxOccurs="1" name="Miscellaneous" type="q1:ContractMiscellaneous" />

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

UnitContractDetails

extension

UnitContract

 

The unit contract details.

RevenueShare

element

double

optional

The revenue share.

CommissionShare

element

double

optional

The commission share.

ModifiedUnit

element

boolean

optional

An indication of whether or not this is a modified unit.

Restrictions

element

ArrayOfContractRestriction

optional

A collection of ContractRestriction elements.

RentalContracts

element

ArrayOfRentalContract

optional

A collection of RentalContract elements.

Deductions

element

ArrayOfContractDeduction

optional

A collection of contract deduction information.

Fees

element

ArrayOfContractFees

optional

A collection of fee information.

Tasks

element

ArrayOfContractTask

optional

A collection of tasks associated with the contract.

Points

element

ArrayOfContractPoints

optional

A collection of rotation point information.

ContractDocuments

element

ArrayOfContractDocument

optional

Any additional documents associated with the contract.

InsurancePolicies

element

ArrayOfInsurancePolicy

optional

Insurance policy information.

Elements

element

ArrayOfContractElement

optional

The list of contract elements.

Fractionals

element

ArrayOfContractFractional

optional

The list of fracionals contract.

Miscellaneous

element

ContractMiscellaneous

optional

The miscellaneous contract information.

UnitContractStatus

 

<xs:simpleType name="UnitContractStatus">

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

<xs:enumeration value="Actual" />

<xs:enumeration value="Negotiated" />

</xs:restriction>

</xs:simpleType>

 

Name

Type

Data Type

Use

Comments

UnitContractStatus

enumeration

string

 

The possible values are Actual and Negotiated.

UnitRate

 

<xs:complexType name="UnitRate">

<xs:sequence>

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

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

</xs:sequence>

</xs:complexType>

 

Name

Type

Data Type

Use

Comments

Unit

element

UnitContract

optional

The unit number.

Rates

element

ArrayOfRoomRate

optional

A collection of RoomRate elements.

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

Not used in this context.

CharacterValue

element

string

optional

Not used in this context.

DateValue

element

dateTime

required

Not used in this context.

NumericValue

element

double

required

Not used in this context.

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.

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.