rms knowledge base€¦ · 1.12 15.08.12 andrew buttigieg added consenttousecc, userdeﬁned 11-15...

RMS Knowledge Base

User Manual

Created: Monday, July 22, 2019

Copyright © RMS The Hospitality Cloud. All Rights Reserved.

RMS Knowledge Base

copyright © RMS The Hospitality Cloud. All rights reserved./

The information contained in this document is subject to change without notice.This document contains proprietary information which is protected by copyright.

All rights are reserved. No part of this document may be photocopied, reproduced,or translated to another language without the prior written consent of RMS The Hospitality Cloud.

RMS Knowledge BaseRMS Knowledge Base

6. Appendix B - VB.NET Examples

Copyright © 2014 RMS The Hospitality Cloud

Table of ContentsRMS Public Interface Specification 1 .........................................................................................

Version Updates 2 .............................................................................................................. 1. Contents 4 ...................................................................................................................... 2. Introduction 5 ................................................................................................................. 3. Protocol 6 ....................................................................................................................... 4. Public Methods 8 ............................................................................................................

4.1 - 4.5 10 .................................................................................................................. 4.6 - 4.10 12 ................................................................................................................ 4.11 - 4.15 14 .............................................................................................................. 4.16 - 4.20 16 .............................................................................................................. 4.21 - 4.25 18 .............................................................................................................. 4.26 - 4.30 20 .............................................................................................................. 4.31 - 4.35 22 .............................................................................................................. 4.36 - 4.40 24 .............................................................................................................. 4.41 - 4.45 26 .............................................................................................................. 4.46 - 4.50 28 .............................................................................................................. 4.51 - 4.53 30 ..............................................................................................................

5. Appendix A - Class Definitions 31 .................................................................................. 5.1 - 5.5 33 .................................................................................................................. 5.6 - 5.10 35 ................................................................................................................ 5.11 - 5.15 38 .............................................................................................................. 5.16 - 5.20 47 .............................................................................................................. 5.21 - 5.25 52 .............................................................................................................. 5.26 - 5.30 54 .............................................................................................................. 5.31 - 5.35 56 .............................................................................................................. 5.36 - 5.40 58 .............................................................................................................. 5.41 - 5.45 61 .............................................................................................................. 5.46 - 5.50 65 .............................................................................................................. 5.51- 5.55 68 ............................................................................................................... 5.56- 5.60 70 ............................................................................................................... 5.61- 5.65 73 ............................................................................................................... 5.66- 5.70 76 ............................................................................................................... 5.71 79 ........................................................................................................................

6. Appendix B - VB.NET Examples 81 ................................................................................. 6.1 Adding the Web Service Reference 82 .................................................................. 6.2 Retrieve Token and Property Name 84 ................................................................. 6.3 Transactions 85 ..................................................................................................... 6.4 Reservations 87 .................................................................................................... 6.5 Creating/Updating a Client 89 ............................................................................... 6.6 Using the Correct Webservice URL to initialise the WCF Client 91 ........................


Copyright © 2014 RMS The Hospitality Cloud Page 1

RMS Public Interface Specification


RMS Public Interface API


Public Interface Specification

Version Updates

Version DocumentUpdated

Updated By Changes Release Date

2.12 06.06.19 Hayden Paterson Bug Fix: TravelAgentLight - SaveTravelAgentDetails call is creating Agent with an Agent TYPEof '0' instead of '1'

Enhancment: "Guest Description" has been exposed onPublicService.GetListOfCategoriesDetail()

Bug Fix: GetListOfInvoices - doubling invoice amount Bug Fix: CurrentReservations on GetListOfClients returning an error

18.06.19

2.11 03.04.19 Hayden Paterson Bug Fix: SaveResDetails no updating secondary guestsBug Fix: Split reservations not being returned on GetListOfReservations

Bug Fix: ProcessTransaction not posting owner income Bug Fix:

When creating a client via the Public API it is using server time not property timeBug Fix: PublicService.GetListOfGroupAllotmentLite not returning company details or full

recordsBug Fix: GetListOfInvoices - BillTo is showing TravelAgent when wholesaler is selected

Bug Fix: Update API to reference student table for all calls referencing Client info.Enhancement:

Expose Key No #1 and Key No #2 in 4.8 GetListOfAreasSetup() as Class AreaSetup()Enhancement: Add Bill Category to GetListOfReservationsEnhancement: Add fieldModifiedID to GetListOfAuditTrail

Enhancment: Expose Code, Code 2 & Code 3 on GetListOfCategoriesDetailEnhancement:

Added RV Details to GetListOfClientsEnhancement:

Add last modified from and to dates to GetListOfTransactions

16.04.19

2.10 13.02.19 Hayden Paterson Bug Fix: GetListOfGroupAllotmentLite returning error "Method Not Found"Bug Fix: CurrentReservations on GetListOfClients returning an error

Bug Fix: SaveTravelAgentDetails is unable to save Function & Territory (CompetitorMaster_ID,CityMaster_ID)

Bug Fix: GetListOfGroupAllotmentLite not returning company details or full recordsEnhancement: Exposed Key No #1 and Key No #2 in 4.8 GetListOfAreasSetup() as Class

AreaSetup()

27.02.19

2.9 19.11.18 Hayden Paterson Bug Fix: GetListOfRateDetails returning PackageDetails not associated with rate Bug Fix: GetListOfReservations - ResOptionFieldList - DepositAmount - not returning any

valuesBug Fix: Projected Revenue and Rate calculations in Reservation Response

Enhancement: GetListOfInvoicesEnhancement: Ability to create tariff via Public API

27.11.18

2.8 08.09.18 Hayden Paterson Bug Fix: All charges from RMSPOS are to be considered as Local Currency.Bug Fix: MFI Error (for JDS) when recording checkout portion of a Room Move.

Enhancement: API to include Bill To information.Bug Fix: API not showing correct totals compared to RMS.Enhancement: Add Tariff Quoted Data to Res Response.

Enhancement: Additional of New Fields - ClientRecord - Add Nationality.Enhancement: Res API's to provides Operational Revenue projection for the Reservation.

Enhancement: Addition of New Field - Event Name - Reservation.Enhancement: Auto-Assignment of Room API for Lyf scenario.

Enhancement: Exposed Meal Plan to API.Enhancement: Addtion of new fields to GetListOfReservation - ResOptionalFieldList -

DailyRevenueBreakdown (Rate Table, Currency, Period, Rate Type, Rate ID).Enhancement: Addition of fields to ResLite (Address, Town, state, Postcode, Country).

Bug Fix: GetListOfReservation - ResOptionFieldList - DiscountAmount.Enhancement: Expose OTAref2 & OTAref2 on GetListOfReservation - ResOptionFieldList

Bug Fix: ListOfReceipts on GetListOfReservations should exclude reversed/voided receipts.Bug Fix: Error on SaveDocuments to create a Correspondence.

Bug Fix: RetrieveResLite API to retrieve a particular reservation which having VoucherNovalue.

Bug Fix: GetListOfReservations to get Guest's Account Id of this. Reservation Property but itreturns other property Guest's Account ID.

Bug Fix: API GetListOfReservations returns exception.Bug Fix: API GetListOfReservations returns null PrimaryClient.

26.09.18

2.7 04.07.18 Hayden Paterson Bug Fix: CompanyLite SaveCompanyDetails - “Trading As” field was not populated althoughthe value was specified.

Bug Fix: TravelAgentLite SaveTravelAgentDetails - Clients were receiving "A Sundry Chargemust be selected for use with a Commission" error upon saving a new Travel Agent record via

API. Addition of new fields to GetListofAgents: Spare fields have been added.

Addition of new fields to RetrieveTravelAgentLite: spare1/spare2/spare3/spare4/spare5Enhancement: City/Town/Suburb field in RMS9+ is currently poineted to Address2 on the

ClientRecord, this will now be pointed to Suburb.

11.07.18




2.6 05.06.18 Phuong Do Addition of new fields to GetListOfClients & GetListOfReservations: GDPR_PrivacyOptIn,Email_OptOut, SMS_OptOut, EDMFilter1OptOut, EDMFilter2OptOut, EDMFilter3OptOut &

LanguageSpoken. New API call GetListOfRateDetails

2.5 08.05.18 Phuong Do Modifed RetrieveCompanyLite, RetrieveTravelAgentLite,GetListOfClients, GetListOfPropertiesDetails, GetListOfReservations,

RetrieveBookingSourceLite, GetListOfTransactions, GetListOfAreasDetail, GetListOfRatesAdded GetListOfGLCodes Added GetListOfSundryChargesDetail Added GetListOfSubResTypes

Added GetListOfCategoriesDetail Added GetListOfMarketSegments

2.4 09.03.18 Phuong Do Added SaveDocuments, GetListOfCompanies2, GetListOfRates2 ModifiedGetListOfReservations, SaveCompanyDetails

2.3 21.01.18 Andrew Buttigieg Added ListOfAreaNames to ResRequest

Added Retrieve and Save functions for Company, Booking Source, Travel Agent and Helddetails

Added GetGLGroups function

Added Wholesaler property to TravelAgentLite

2.2 29.11.17 Phuong Do Added GetListOfAuditTrail Added Get, Save and Delete UserMessage

2.1 25.08.17 Phuong Do Added GetListOfTransactions and SaveResDetails, Modifed SaveClientDetails

2.0 06.10.15 Andrew Buttigieg Multi Data Centre Changes

1.19 26.02.13 Andrew Buttigieg Added AccountBalance to Client

1.18 08.02.13 Andrew Buttigieg Added Get, Create and Update ClientLite

1.17 30.10.12 Rocco Agostino Changes to the RetrieveTravelAgentLite and SaveTravelAgentDetails

1.16 26.10.12 Rocco Agostino Added RetrieveCompanyLite, RetrieveTravelAgentLite, RetrieveHoldLite, RetrieveHeldLite,SaveCompanyDetails, SaveTravelAgentDetails, SaveHoldDetails and SaveHeldDetails

1.15 16.10.12 Andrew Buttigieg Added PABX Ext to Area, Added Hold records to ResRecord

1.14 24.09.12 Andrew Buttigieg Added SaveClientDetails

1.13 12.09.12 Rocco Agostino Added GetAvailability per Property and/or Category

1.12 15.08.12 Andrew Buttigieg Added ConsentToUseCc, UserDefined 11-15 on Res

1.11 25.05.12 Andrew Buttigieg Added RegoNumber to ResRecord and ResRequestAdded UserDefinedFieldNo and UserDefinedValue to ClientRequest

1.10 04.04.12 Andrew Buttigieg Added Test Agent Details

1.9 07.02.12 Andrew Buttigieg Added Comment to Transaction

1.8 16.12.11 Andrew Buttigieg Added GroupMasterAccountId and PosOnGroupMaster to ResRecord

1.7 07.12.11 Andrew Buttigieg Added New Client Spare Fields and PrivacyNoMailOuts

1.6 01.09.11 Andrew Buttigieg Added AllowedToPostCharge / GetListOfAreasSetupAdded CommsPin, ClientType and AllowedActivities to Client Record

1.5 22.08.11 Andrew Buttigieg Added GetListOfCompanies

1.4 11.08.11 Andrew Buttigieg Added New OptionalFields

1.3 04.08.11 Andrew Buttigieg Added New OptionalFields

1.2 28.07.11 Andrew Buttigieg Added GetListOfRes / GetListOfClients

1.1 26.05.11 Andrew Buttigieg Added Transactions

1.0 22.02.11 Lee Jackson

This document is copyright © and may not be reproduced, copied, shared or transmitted to in any form toany other party without the express permission in writing of RMS Pty Ltd.




1. ContentsSelect from the below links to be taken to information contained in the current RMS Public InterfaceSpecification document.

2. Introduction

3. Protocol

4 .Public Methods

5. Appendix A - Class Definitions





2. IntroductionThe Public Service Interface acts as a gateway to the RMS database. It can be used to extract a broadsubset of data for a range of uses.The information can be extracted periodically as an automated routine or on demand. The interface alsoallows for posting charges back to the guest account.There are many uses for the Public Service Interface which include but are not limited to:

E-marketing solutions

Loyalty systems

Data correlation for group wide reporting

Statistical reporting

Data Warehouse

This document describes the protocol to provide for the exchange of information between the PropertyManagement System (RMS) and the Third Party Applications.

This document will list the available public functions that RMS will expose.

It is intended that this document will be updated, if and when, these web services are expanded, or newservices are provided.

Third party applications will be required to undergo RMS Testing and certification before they areauthorised to use this protocol.For information about the process and costs involved, please contact your nearest RMS Sales office.

http://www.rms.com.au/contact




3. ProtocolThis section will outline the following Protocol aspects:

3.1 Web Services

3.2 Authentication

3.3 Dates and Times

3.1 Web ServicesWeb Services provide a standard means of interoperating between different applications, running on avariety of platforms and/or frameworks. The web services allow for the exchange of basic data that willallow Third Parties to develop against.

The RMS Public Service is a WCF service. It can be utilized by most common programming languagesincluding VB.NET, C# and Java. Please note. The RMS Development team are only familiar with .NETlanguages so will be not be able to assist with establishing WCF communication protocols in otherlanguages.

The primary URL of the web service ishttps://api.rms.com.au/RMSPublicService/RMSPublicService.ServiceLibrary.svcIt should be used to retrieve the WSDL and make the first GetConnectionInfo() call For the best performance, the client specific URL should be used for all calls made after the initialGetConnectionInfo()

3.2 AuthenticationTo use the Public Web Services you need to provide Authentication to prove you are an authorized agent,and that you have access to the Client data requested. This Agent Id is unique to you and can be used to access all Clients.

Each RMS Client also has a unique Client No and Password. If the Client using the service does not knowtheir password, it can be obtained by contacting RMS Support.

For testing purposes the following details can be used. Please note. These agent credentials will onlyconnect to a RMS Testing Database. Access will be denied to real client data until the application has beencertified by RMS. There is a cost associated with access to each clients data, this is billed directly to theclient.

Agent Id: 15Agent Password: 1h&29$vk449f8 RMS Client Id: 3038

#helpiq20034783.1 Web Services

#helpiq20034783.2 Authentication

#helpiq20034783.3 Dates and Times

https://api.rms.com.au/RMSPublicService/RMSPublicService.ServiceLibrary.svc

#helpiq20034964.2

#helpiq20034964.2




RMS Client Password: X!b69rN*

3.3 Dates and TimesDue to WCF automatic time conversion, date parameters must be sent without the time zone offsetpresent.

Eg. A date formatted as 2014-10-11T15:30:00+08:00 will be converted to 2014-10-11T17:30:00+10:00causing inconsistent results

A date formatted as 2014-10-11T15:30:00 will not be converted and will be processed by the server as2014-1011T15:30:00

To achieve this in VB.NET use the following syntax: DateTime.SpecifyKind(<THEDATE>, DateTimeKind.Unspecified)




4. Public MethodsSelect from the links below to access the following Public Methods:

4.1 TestCall() as String

4.2 GetConnectionInfo() as ConnectionInfoResponse

4.3 GetPropertyName() as String

4.4 GetListOfSundryCharges() as Class SundryBasic()

4.5 GetListOfProperties() as Class PropertyBasic()

4.6 GetListOfCategories() as Class CategoryBasic()

4.7 GetListOfAreas() as Class AreaBasic()

4.8 GetListOfAreasSetup() as Class AreaSetup()

4.9 GetListOfCreditCards() as Class CreditCardBasic()

4.10 ProcessTransactions() as Class TransactionResult()

4.11 GetSystemLabels() as Class SystemLabelsScreenData

4.12 GetListOfReservations() as Class ResResult

4.13 GetListOfClients() as Class ClientResult

4.14 SetBillPending() as Boolean

4.15 GetListOfCompanies() as Class CompanyBasic()

4.16 GetListOfClassifications() as Class ClassificationBasic()

4.17 AllowedToPostCharge() as Class AllowedToPostChargeResult()

4.18 GetAvailability() as Class AvailabilityResponse ()

4.19 SaveClientDetails() as Class ClientLite ()

4.20 RetrieveCompanyLite() as Class CompanyLite ()

4.21 RetrieveTravelAgentLite() as Class TravelAgentLite()

4.22 RetrieveHoldLite() as Class HoldLite ()

4.23 RetrieveHeldLite() as Class HeldLite()

4.24 SaveCompanyDetails() as Class CompanyLite ()

4.25 SaveTravelAgentDetails() as Class TravelAgentLite ()

4.26 SaveHoldDetails() as Class HoldLite ()

4.27 SaveHeldDetails() as Class HeldLite ()

4.28 CreateClient() as Integer

4.29 GetClient() as Class ClientLite

#helpiq20034964.1

#helpiq20034964.2

#helpiq20034964.3

#helpiq20034964.4

#helpiq20034964.5

#helpiq20034974.6

#helpiq20034974.7

#helpiq20034974.8

#helpiq20034974.9

#helpiq20034974.10

#helpiq20034924.11

#helpiq20034924.12

#helpiq20034924.13

#helpiq20034924.14

#helpiq20034924.15

#helpiq20035254.16

#helpiq20035254.17

#helpiq20035254.18

#helpiq20035254.19

#helpiq20035254.20

#helpiq20051934.21

#helpiq20051934.22

#helpiq20051934.23

#helpiq20051934.24

#helpiq20051934.25

#helpiq20056164.26

#helpiq20056164.27

#helpiq20056164.28

#helpiq20056164.29




4.30 UpdateClient() as Boolean

4.31 GetListOfRegoNumbers() as List of Class RegoNumbersResults

4.32 GetListOfTransactions() as Class TransListResult

4.33 SaveResDetails() as List of Class SaveResResult

4.34 GetListOfAuditTrail() as List of Class AuditTrailRecord

4.35 GetListOfUserMessages() as List of Class UserMessage

4.36 SaveUserMessage() as Class UserMessage

4.37 DeleteUserMessage() as Boolean

4.38 SaveDocuments () as DocumentResult

4.39 GetListOfCompanies2 () as CompanyResult

4.40 GetListOfRate2 () as RateResult

:

#helpiq20056164.30

#helpiq20056184.31

#helpiq20056184.32

#helpiq20056184.33

#helpiq20056184.34

#helpiq20056184.35

#helpiq20056194.36

#helpiq20056194.37

#helpiq20056194.38

#helpiq20056194.39

#helpiq20056194.40


4. Public Methods


4.1 TestCall() as StringUsed to confirm the ability to communicate with the service. If successful it will return "Hello World!!!".

4.2 GetConnectionInfo() asConnectionInfoResponseReturns the Authentication Token and Connection information required for subsequent calls to the API.

This information should be retrieved and stored on startup of your application as it is used for every call tothe Public Service. The information will change very rarely so retrieving it on startup, and then refreshing itevery 4-8 hours is sufficient in most cases. However, having an option to manually refresh the token isadvisable.

Please note: the call takes roughly 1 second on a good internet connection so retrieving it beforePlease note: the call takes roughly 1 second on a good internet connection so retrieving it beforeevery call will slow down your application significantly.every call will slow down your application significantly.

Parameters Type Required Description

oRequest ClassConnectionInfoRequest

Yes Client and Agent information

4.3 GetPropertyName() as StringReturns the Name of the Master RMS Property.


sToken String Yes Token for Validation

4.4 GetListOfSundryCharges() as ClassSundryBasic()Returns the List of Sundry charges configured in the RMS system. A valid sundry id is required to postcharges to the RMS Service


#helpiq20034945.2

#helpiq20034945.1

#helpiq20034945.3


4. Public Methods



4.5 GetListOfProperties() as ClassPropertyBasic()Returns the list of Properties configured in the RMS database.



#helpiq20034945.4


4. Public Methods


4.6 GetListOfCategories() as ClassCategoryBasic() Returns the list of Categories configured in the RMS database in the Properties requested.



lstOfPropertyIds List of Integer No The list of properties to return categories for. If noproperties are specified then all categories will bereturned.

4.7 GetListOfAreas() as ClassAreaBasic() Returns the list of Areas configured in the RMS database in the Properties or Categories requested.

Please note: If lstOfPropertyIds and lstOfCatIds are specified, only lstOfCatIds will be used.Please note: If lstOfPropertyIds and lstOfCatIds are specified, only lstOfCatIds will be used.



lstOfPropertyIds List of Integer No The list of properties to return areas for. If no properties arespecified then all areas will be returned.

lstOfCatIds List of Integer No The list of categories to return areas for. If no categoriesare specified then all areas will be returned.

4.8 GetListOfAreasSetup() as ClassAreaSetup()Returns the list of Areas with detailed information configured in the RMS database in the Properties orCategories requested.

Please note: If lstOfPropertyIds and lstOfCatIds are specified, only lstOfCatIds will be used.Please note: If lstOfPropertyIds and lstOfCatIds are specified, only lstOfCatIds will be used.


#helpiq20034945.5

#helpiq20035225.6


4. Public Methods



lstOfPropertyIds List of Integer No The list of properties to return areas for. If no properties arespecified then all areas will be returned.

lstOfCatIds List of Integer No The list of categories to return areas for. If no categories arespecified then all areas will be returned.

4.9 GetListOfCreditCards() as ClassCreditCardBasic()Returns the List of Credit Cards configured in the RMS System. A valid Credit Card Id is required to postcredit card transactions to the RMS Service.



4.10 ProcessTransactions() as ClassTransactionResult()Posts charges and receipts to the RMS database.



oRequest Class (TransactionRequest)

Yes Request Object

#helpiq20035225.8

#helpiq20035225.10

#helpiq20035225.9

#helpiq20035225.9


4. Public Methods


4.11 GetSystemLabels() as ClassSystemLabelsScreenData Returns the list of customisable labels and field names in RMS and what the Property has named each ofthem.



4.12 GetListOfReservations() as ClassResResultReturns a list of reservations based on the selection parameters in the Request object. To ensure the quickest response times, only the most used fields (defined below) are filled in the Responseby default. To have other fields filled, they must be enabled in the Request.ResOptionalFieldList andRequest.ClientOptionalFieldList.

Please note: A maximum of 3000 records will be returned per call.Please note: A maximum of 3000 records will be returned per call.



oResRequest Class(ResRequest)

Yes Contains search parameters to use and the list of fields to return in thereservation search.

4.13 GetListOfClients() as ClassClientResultReturns a list of clients based on the selection parameters in the Request object. To ensure the quickest response times, the most used fields (defined below) are filled in the Response bydefault. To have other fields filled, they must be enabled in the Request.ResOptionalFieldList andRequest.ClientOptionalFieldList.

Please note: A maximum of 3000 records will be returned per call.Please note: A maximum of 3000 records will be returned per call.

#helpiq20051955.12

#helpiq20051955.14

#helpiq20051955.13

#helpiq20052255.17


4. Public Methods




oGuestRequest Class(ClientRequest)

Yes Contains search parameters to use and the list of fields to return inthe client search.

4.14 SetBillPending() as BooleanToggles the Reservation Bill Pending status. When this is set to True, the reservation cannot be checkedout. The result of the call will be True if the update was successful.



nResId Integer Yes The ResId to update

bPending Boolean Yes The new Pending status

4.15 GetListOfCompanies() as ClassCompanyBasic()Returns the list of Companies in the system.



#helpiq20052255.16

#helpiq20052255.19


4. Public Methods


4.16 GetListOfClassifications() as ClassClassificationBasic() Returns the list of Classifications in the system.



4.17 AllowedToPostCharge() as ClassAllowedToPostChargeResult()Returns whether the Client specified is allowed to post a charge based on a number of rules includingwhether the client has a valid reservation. Either the Client Id or MembershipNo must be supplied.



oRequest Class(AllowedToPostChargeRequest)

Yes Contains search parameters touse

4.18 GetAvailability() as ClassAvailabilityResponse()This call returns a list of areas available for each category based on the properties and categories past inby the request.



oRequest Class(AvailabilityRequest)

Yes Contains search parameters to use

#helpiq20052255.20

#helpiq20056235.21

#helpiq20056235.23

#helpiq20056235.23


4. Public Methods


4.19 SaveClientDetails() as ClassClientLite()Creates or Updates a Client Record. If ClientId is 0 a new record is created, If ClientId is not 0, client will beupdated.

Please note: All fields will be updated every time so GetListOfClients should be used first to primePlease note: All fields will be updated every time so GetListOfClients should be used first to primeclient before updating.client before updating.



oRequest Class(SaveClientRequest)

Yes Contains date and client record

4.20 RetrieveCompanyLite() as ClassCompanyLite()This call returns a list of companies available in the database.



lstCompanyIds List of Integers Yes List of company Ids. If set to Nothing,all companies are returned.

#helpiq20056255.36

#helpiq20056245.26

#helpiq20056245.27


4. Public Methods


4.21 RetrieveTravelAgentLite() asClass TravelAgentLite() This call returns a list of travel agents available in the database.



lstAgentIds List of Integers Yes List of Travel Agent Ids. If set toNothing, all travel agents are returned.

4.22 RetrieveHoldLite() as ClassHoldLite()This call returns a list of holds set up in the database.



lstHoldIds List of Integers Yes List of Hold Ids. If set to Nothing, allholds are returned.

4.23 RetrieveHeldLite() as ClassHeldLite()This call returns a list of held information set up in the database.



lstHeldIds List of Integers Yes List of Held Ids. If set to Nothing, allhelds are returned.

#helpiq20056245.29

#helpiq20056205.32

#helpiq20056205.34


4. Public Methods


4.24 SaveCompanyDetails() as ClassCompanyLite()This call allows you to create or edit a company. If the Company.CompanyId parameter in the oRequestclass is set to 0, then it will create a new company. To edit a company’s details, pass in the value of thecompany id in this parameter



oRequest Class(SaveCompanyRequest)

Yes Contains company information tosave.

4.25 SaveTravelAgentDetails() asClass TravelAgentLite()This call allows you to create or edit a travel agent. If the TravelAgent.AgentId parameter in the oRequestclass is set to 0, then it will create a new travel agent. To edit a travel agent’s details, pass in the value ofthe travel agent id in this parameter.



oRequest Class(SaveTravelAgentRequest)

Yes Contains travel agent informationto save.

#helpiq20056245.27

#helpiq20056245.28

#helpiq20056245.29

#helpiq20056245.30


4. Public Methods


4.26 SaveHoldDetails() as ClassHoldLite() This call allows you to create or edit a hold record. If the Hold.HoldId parameter in the oRequest class is setto 0, then it will create a new hold record. To edit a hold record, pass in the value of the hold id in thisparameter.



oRequest Class(SaveHoldRequest)

Yes Contains reservation hold information to save.

4.27 SaveHeldDetails() as ClassHeldLite()This call allows you to create or edit a held record. If the Held.HeldId parameter in the oRequest class is setto 0, then it will create a new held record. To edit a held record, pass in the value of the held id in thisparameter.



oRequest Class(SaveHeldRequest)

Yes Contains travel information or category information tosave.

4.28 CreateClient() as IntegerParameters Type Required Description


oClient Class (ClientLite) Yes Contains information about the client to be created

#helpiq20056205.32

#helpiq20056205.33

#helpiq20056205.34

#helpiq20056205.35

#helpiq20056255.36


4. Public Methods


4.29 GetClient() as Class ClientLite()Parameters Type Required Description


nClientId Integer Yes The ClientId of the client to retrieve

4.30 UpdateClient() as BooleanParameters Type Required Description


oClient Class (ClientLite) Yes Contains information about the client to be created

dDateOfNow Date Yes The current date/time of the system the interface isrunning on

#helpiq20056255.36

#helpiq20056255.36


4. Public Methods


4.31 GetListofRegoNumbers() as Listof Class RegoNumbersResults



oRegoRequest Class(RegoNumbersRequest)

Yes Contains parameters that determine which Rego andAccess No's are returned

4.32 GetListofTransactions() as ClassTransListResult



oTransRequest Class(TransListRequest)

Yes Contains parameters that determine whichtransactions are returned

4.33 SaveResDetails() as List of ClassSaveResResultThis call allows you to create or edit a reservation. If the ResLite.ResId parameter in the oRequest class isset to 0, then it will create a reservation. To edit a reservation’s details, pass in the value of thereservation id in this parameter.



oRequest Class(SaveResRequest)

Yes Contains Date, Client Id and Reservation informationto save.

#helpiq20056255.38

#helpiq20056255.37

#helpiq20056265.41

#helpiq20056255.40

#helpiq20056265.44

#helpiq20056265.43


4. Public Methods


4.34 GetListOfAuditTrail() as List ofClass AuditTrailRecordThis call allows you to geta list of Audit Trail.



oRequest Class(AuditTrailRequest)

Yes Contains parameters that determine which audittrails are returned

4.35 GetListOfUserMessages() as Listof Class UserMessageThis call allows you to get a list of User messages.



oRequest Class(UserMessageRequest)

Yes Contains parameters that determine which usermessages are returned

#helpiq20056275.46

#helpiq20056265.45

#helpiq20056275.49

#helpiq20056275.47


4. Public Methods


4.36 SaveUserMessage() as ClassUserMessage This call allows you to create or edit a user message. If the UserMessage.MessageId parameter in theoRequest class is set to 0, then it will create a new user message. To edit a user message, pass in thevalue of the message id in this parameter.



oRequest Class(SaveUserMessageRequest)

Yes Contains Date, User message information to save

4.37 DeleteUserMessage() as BooleanThis call allows you to delete a user message.



nMessageId Integer Yes Id of the user message that you want to delete

4.38 SaveDocuments() asDocumentResultThis call allows you to save documents.



oRequest Class(SaveDocumentRequest)

Yes Contains document detail to save

4.39 GetListOfCompanies2() as

#helpiq20056275.49

#helpiq20056275.48

#helpiq20056285.52

#helpiq20056275.50


4. Public Methods


CompanyResultReturns list of companies.



oRequest Class(GetCompanyRequest)

Yes Contains parameters that determine which companiesare returned

4.40 GetListOfRate2() as RateResultReturns list of rates.



oRequest Class(GetRateRequest)

Yes Contains parameters that determine which rates arereturned

#helpiq20056285.54

#helpiq20056285.53

#helpiq20056285.56

#helpiq20056285.55


4. Public Methods


4.41 GetListOfPropertiesDetails() asPropertyDetailThis call allows you to get the details of properties.



4.42 RetrieveBookingSourceLite() asList of Class BookingSourceLiteThis call allows you to retrieve a list of booking source based on a given booking source Ids.



listBookingSourceIds List ofIntegers

No List of Booking source Ids. If set to Nothing, all bookingsources are returned.

4.43 GetListOfGLCodes() as List ofClass GLCodeDetail () This call allows you to retrieve a list of GL Codes of a property



nPropertyId Integer Yes A property Id. If set to -1 or unused, all GL Code from theconnected property will be returned

4.44 GetListOfSundryChargesDetail()


4. Public Methods


as List of Class SundryChargeDetail () Returns the List of Sundry charge details configured in the RMS system.



4.45 GetListOfContacts() as List ofClass ContactDetail()Returns the List of contacts configured in the RMS system.




4. Public Methods


4.46 GetListOfCategoriesDetail() asList of Class CategoryDetail () Returns the List of categories configured in the RMS system.



oRequest Class(CategoryDetailRequest)

Yes Contains parameters that determine which categoriesare returned

4.47 GetListOfAreasDetail() as List ofClass AreaDetail () Returns the List of areas configured in the RMS system.



oRequest Class(AreaRequest)

Yes Contains parameters that determine which areas arereturned

4.48 GetListOfResTypes() as List ofClass ResTypeBasic ()Returns the List of res types configured in the RMS system.



4.49 GetListOfSubResTypes() as List

#helpiq20035225.7


4. Public Methods


of Class SubResType () Returns the List of sub res types configured in the RMS system. .



nParentResTypeId Integer No The parent res type id. If set to 0 or unused, it will return allsub res types

4.50 GetListOfMarketSegments() asList of Class MarketSegment () Returns the List of market segments configured in the RMS system.




4. Public Methods


4.51 - 4.53Returns the list of rates configured in the RMS system.



oRequest Class(RateDetailRequest))

Yes Contains parameters that determine which rates arereturned

4.52 SetAreaCleanStatus() Returns the list of rates configured in the RMS system.



nlstOfAreaId List(Of Integer) Yes The AreaID of the Area status to change

nCleanStatus Boolean Yes The CleanStatus the Area will be set to. E.g. VacantClean = 0VacantDirty = 1Occupied = 3VacantInspect = 4Maintenance = 5

4.53 EmailInvoice() Emails an invoice to defined email address



AccId Int32 Yes The Account ID you want the invoice from

EmailTo String Yes The recipient of the email

InvoiceNo Int32 Yes The number of the invoice on the acccount




Appendix A - Class Definitions5.1 ConnectionInfoRequest

5.2 ConnectionInfoResponse

5.3 SundryBasic

5.4 PropertyBasic

5.5 CategoryBasic

5.6 AreaBasic

5.7 AreaDetail

5.8 CreditCardBasic

5.9 TransactionRequest

5.10 TransactionResult

5.11 Transaction

5.12 SystemLabelsScreenData

5.13 ResRequest

5.14 ResResult

5.15 ResRecord

5.16 ClientRequest

5.17 ClientResult

5.18 ClientRecord

5.19 CompanyBasic

5.20 ClassificationBasic

5.21 AllowedToPostChargeRequest

5.22 AllowedToPostChargeResponse

5.23 AvailabilityRequest

5.24 AvailabilityResponse

5.25 AvailableAreas

5.26 SaveClientRequest

5.27 CompanyLite

5.28 SaveCompanyRequest

5.29 TravelAgentLite

5.30 SaveTravelAgentRequest

#helpiq20034945.1

#helpiq20034945.2

#helpiq20034945.3

#helpiq20034945.4

#helpiq20034945.5

#helpiq20035225.6

#helpiq20035225.7

#helpiq20035225.8

#helpiq20035225.9

#helpiq20035225.10

#helpiq20051955.11

#helpiq20051955.12

#helpiq20051955.13

#helpiq20051955.14

#helpiq20051955.15

#helpiq20052255.16

#helpiq20052255.17

#helpiq20052255.18

#helpiq20052255.19

#helpiq20052255.20

#helpiq20056235.21

#helpiq20056235.22

#helpiq20056235.23

#helpiq20056235.24

#helpiq20056235.25

#helpiq20056245.26

#helpiq20056245.27

#helpiq20056245.28

#helpiq20056245.29

#helpiq20056245.30




5.31 TravelAgentCompanyAssociations

5.32 HoldLite

5.33 SaveHoldRequest

5.34 HeldLite

5.35 SaveHeldRequest

5.36 ClientLite

5.37 RegoNumbersRequest

5.38 RegoNumbersResults

5.39 TransListRecord

5.40 TransListRequest

5.41 TransListResult

5.42 ResLite

5.43 SaveResRequest

5.44 SaveResResult

5.45 AuditTrailRequest

5.46 AuditTrailRecord

5.47 UserMessageRequest

5.48 SaveUserMessageRequest

5.49 UserMessage

5.50 SaveDocumentRequest

5.51 Document

5.52 DocumentResult

5.53 GetCompanyRequest

5.54 CompanyResult

5.55 GetRateRequest

5.56 RateResult

5.57 BeddingConfig

#helpiq20056205.31

#helpiq20056205.32

#helpiq20056205.33

#helpiq20056205.34

#helpiq20056205.35

#helpiq20056255.36

#helpiq20056255.37

#helpiq20056255.38

#helpiq20056255.39

#helpiq20056255.40

#helpiq20056265.41

#helpiq20056265.42

#helpiq20056265.43

#helpiq20056265.44

#helpiq20056265.45

#helpiq20056275.46

#helpiq20056275.47

#helpiq20056275.48

#helpiq20056275.49

#helpiq20056275.50

#helpiq20056285.51

#helpiq20056285.52

#helpiq20056285.53

#helpiq20056285.54

#helpiq20056285.55

#helpiq20056285.56

#helpiq20056285.57




5.1 ConnectionInfoRequestProperty Type Description

AgentId Integer The Agent Id supplied to you by RMS to access the API. This is the samefor all clients your application connects to.

AgentPassword String The Agent Password supplied to you by RMS

RMSClientNo Integer The Client No of the RMS Client you want to access the API on behalf of.

ClientPassword String The Public API password for the Client Id

TrainingDatabase Boolean Whether to connect to the Client's Live or Training database

5.2 ConnectionInfoResponseProperty Type Description

Token String The Authentication token required for subsequent calls to the API

WebserviceURL String The WebserviceURL to use for subsequent calls to the API. SeeAppendix 6.6 for an example of how to use a specific URL.

WebserviceURLPrefix Integer The prefix of the WebserviceURL to use for subsequent calls to theAPI

5.3 SundryBasicProperty Type Description

SundryId Integer The ID of the Sundry

Description String The name ofthe Sundry

UnitPrice Decimal The price per unit of the Sundry

GLCodeId Integer The General Ledger ID of the Sundry

GLCode String The General Ledger Description of the Sundry

CreditNote Boolean Whether the Sundry is a Credit Note




5.4 PropertyBasicProperty Type Description

PropertyId Integer The ID of the Property in the RMS database

PropertyName String The Name of the Property

RMSClientId Integer The RMSClientID of the Property. This may be different to theRMSClientId of the Master Property in a Multi Property database.

5.5 CategoryBasicProperty Type Description

CatId Integer The ID of the Category in the RMS database

Category String The Name of the Category

CategoryClass CategoryClass Whether the Category is Accomm or Facility




5.6 AreaBasicProperty Type Description

AreaId Integer The ID of the Area in the RMS database

Area String The Name of the Area

5.7 AreaDetailProperty Type Description

AreaId Integer The ID of the Area in the RMS database

Area String The Name of the Area

AreaStats Boolean Whether to include the Area in stats like Occupancy

CategoryId Integer The ID of the Category in the RMS database

CleanStatus EnumCleanStatus

The clean status of the Area (VacantClean, VacantDirty, Occupied etc)

CreatedDate DateTime The date the Area was created

Description String The long description of the Area

DisplayOrder Inetger The order in which the Area is displayed

Ext String Comma delimited list of PABX extensions for the Area

Floor String The floor the Area is located on

GLCode String The name of the GL Codee assigned to the Area

GLCodeId Integer The GL Code ID for the GL code assigned to the Area

Key No 1 String

Key No 2 String

Inactive Boolean Whether the Area is active or inactive

Interconnecting Boolean Whether the Area is Interconnecting with another Area

Length Single The length of the area

ListOfAttributes Object The attrictbutes associated with the Area

MaxOccupants Inetger The maximum amount of people allowed in the Area




ModifiedDate DateTime The date the Area was last modified

PetsAllowed Boolean Whether pets are allowed in the Area or not

PropertyId Integer The ID of the Property in the database associated with that Area

SmokingAllowed Boolean If the room is smoking or non-smoking

Spare1 String User definable spare field 1 on the Area










StatisticsStatus Boolean Whether to include the Area in stats like Occupancy

Width Single The width of the Area

5.8 CreditCardBasicProperty Type Description

CardId Integer The ID of the Credit Card in the RMS database

CreditCard String The description of the Credit Card

5.9 TransactionRequestProperty Type Description

DateOfNow Date The current date at location of the transactions

Source Enum(TransactionSource)

The source of the transactions (POS, PABX etc)

Transactions Listof Classes(Transactions)

The list of transactions to post




5.10 TransactionResultProperty Type Description

TransId Integer RMS assigned unique transaction ID. This will be 0 if the transactionfailed

Transaction Class(Transaction)

The transaction class sent in the Request




5.11 TransactionProperty Type Description

TransactionType Enum(TransactionType)

Type of transaction. (Charge or Receipt)

AccId Integer The Account Id of the account the transaction is posted too. Thiswill usually be retrieved from a Client or Reservation

AccountType Enum(AccountTyoe)

The account the transaction is posted to (Accom, Extras, PABX,Internet etc)

DateOfTransaction Date Date of the transaction

Description String (70) Description for the transaction

Comment String (100) Additional comments for the transaction

Amount Decimal Amount of the transaction

SundryId Integer Id of the Sundry Charge for this Transaction

ReceiptType Enum(ReceiptType)

Type of Receipt (Cash, Cheque, Credit Card etc)

CardId Integer Id of the Credit Card Type used for this transaction

UniqueId Integer The unique id from the calling application

5.12 SystemLabelsScreenDataProperty Type Description

lblClient String The label used for Clients / Guests

lblArea String The label used for Areas

lblResType String The label used for Restypes

lblTariff String The label used for Tariffs

lblCompany String The label used for Companies

lblGroupname String The label used for Groupname

lblBookingSource String The label used for Booking Sources

lblInfant String The label used for Infants

lblDwelling String The label used for Dwellings




lblHold String The label used for Hold Records (R&R)

lblCoordinatorOne String The label used for Coordinator One

lblCoordinatorTwo String The label used for Coordinator Two

lblResNote String The label used for Res Notes

lblHousekeeperNote String The label used for Housekeeper Notes

lblPostalSort String The label used for Post Sort

lblReservation String The label used for Reservations

lblCategory String The label used for Categories

lblArrive String The label used for Arrive on the Res

lblDepart String The label used for Depart on the Res

lblABN String The label used for ABN

lblClientStatus String The label used for Client Status

lblVoucheNo String The label used for Vouchers

lblActivity String The label used for Activities

lblTravelAgent String The lable used for Travel Agents

lblGST String The label used for Tax (GST, VAT etc)

lblEFTPOS String The label used for EFTPos

lblAccom String The label used for Accommodation account

lblExtras String The label used for Extras account

lblAdditionalTariff1 String The label used for Additional Tariff 1







lblSurname String The label used for Surname

lblGiven String The label used for Given

lblTown String The label used for Town




lblPostcode String The label used for Postcode/Zipcode

lblBlacklist String The label used for the Client Blacklist field

lblClientSpare1 String The label used for Client Spare field 1
















lblSpare1 String The label used for Res Spare field 1


















lblCreditCard String The label used for Credit Cards

lblDirectCredit String The label used for DirectCredit in the system

Spare1_Mandatory Boolean Whether Res spare field 1 must have a value when saving areservation










5.13 ResRequestProperty Type Description

ArriveFrom Datetime Return Reservations Arriving after this date and time

ArriveTo Datetime Return Reservations Arriving before this date and time

DepartFrom Datetime Return Reservations Departing after this date and time

DepartTo Datetime Return Reservations Departing before this date and time




CreatedFrom Datetime Return Reservations Created after this date and time

CreatedTo Datetime Return Reservations Created before this date and time

ModifiedFrom Datetime Return Reservations Modified after this date and time

ModifiedTo Datetime Return Reservations Modified before this date and time

CheckInFrom Datetime Return Reservations Checked In after this date and time

CheckInTo Datetime Return Reservations Checked In before this date and time

CheckOutFrom Datetime Return Reservations Checked Out after this date and time

CheckOutTo Datetime Return Reservations Checked Out before this date and time

ResIdFrom Integer Return Reservations with a ResId greater than this

ResIdTo Integer Return Reservations with a ResId less than this

ListOfResIds Listof Integer Return only reservations in this list

ListOfGrpResIds Listof Integer Return only reservations with a Group Res id in this list

ListOfAreaIds Listof Integer Return reservations in this list of Area Ids

ListOfAreaNames Listof String Return only reservations in these Area names

ListOfCatIds Listof Integer Return reservations in this list of Categories

ListOfPropertyIds Listof Integer Return reservations in this list of Properties

ListOfClientIds Listof Integer Return reservations where the Primary client matches one ofthis list

ListOfStatus Listof Enum(ResStatus)

Return reservations with these statuses. If not supplied onlyArrived, Departed, Confirmed and Unconfirmed will bereturned

IncludeGroupMasterReservations

Boolean Return Group Master reservations. (These should not becounted toward occupancy)

IncludeSecondaryClients

Boolean By default only the primary client is returned for eachreservation. Enable this to return all clients.

ResOptionalFieldList ClassOptionalFieldsRes

Which optional Res fields are to be filled in the response

ClientOptionalFieldList

ClassOptionalFieldsClient

Which optional Client fields are to be filled in the response

RegoNumber String Return Reservations with this Rego Number attached




5.14 ResResultProperty Type Description

ResultCode Enum ResultCode The status of the request

ResultsMessage String A description of the result code

RecordsFound Integer The number of Records found including secondary clients if requested.

ListOfRes Listof Class(ResRecord)

The reservations that match the search parameters provided

5.15 ResRecordProperty Type Returned

byDefault

Description

ResID Integer True The Id of the Reservation, this is unique and should be used asthe foreign key in 3rd party systems.

GroupResId Integer True Res is part of a group booking. Group masters will have theirResId as the GroupResId

GroupMaster Boolean True Whether the Reservation is a Group Master. Group mastersare just used for grouping “real” reservations.

AccountId Integer True The Account Id of the Res. When posting charges, this is the Idthat should be used.

Arrive Datetime True Arrival Date of the Reservation

Depart Datetime True Departure Date of the Reservation

CheckInDate Datetime False Actual Checkin Date of the Reservation

CheckOutDate Datetime False Actual CheckOut Date of the Reservation

Status Enum ResStatus True Status of the Reservation

PrimaryClient Class ClientRecord True Details of the Primary Client attached to the Reservation

ListOfSecondaryClients Listof ClassClientRecord

False Details of Secondary Clients attached to the Reservation

Adults Integer True No of Adults on the Reservation

Children Integer False No of Children on the Reservation

Infants Integer False No of Infants on the Reservation

AreaId Integer True Id of the Area the Reservation is in

AreaName String True Name of the Area the Reservation is in

CategoryId Integer False Id of the Category the Reservation is in

CategoryName String False Name of the Category the Reservation is in

PropertyId Integer False Id of the Property the Reservation is in




PropertyName String False Name of the Property the Reservation is in

CreationDate Datetime False Date the Reservation was created

LastModified Boolean False Date the Reservation was last modified

RMSOnlineConfirmationNo Integer False If the Reservation was made via RMS Online, this is theconfirmation no sent to the Client at the time of booking

POSOnGroupMaster Boolean False If True, Pos charges should be posted to the Group MasterAccount Id.

GroupMasterAccountId Integer False The Account Id of the Group Master Reservation. Post chargesto this account if POSOnGroupMaster is True

CompanyId Integer False Id of the Company attached to the Reservation

Company String False Name of the Company attached to the Reservation

BookingSourceId Integer False Id of the Booking Source attached to the Reservation

BookingSource String False Name of the Booking Source attached to the Reservation

TravelAgentId Integer False Id of the Travel Agent attached to the Reservation

TravelAgent String False Name of the Travel Agent attached to the Reservation

DiscountCodeId Integer False Id of the Discount attached to the Reservation

DiscountCode String False Name of the Discount attached to the Reservation

ResTypeId Integer False Id of the Res Type attached to the Reservation

ResType String False Name of the Res Type attached to the Reservation

SubResTypeId Integer False Id of the Sub Res Type attached to the Reservation

SubResType String False Name of the Sub Res Type attached to the Reservation

RateCodeId Integer False Id of the Rate Code attached to the Reservation

RateCode String False Name of the Rate Code attached to the Reservation

TariffAmount Decimal False The Tariff amount for the Reservation

LongTerm Boolean False Whether the Reservation is marked as long term

DepositDateRequired Datetime False The Date the deposit is required

DepositAmount Decimal False The Deposit Amount due

Note String False Free type note on the Reservation

ListOfRegoNumbers ListOf String False List of Rego Numbers attached to the Reservation

ListOfHolds Listof HoldRecord False List of Hold records for the Reservation

UserDefined1 String False Free type field that the user can define the meaning of. SeeSystem Labels.













UserDefined11 Boolean False Boolean type field that the user can define the meaning of.See System Labels.



UserDefined14 Datetime False Datetime type field that the user can define the meaning of.See System Labels

UserDefined15 Datetime False Datetime type field that the user can define the meaning of.See System Labels

PaymentMode String False Payment Mode

BillingInstuctions String False Billing Instuction

Activity String False Activity

AccountBalance Decimal False Account Balance

HouseKeepingNote String False Housekeeping Note

ListofHouseKeepingTasks ListOf ClassHouseKeepingTaskLite

False List of house keeping tasks

MadeBy String False Name of the user that created the reservation

TariffOnGroup Boolean False Is tariff on group

Nights Integer False Number of nights

ModifiedBy String False Name of the user that last modified the reservation

BaseTariff Decimal False Base tariff amount

Package Decimal False Package amount

Accomm Decimal False Accomm amount

Extras Decimal False Extras amount

OptOutMarketing String False Opt out marketing

PaymentAccomm Decimal False Payment accomm amount

PaymentExtras Decimal False Payment extra amount

ListofCorresspondences ListOf ClassCorresspondence

False List of correspondences attached to the reservation

TariffPosted Boolean False Is tariff posted

DiscountAmount Decimal False Discount amount




SecondDiscountCode String False Second discount code

SecondDiscountAmount Decimal False Second discount amount

ListofRequirements Listof ClassRequirementLite

False List of requirements attached to the reservation

ListofReceipts Listof Class ReceiptLite False List or receipts attached to the reservation

DepositRequiredBy Date False Deposit Required By Date

SecondDepositRequiredBy Date False Second Deposit Required By Date

RelatedVPSTxId String False Related VPS TxID

RelatedVendorTxCode String False Related Vendor TXCode

RelatedSecurityKey String False Related Security Key

RelatedTxAuthNo String False Related TxAuth Number

ListofTariffQuoted Listof Class TarriffQuoted False List of Tariff Quoted attached to the reservation

DailyRevenueBreakDown ListofDailyRevenueBreakDown

False List of Daily Revenue Breakdown attached to the reservation

TotalDynamicPrice Decimal False Total Dynamic Price Amount

CurrencyCode String False Currency Code

RoomMoveHeader Boolean False Is Room move header

RoomMoveHeaderId Integer False Room move header ID

GuestPortalLink String False Link to access the reservation from guest portal

ListofBeddingConfigs Listof ClassBeddingConfig

False List of Bedding Config attached to the reservation

ProjectedRevenue Object False Projected Revenue

EventName String False Name of Event

MealPlan String False Customers Meal Plan

OTARef1 String False



BillCategory String False




5.16 ClientRequestProperty Type Description

CreatedFrom Datetime Return Clients Created after this date and time

CreatedTo Datetime Return Clients Created before this date and time

ModifiedFrom Datetime Return Clients Modified after this date and time

ModifiedTo Datetime Return Clients Modified before this date and time

Surname String Return Clients with this exact Surname

Given String Return Clients with this exact Given name

PhoneMobile String Return Clients with this exact Mobile/Cell no.

MembershipNo String Return Clients with this exact MembershipNo

ListOfPropertyIds Listof Integer Return Clients in this list of Properties

ListOfClientIds Listof Integer Return Clients with these Client Ids

ClientOptionalFieldList ClassOptionalFieldsClient

Which optional Client fields are to be filled in the response

UserDefinedFieldNo Integer Which User Defined field to search in

UserDefinedFieldValue

String/Integer/Date The value to search for in the UserDefinedFieldNo assignedabove. User defined field types are as follows1-12 String13-14 Boolean15-16 Date

5.17 ClientRequestProperty Type Description


ResultMessage String A description of the result code

RecordsFound Integer The number of Records found including secondary clients ifrequested

ListOfClients Listof Clients(ClientRecord)

The clients that match the search parameters provided




5.18 ClientRecordProperty Type Returned

by DefaultDescription

ClientId Integer True The Id of the Client, this is unique and should be used asthe foreign key in 3rd party

Given String True Given name of the Client

Surname String True Surname of the Client

Title String False Title of the Client

GroupName String False Group Name of the Client

CreationDate Datetime False The date the Client was created

LastModified Datetime False The last time the Client was modified

Gender String False The Gender of the Client (Female, Male, X)

DateofBirth Datetime False Date of Birth of the Client

PhoneMobile String False Mobile/Cell no of the Client

PhoneBH String False Between Hours number of the Client

PhoneAH String False After hours number of the Client

Address1 String False Address1 of the Client (usually the street address)

Address2 String False Address2 of the Client

Suburb String False Suburb of the Client

Postcode String False Postcode of the Client

Country String False Country of the Client

State String False State of the Client

Company String False Company the Client is associated to

BookingSource String False Booking Source of the Client

Email String False Email of the Client

AnniversaryDate Datetime False Anniversary Date of the Client

InsuranceExpDate Datetime False Insurance Expiry Date of the Client

BlackListed Boolean False Black list status of the Client

PrivacyNoMailOuts Boolean False Privacy (No Mail Out) status of the Client. If set to truethe client has requested not to receive mail / email.

MembershipNo String False MembershipNo of the Client. This could be a rewardsprogram or another unique number associated to theClient




CurrentReservations Listof Class(ResRecord)

False A list of the reservations that are currently in housewhere this client is the Primary Client

CommsPin String False The Pin number stored in RMS against each client.Generally used for 3rd party systems like PABX, Internet.

ClientType EnumClientType False This will depend what setup or RMS the user has. E.g. ifyou are a trust property you will be returning ( Client orGuest, Contractor, Manager, Owner, Sales Lead, Staff,Third Party).If you have a normal accommodation setup as most ofour customers do you will be returning ( Client or Guest,Contractor, Sales Lead, Staff)

ActivitiesDisabled Boolean False Used if the property does not want this client to use anyactivities (Phone, Internet, PayTV etc)

ListOfAllowedActivities List of Enum(ClientActivity)

False The external activities the client is allowed to use (Phone,Internet, PayTV etc)

ConsentToUseCreditCard Boolean False Whether the client has given permission to charge theircredit card.

AccountBalance Decimal False The balance of the client account

UserDefined1 String False Free type field that the user can define the meaning of.See System Labels.












UserDefined13 Boolean False Boolean field that the user can define the meaning of.See System Labels.




UserDefined14 Boolean False Boolean field that the user can define the meaning of.See System Labels.

UserDefined15 Date False Date field that the user can define the meaning of. SeeSystem Labels.

UserDefined16 Date False Date field that the user can define the meaning of. SeeSystem Labels.

ListOfClassifications Listof Integer False A list of classifications

CurrentReservati ons Listof ClassResRecord

False The current reservation of the client

AccountBalance Decimal False The account balance

Notes String False The client’s notes

LastVisit Datetime False The last visit date of the client

NoOfVisits Integer False The total number of visit

TotalIncome Double False The total income from the client

AvgIncome Double False The average income

ResTypeId Integer False The Id of the res type

ResType String False The name of the res type

SubResTypeId Integer False The Id of the sub res type

SubResType String False The name of the sub res type

DiscountId Integer False

Discount String False

Retailer Boolean False

LastTariffTypeId Integer False

LastTariffType String False

CreatedById Integer False

CreatedBy String False

ModifiedById Integer False

ModifiedBy String False

PrefAppartmentId Integer False

PrefAppartment String False

ListOfRequirements ListOf ClassRequirementLite

False

ParkAndUnitOwned String False

NoOfNights Boolean False




GDPRPrivacyOptIn Boolean False

EmailOptOut Boolean False

SMSOptOut Boolean False

EDMFilter1OptOut Boolean False



MarketingOptOut Boolean False

LanguageSpoken String False

Nationality String False

RV Type String False

RV Length String False

RV Year String False

RV Slide Boolean False

5.19 CompanyBasicProperty Type Description

CompanyId Integer The ID of the Company in the RMS database

Company String The Name of the Company

Address String The Address of the Company

TradingAs String Optional Trading Name if the company is trading as something other than the CompanyName.

5.20 ClassificationBasicProperty Type Description

ClassificationId Integer The ID of the Classification in the RMS database

Classification String The Name of the Company




5.21 AllowedToPostChargeRequestProperty Type Description

ClientId Integer The ID of the Client

MembershipNo String The Membership No of the Client

Activity Enum ClientActivity The activity the client is trying to perform. If no activity is supplied only thecurrent reservation check will be performed

5.22 AllowedToPostChargeResponseProperty Type Description

AllowedToPostCharge Boolean Whether the client is allowed to post a charge

AccountId Integer The account id to post the charge to

CurrentBalance Decimal The current outstanding balance of the client account

CreditLimit Decimal The credit limit for the property

Reason String The reason why the client is not allowed to post charges


The list of external activities the client is allowed to use.

5.23 AvailabilityRequestProperty Type Description

DateOfNow DateTime The current date and time

ListOfPropertyIds List ofInteger

List of properties to check for availability

ListOfCategoryIds List ofInteger

List of categories to check for availability.

StartingPeriod DateTime The starting period to check for availability.

EndingPeriod DateTime The ending period to check for availability.

OnlyCleanAreas Boolean Only return areas where the room is clean. This will be helpful if required aroom immediately.




5.24 AvailabilityResponseReturned: Either a list of the AvailabilityResponse class is returned or nothing.

Property Type Description

CategoryId Integer The available category id

Category String The available category name

PropertyID Integer The property ID for which the category belongs to.

PropertyName String The property name for which the category belongs to.

NoOfAvailableAreas Integer The number of rooms available for the category.

ListOfAvailableAreas Class (AvailableAreas) The list of available areas for the category.

5.25 AvailableAreasProperty Type Description

AreaID Integer The area ID

Area String The area name

AreaDescription Integer The area description

CleanStatus String The clean status of the area:1) VacantInspect - means needs to be inspected2) VacantClean - Means room is vacant and clean3) VacanDirty - Means room is vacant but dirty'4) OccupiedOld - Ignore this status it is no longer used5) Occupied - Means the room is in use by a guest6) Maintenance - The room is requiring maintenance




5.26 SaveClientRequestProperty Type Description

DateOfNow DateTime The current date at location of the module

Client Class (ClientRecord) The client record to create or update

5.27 CompanyLiteProperty Type Description

CompanyId Integer The unique Company Id.

CompanyName String The company’s Name.

ABN String The company’s ABN.

Address1 String The company’s address 1




State String The state in which the company resides.

Postcode String The postcode (zip code) where the company resides.

Contact String The main contact person for the company.

ContactPosition String The contact's position in the company.

Phone String The company’s phone number.

Fax String The company’s fax number.

Email String The company’s email address.

WebAddress String The company’s website address.

5.28 SaveCompanyRequestProperty Type Description





Company Class(CompanyLite)

The company record to create or update

5.29 TravelAgentLiteProperty Type Description

AgentID Integer The unique Agent Id.

Agent String The agent’s Name.

Address1 String The agent’s address 1




State String The state the agent’s resides.

Postcode String The postcode (zip code) where theagent’s resides.

Phone String The agent’s phone number.

Fax String The agent’s fax number.

Email String The agent’s email address.

GLCodeID Integer The agent’s GL Code Id.

InActive Boolean Is the agent active or not.

CompaniesAssociatedToAgent Class(TravelAgentCompanyAssociations)

Companies associated to theAgent.

5.30 SaveTravelAgentRequestProperty Type Description


Agent Class(TravelAgentLite)

The travel agent record to create or update

#helpiq20056245.27

#helpiq20056205.31

#helpiq20056245.29




5.31 TravelAgentCompanyAssociationsProperty Type Description

CompanyID Integer The unique company Id

PrimaryCompany Boolean The company that is billed.

5.32 HoldLiteProperty Type Description

HoldId Integer The unique hold Id.

ResId Integer The res id related to the hold.

FromDate Date The start date for the hold.

ToDate Date The end date for the hold.

HoldExpired Boolean If true, signifies the hold has expired.

ChargeTypeId Integer The charge type id associated to the hold.

5.33 SaveHoldRequestProperty Type Description

DateOfNow DateTime The current date at location of module

Hold Class (HoldLite) The hold record to create or update

5.34 HeldLiteProperty Type Description

HeldId Integer The unique held Id.

CategoryId Integer The category id the held belongs to

AgentId Integer The agent id the held belongs to. If set to 0 identifiesinternet booking.

#helpiq20056205.32




FromDate Date The start date for the held.

ToDate Date The end date for the held

NumberHeld Integer The number of rooms held

Guaranteed Boolean If set to true, rooms are only held for the particularagent.

Release Integer It is the number of days from today that cannot bebooked.

Permanent Boolean If true, ignores From and To dates. Held does not expire.

OnlineDefaultAllotment Boolean It is only true for online booking (ie. Agent Id = 0)

5.35 SaveHeldRequestProperty Type Description

DateOfNow DateTime The current date at location of module

Held Class (HeldLite) The held record to create or update

#helpiq20056205.34




5.36 ClientLiteProperty Type Description

ClientId Integer When updating a client, the client id of client to be updated.When creating a client, set to zero.

Title String Title of the Client

Given String Given name of the Client

Surname String Surname of the Client

Mobile String Mobile/Cell no of the Client

Addr1 String Address1 of the Client (usually the street address)

Town String Town/Suburb of the Client

State String State of the Client

Postcode String Postcode of the Client

Email String Email of the Client

MembershipNo String Membership No of the Client

ClientType EnumClientType

Type of Client

CommsPin String The Pin number stored in RMS against each client. Generallyused for 3rd party systems like PABX, Internet.

ActivitiesDisabled Boolean Used if the property does not want this client to use anyactivities (Phone, Internet, PayTV etc)

ConsentToUseCreditCard Boolean Whether the client has given permission to charge their creditcard.

CCToken String Credit Card Token for the client

UserDefined11 String Free type field that the user can define the meaning of. SeeSystem Labels.

UserDefined15 Date Date field that the user can define the meaning of. See SystemLabels.


The external activities the client is allowed to use (Phone,Internet, PayTV etc)




5.37 RegoNumbersRequestProperty Type Description

DateOfNow Date The current system date

ListOfResIds List of Integer List of Reservation Ids to return results for

ListOfRegoNos List of Integer List of Rego Nos to return results for

ListOfAccessNos List of Integer List of Access Nos to return results for

DateCreatedFrom Date Return Records Created after this date and time

DateCreatedTo Date Return Records Created up to this date and time

DateModifiedFrom Date Return Records Modified from this date and time

DateModifiedTo Date Return Records Modified up to this date and time

5.38 RegoNumbersResultsProperty Type Description

ResID Integer The ResId the Rego/Access No is associated to

RegoNo String The Rego number

AccessNo String The Boomgate Access Number

AccessType AcccessType Type of Access (InOnly = 0, OutOnly = 1, InOut = 2,InOutWithAntiPassback = 3)

ExpiryDate Date The date access expires

Status Status Current status (InThePark = 0, OutOfThePark = 1, NotSure= 2)

DateCreated Date The date the record was created

DateModified Date The date the record was last modified

5.39 TransListRecordProperty Type Description

TransId Integer The unique transaction Id

AccountId Integer The account id to post the transaction to




ClientId Integer The Id of the client

PropertyId Integer The Id of the property

ResId Integer The Id of the reservation

SundryId Integer The Id of the Sundry Charge for this Transaction

DateOfTrans Date The Date of the transaction

DateCreated Date The date the transaction record was created

Description String The Description for the transaction

Amount Decimal Amount of the transaction

GlCodeId Integer The transaction GL Code Id

GlCodeDesc String The description of the transaction GL Code Id

TransactionType EnumTransListRecordType

Type of transaction. (Charge or Receipt)

ReceiptType Enum ReceiptType Type of receipt. (Cash, Cheque, Credit Card etc)

LinkPointer Integer Link Pointer value

Void Boolean Is the transaction void or not

5.40 TransListRequestProperty Type Description

TransIdFrom Integer Return transactions with a TransId greater than this

TransIdTo Integer Return transactions with a TransId less than this

CreatedFrom Date Return transactions Created after this date and time

CreateTo Date Return transactions Created before this date and time

DateOfTransFrom Date Return transactions with applied date after this date andtime

DateTransTo Date Return transactions with applied date before this date andtime

ListOfResIds List of Integer Return transactions from reservations on this list

ListOfAccountIds List of Integer Return transactions from accounts on this list

ListOfClientIds List of Integer Return transactions where the Primary client matches oneof this list




5.41 TransListResultProperty Type Description



RecordsFound Integer The number of Records found

ListOfTrans List of Class(TransListRecord)

The transactions that match the search parametersprovided

5.42 ResLiteProperty Type Returned

byDefault

Description

ResId Integer True The Id of the Reservation, this is unique and shouldbe used as the foreign key in 3rd party systems.

ClientId Integer True The ID of the Client

Arrive Datetime True Arrival Date of the Reservation

Depart Datetime True Departure Date of the Reservation

Status EnumResStatus

True Status of the Reservation

Adults Integer True No of Adults on the Reservation

Children Integer False No of Children on the Reservation

Infants Integer False No of Infants on the Reservation

AreaId Integer True Id of the Area the Reservation is in

CatId Integer False Id of the Category the Reservation is in

PropertyId Integer False Id of the Property the Reservation is in

AltId Integer False Id of the Rate the Reservation is using

CompanyId Integer False Id of the Company attached to the Reservation

BookingSourceId Integer False Id of the Booking Source attached to theReservation




TravelAgentId Integer False Id of the Travel Agent attached to the Reservation

DiscountId Integer False Id of the Discount attached to the Reservation

ResTypeId Integer False Id of the Res Type attached to the Reservation

SubResTypeId Integer False Id of the Sub Res Type attached to the Reservation

LongTerm Boolean False Whether the Reservation is marked as long term

Notes String False Free type note on the Reservation

UserDefined1 String False Free type field that the user can define themeaning of. See System Labels.










UserDefined11 Boolean False Boolean type field that the user can define themeaning of. See System Labels



UserDefined14 Datetime False Datetime type field that the user can define themeaning of. See System Labels.

UserDefined15 Datetime False Datetime type field that the user can define themeaning of. See System Labels.




GroupAllotmentAgentId Integer False The Id of group allotment agent

Address String False Clients Address

Town String False Clients Town

State String False Clients State

Postcode String False Clients Postcode

Country String False Clients Country

5.43 Save ResRequestProperty Type Description

DateOfNow Enum ResultCode The status of the request

PrimaryClientId String A description of the result code

Reservations List of Class (ResLite) Reservations that need to be saved

5.44 Save ResResultProperty Type Description

GrpResId Integer The Id of the Group reservation if the Res is part of a groupbooking. Group masters will have their ResId as theGroupResId

ResId Integer The Id of the Reservation, this is unique and should be used asthe foreign key in 3rd party systems.

ClientId Integer The ID of the Client

AccId Integer The Account Id of the account the transaction is posted too.This will usually be retrieved from a Client or Reservation

CatId Integer Id of the Category the Reservation is in

AreaId Integer Id of the Area the Reservation is in

Arrive Date Arrival Date of the Reservation

Depart Date Departure Date of the Reservation

AgentId Integer Id of the Agent attached to the Reservation

UserDefined10 String Free type field that the user can define the meaning of. SeeSystem Labels.




ResStatus Enum ResStatus Status of the Reservation

5.45 AuditTrailRequestProperty Type Description

DateFrom Date Return audit trails created after this date and time

DateTo Date Return audit trails created before this date and time

ListOfResId List of Integer Return audit trails from reservations on this list

ListOfPropertyId List of Integer Return audit trails from properties on this list




5.46 AuditTrailRecordProperty Type Description

Id Integer The Id of the audit trail record

CreatedDate Date The created date of the audit trail record.

ResId Integer The Id of the Reservation

FieldModified String The name of the field that is modified

FieldModifiedID Integer The ID of the field that is modified

OldValue String Old value of the field

NewValue String New value of the field

UserId String The Id of the user who modified the value

Reason String Reason of the modification

HoldId Integer The ID of the Hold modifcations are made to

5.47 UserMessageRequestProperty Type Description

ListOfMessageId List of Integer Return user messages have Ids on this list

ListOfResId List of Integer Return user messages from reservations on this list

ListOfPropertyId List of Integer Return user messages from properties on this list

DateFrom Date Return user messages created after this date and time

DateTo Date Return user messages created before this date andtime

ListOfMessageStatus List of EnumMessageStatus

Return user messages have status on this list(NotRead, HasBeenRead)

ListOfNotifyOn List of EnumMessageWhenToAction

Return user messages have notify on rules on this list(Reservation, CheckIn, CheckOut, Confirmation,Cancellation)




5.48 SaveUserMessageRequestProperty Type Description

DateOfNow Date The current date and time

UserMessage UserMessage User message that needs to save

5.49 UserMessageProperty Type Description

MessageId Integer The Id of the user message

Descrtiption String Description

ResId Integer The Id of the Reservation

PropertyId Integer The Id of the Property

CreatedDate Date The date that the user mesage is created

CreatedById Integer The Id of the user that created the message

GuestId Integer The Id of the guest

NotifyOn EnumMessageWhenToAction

The Notify On rules (Reservation, CheckIn, CheckOut,Confirmation, Cancellation)

Status Enum MessageStatus The status of the message (NotRead, HasBeenRead)

5.50 SaveDocumentRequestProperty Type Description

GuestId Integer The Id of the guest

RMSClientNo Integer The RMS client number of the guest

ResId Integer The Id of the reservation

AgreementDate Date Agreement Date

InsuranceExpiryDate Date Insurance Expiry Date

AusDocumentDate Date Aux. Document Date




ListOfDocument List of Class(Document)

Documents that need to be saved




5.51 DocumentProperty Type Description

DocumentId Integer The ID of the document

UploadDate Date Upload date

DocumentName String The Name of the document

DocumentContent Byte() Binary data of the upload document

Note String Note

5.52 DocumentResultProperty Type Description

ListOfDocument List of Class(Document)

Documents that are saved

5.53 GetCompanyRequestProperty Type Description

ListofCompanyIds List of Integer Return companies have Ids on this list

ListofCompanyNames List of String Return companies have Names on this list

Spare1 String Return companies have a specific Spare 1 value





Code String Return companies have a specific Code value

CompIdFrom Integer Return companies with a Id greater than this

CompIdTo Integer Return companies with an Id less than this




5.54 CompanyResultProperty Type Description

ResultCode EnumResultCode

The status of the request



ListOfCompanies Listof Class(CompanyLite)

The companies that match the search parameters provided

5.55 GetRateRequestProperty Type Description

ListofChargeIds Integer Return rates have Ids on this list

ChargeTypeName Date Return rates have Names on this list

ChargeTypeIdFrom String Return rates with a Id greather than this

ChargeTypeIdTo String Return rate with an Id less than this




5.56 RateResultProperty Type Description




ListOfRates Listof Class (Rate) The rates that match the search parameters provided

5.57 BeddingConfigProperty Type Description

ConfigId Integer The ID of the config record

BedConfig String A description of the bed config

BedConfigId Integer The ID of the associated bed config

Qty Integer Number of bed used

5.58 PropertyDetailProperty Type Description

PropertyId Integer The ID of the property

PropertyName String The name of the property

RMSClientNo Integer The RMS Client Number

GrpId Integer The Id of the property grouping

TimeZoneId Integer Timezone Id

PropertyCode String The property code

AddressLine1 String The address line of the property

City String The city of the property

State String The state of the property

Postcode String The post code of the property




Phone String The phone of the property

Email String The email of the property

Grouping String The grouping name

PricingOption Enum ofDynamicPricingOption

The pricing option enum (Use Room Type or Use Property)

ListOfAttributes ListOf ClassAttributeLite

List of attributes associated with the property

AddressLine2 String The address line 2 of the property (usually it will be City)

AddressLine3 String The address line 3 of the property

AddressLine4 String The address line 4 of the property

ABN String The ABN of the property

TaxLabel String The name of the tax

BankAccountNo String The bank account number

BSB String The branch number

AccountingDate Date The accounting date

Longitude String The longitude of the property

Latitude String The latitude of the property

PhoneBH String The phone BH number of the property

Mobile String The mobile number of the property

5.59 AttributeLiteProperty Type Description

Id Integer The Id of the attribute

Description String The description of the attribute

5.60 TaxLiteProperty Type Description

Id Integer The Id of the tax




Description String The description of the tax




5.61 BookingSourceLiteProperty Type Description

BookingSourceId Integer The Id of the booking source

Name String The name of the booking source

Code String The code of the booking source

Address1 String The address line 1 of the booking source

Address2 String The city of the booking source

State String The state of the booking source

PostCode String The postcode of the booking source

Phone String The phone number of the booking source

Fax String The fax number of the booking source

Notes String The note of the booking source

ShowInRMSOnline Boolean If the booking source is visible in RMS Online or not

InActive Boolean If the booking source is inactive

GroupId Id The Id of the grouping associated with the booking source

Grouping String The name of the grouping

5.62 GLCodeDetailProperty Type Description

GLCodeId Integer The Id of the GL Code

GLCode String The name of the GL Code

Description String The description of the GL Code

GroupingId Integer The Id of the grouping





5.63 PropertyDetailProperty Type Description

SundryId Integer The ID of the sundry

Description String The name of the sundry

UnitPrice Decimal The price per unit of the sundry

GLCodeId Integer The General Ledger ID of the sundry

GLCode String The General Ledger Description of the sundry

CreditNote Boolean Whether the sundry is a Credit Note

HasTaxes Boolean Whether the sundry has taxes or not

BarCode String The bar code of the sundry

SecondCurrency Decimal The unit price in the second currency

CurrencyView EnumCurrencyView

The currency view of the sundry, it can be Local currency, UScurrency or UK one



CostPrice Decimal The cost price of the sundry

InActive Boolean Whether the sundry is inactive or not

5.64 ContactDetailProperty Type Description

ContactId Integer The Id of the contact

CompanyId Integer The Id of the company associated with the contact

TravelAgentId Integer The Id of the travel agent associated with the contact

RelationshipName String The relationship of the contact

Surname String The surname of the contact

Given String The given name of the contact

Title String The title of the contact




Address1 String The address line of the contact’s address

Address2 String The city of the contact’s address

Address3 String The address line 2 of the contact’s address

Address4 String The address line 3 of the contact’s address

State String The state of the contact’s address

Postcode String The postal code of the contact’s address

PhoneBH String The phone BH number of the contact

Fax String The fax number of the contact

Mobile String The mobile number of the contact

Email String The email of the contact

Position String The position of the contact

Department String The department of the contact

CreatedDate Date The created date of the contact record

CreatedBy Integer The id of the user who creates the contact

ModifiedDate Date The last modified date of the contact record

ModifiedBy Integer The id of the user who last modified the contact

5.65 CategoryDetailRequestProperty Type Description

ListOfCatIds List of Integer Return list of categories that have Id on the list

ListOfPropertyIds List of Integer Return list of categories that have property Id on the list

AvailableToRMSOnline EnumYesNoNotSet

Return list of categories that are available to RMS Online, thevalue could be Yes, No or NotSet

IncludeInactive Boolean Whether to include inactive categories on the returned list ornot




5.66 CategoryDetailProperty Type Description

CatId Integer The Id of the Category

Category String The name of the Category

CategoryClass EnumCategoryClass

The code of the Category

PropertyId Integer The address line 1 of the Category

AllowBookingByCategory Boolean The city of the Category

LongDescription String The state of the Category

RoomTypeGrouping String The postcode of the Category

AvailableToRMSOnline Boolean The phone number of the Category

GLCodeId Integer The fax number of the Category

GLCodeDesc String The note of the Category

NoOfAreasToHoldFromRMSOnline Integer If the Category is visible in RMS Online or not

ListOfAllocatedTaxes List Of (TaxLite) If the Category is inactive

ListOfAttributes List Of(AttributeLite)

The Id of the grouping associated with the Category

InActive Boolean Wether the Category is active

Interconnecting Boolean Wether the Category is linked to another Category

Occupancy Integer The total occcupancy of that Category

DisplayOrder Integer

Code String The code field displayed on the category

Code 2 String The code 2 field displayed on the category

Code 3 String The code 3 field displayed on the category

5.67 AreaRequestProperty Type Description

DateOfNow Date The request date

ModifiedFrom Date Return list of areas that are modified from the given date




ModifiedTo Date Return list of areas that are modified before the given date

ListOfAreadIds List of Integer Return list of areas that have Id on the list

ListOfCatIds List of Integer Return list of areas that have category Id on the list

ListOfPropertyIds List of Integer Return list of areas that have property Id on the list

ListOfCleanStatus List of (EnumCleanStatus)

Return list of areas that have clean status on the list. Valuesare VacantClean, VacanDirty, OccupiedOld, Occupied,VacantInstpect and Maintenance

IncludeInactiveAreas Boolean Whether to include inactive areas on the returned list or not

5.68 ResTypeBasicProperty Type Description

ResTypeId Integer The Id of the res type

ResType String The name of the res type

InActive Boolean Whether the res type is inactive or not

5.69 SubResTypeProperty Type Description

ResTypeId Integer The Id of the parent res type

ResType String The name of the parent res type

SubResTypeId Integer The Id of the sub res type

SubResType String The name of the sub res type

Inactive Boolean Whether the sub res type is inactive or not

5.70 MarketSegmentProperty Type Description

MarketSegmentId Integer The Id of the market segment

Description String The description of the market segment

Code String The code of the market segment




ShortDescription String The short description of the market segment

SubType Boolean Whether the market segment is a sub type or not

Parent Integer The Id of the parent market segement, it is 0 if the marketsegment is not a sub type

Inactive Boolean Whether the market segment is inactive or not




5.71 RateDetailProperty Type Description

ChargeTypeId Integer The Id of the rate

Description String The description of the rate

TariffGrid Boolean Whether the rat has tariff grid or not

LongDescription String The long description of the rate

OnlineBookingPageTariffDisplay String The online booking page tariff display

DiscountId Integer The Id of the discount associated with the rate

DiscountName String The name of the discount

NoDiscountAllowed Boolean Whether no discount allowed or not

RateType Enumb RateType The rate type. Values can be Standard, Linked, Master orBARMulti

Inactive Boolean Whether the rate is inactive or not

GLCodeId Integer The Id of the GL Code associated with the rate

GLCode String The name of the GL Code

Code String The code field of the rate


Grouping String The grouping name

TariffDescription String The description of the tariff

CancellationPolicy String The cancellation policy

ContractedRate Boolean Whether the rate is contracted rate or not

RackRate Boolean Whether the rate is rack rate or not

LinkedChargeTypeId Integer The Id of the linked charge type

RateStructure Enum ofRateStructure

The rate structure, it can be Direct or OTA




Appendix B - VB.NET ExamplesThe following files can be downloaded and viewed for examples of Sample Projects using the Public ServiceInterface:Public Service Sample ProjectTest Client File

6.1 Adding a Web Service Reference6.1.1 Ensure Collection Type is set to Generic List

6.1.2 Allowing the Web service to use large amounts of data

6.2 Retrieve Token and Property Name

6.3 Transactions6.3.1 Create a Charge Transaction

6.3.2 Ceate a Cash Receipt Transaction

6.3.3 Create a Credit Card/Eftpos Receipt Transaction

6.3.4 Post Transaction

6.4 Reservations6.4.1 Get Reservations Arriving Tomorrow

6.5 Creating/Updating a Client6.5.1 Create New Client

6.5.2 Update Existing Client

6.6 Using the correct Webservice URL to initialise the WCF Client6.6.1 Initialise PublicServiceClient with custom URL

https://www.rmscloud.com/assets/Uploads/API-Specs/PublicServiceSampleProject.zip

https://www.rmscloud.com/assets/Uploads/WcfTestClient-fromVS2015-v14.0.zip

#helpiq20056096.1.1

#helpiq20056096.1.2

#helpiq20056116.3.1

#helpiq20056116.3.2

#helpiq20056116.3.3

#helpiq20056116.3.4

#helpiq20056126.4.1

#helpiq20056136.5.1

#helpiq20056136.5.2

#helpiq20056146.6.1




6.1 Adding the Web Service Reference6.1.1 Ensure Collection Type is set to Generic List as shown below(Visual Studio 2010)

6.1.2 Allowing the Web service to use large amounts of dataThe following must be configured in your applications app.config file. The GREEN text must be changedfrom the default settings.Endpoint Configuration<endpointaddress="https://api.rms.com.au/RMSPublicService/RMSPublicService.ServiceLibrary.svc"

behaviorConfiguration="RMSPublicBehavior" binding="basicHttpBinding"bindingConfiguration="BasicHttpBinding_RMSPublicService"contract="RMSPublic.PublicService" name="BasicHttpBinding_RMSPublicService" />

Binding Configuration<binding name="BasicHttpBinding_RMSPublicService" closeTimeout="00:01:00"




openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00"allowCookies="false" bypassProxyOnLocal="false"hostNameComparisonMode="StrongWildcard"maxBufferSize="100000000" maxBufferPoolSize="524288"maxReceivedMessageSize="100000000"messageEncoding="Text" textEncoding="utf-8" transferMode="Buffered"useDefaultWebProxy="true"><readerQuotas maxDepth="32" maxStringContentLength="8192"maxArrayLength="16384"

maxBytesPerRead="4096" maxNameTableCharCount="16384" /><security mode="Transport">

<transport clientCredentialType="None" proxyCredentialType="None"realm="" /> <message clientCredentialType="UserName" algorithmSuite="Default"/>

</security></binding>Behaviour Configuration<behavior name="RMSPublicBehavior" > <dataContractSerializer maxItemsInObjectGraph="1000000000" /> </behavior>




6.2 Retrieve Token and Property NameDim sToken As StringDim oRMSPublic As New RMSPublic.PublicServiceClient Dim sClientPassword As String Dim nRMSClientNo As Integer Dim nAgentId As Integer Dim sAgentPwd As String Dim bTrainingDatabase As Boolean Try

'Defaults nRMSClientNo = [RMS Client No] sClientPassword = [ClientPwd] nAgentId = [AgentId] sAgentPwd = [AgentPassword] bTrainingDatabase = False 'Get Connection String sToken = oRMSPublic.GetToken(nRMSClientNo, sClientPassword, nAgentId,sAgentPwd, bTrainingDatabase) 'Test Property Name MsgBox(oRMSPublic.GetPropertyName(sToken))

Catch ex As Exception MsgBox(ex.Message)

End Try




6.3 Transactions6.3.1 Create a Charge Transaction

Dim oTrans As New RMSPublic.SerialisedClasses.TransactionWith oTrans

.TransactionType = RMSPublic.Functions.TransactionType.Charge

.AccId = nAccId

.Amount = 99

.SundryId = 5

.AccountType = Data.Manager.Account.AccountType.Accomm

.Description = "Test Charge" 'If not supplied Description will comefrom the Sundry.DateOfTransaction = Now 'If not supplied system will useAccounting Date.UniqueId = 1 'Your Internal Ref No (Optional)

End WithlstOfPOSTransactions.Add(oTrans)

6.3.2 Create a Cash Receipt Transaction

Dim oTrans As New RMSPublic.SerialisedClasses.TransactionWith oTrans

.TransactionType = RMSPublic.Functions.TransactionType.Receipt

.AccId = nAccId

.Amount = 66


.ReceiptType = Data.Manager.Receipt.ReceiptType.Cash

.UniqueId = 2 'Your Internal Ref No (Optional)End WithlstOfPOSTransactions.Add(oTrans)

6.3.3 Create a Credit Card/EFTpos Receipt Transaction

Dim oTrans As New RMSPublic.SerialisedClasses.Transaction With oTrans

.TransactionType = RMSPublic.Functions.TransactionType.Receipt

.AccId = nAccId

.Amount = 34


.ReceiptType = Data.Manager.Receipt.ReceiptType.EftPos

.CardId = 1 'The Credit Card ID that Identifies the




Card ie Amex,Visa etc (UseGetListOfCreditCards())

.UniqueId = 3 'Your Internal Ref No (Optional)End With lstOfPOSTransactions.Add(oTrans)

6.3.4 Post Transaction

'Build Request oRequest = NewRMS.FunctionLibrary.RMSPublic.SerialisedClasses.TransactionRequestWith oRequest

.DateOfNow = Now

.Source = RMSPublic.Functions.TransactionSource.PointOfSale

.Transactions = lstOfPOSTransactionsEnd With 'Write Out POS ChargesoResult = oRMSPublic.ProcessTransactions(sToken, oRequest)




6.4 Reservations6.4.1 Get Reservations Arriving Tomorrow

Dim oResReq As New RMSPublic.ResRequest With oResReq 'Res Optional fields oResReq.ResOptionalFieldList = New RMSPublic.OptionalFieldsRes() With .ResOptionalFieldList

.CategoryName = True .PropertyId = True .PropertyName = True .Company = True .BookingSource = True .DiscountCode = True End With

'Client optional fields oResReq.ClientOptionalFieldList = New RMSPublic.OptionalFieldsClient() With .ClientOptionalFieldList .Suburb = True .Country = True .Company = True .BookingSource = True

End With

'Include all the clients, not just the primary .IncludeSecondaryClients = True

'Set search parameters. .ArriveFrom = Now.AddDays(1).Date 'Start of Tomorrow .ArriveTo = Now.AddDays(1).Date & " 23:59:59" 'End of Tomorrow End With

Dim oResResult As RMSPublic.ResResult =oRMSPublic.GetListOfReservations(sToken, oResReq) If Not oResResult Is Nothing Then For Each oRes As RMSPublic.ResRecord In oResResult.ListOfRes MsgBox(oRes.ResId) Next




End If




6.5 Creating/Updating a Client6.5.1 Create New Client

Dim oClientRecord As New RMSPublic.ClientLite With oClientRecord .ClientId = 0 .ClientType = RMSPublic.ClientClientType.Client

.Title = "MR" .Given = "Fred" .Surname = "Flintstone" .Addr1 = "116 Harrick Rd" .Town = "Melbourne" .State = "VIC" .PostCode = "3000" .Mobile = "03145687" .Email = "[email protected]" .CommsPin = "0000" .ConsentToUseCreditCard = True .CCToken = "" .MembershipNo = "123456789"

.ActivitiesDisabled = False .ListOfAllowedActivities = New List(Of RMSPublic.ClientActivity)

'Add all of the activities to the allowed list.ListOfAllowedActivities.Add(KioskServiceLive.ClientActivity.BanNonAlcoholic) .ListOfAllowedActivities.Add(KioskServiceLive.ClientActivity.BarAlcoholic) .ListOfAllowedActivities.Add(KioskServiceLive.ClientActivity.Internet) .ListOfAllowedActivities.Add(KioskServiceLive.ClientActivity.PayPerView) .ListOfAllowedActivities.Add(KioskServiceLive.ClientActivity.PayPerViewAdultsOnly) .ListOfAllowedActivities.Add(KioskServiceLive.ClientActivity.PhoneExternal)




.ListOfAllowedActivities.Add(KioskServiceLive.ClientActivity.PhoneInternal) .ListOfAllowedActivities.Add(KioskServiceLive.ClientActivity.Vending)

End With

oRMSPublic.CreateClient(m_sToken, oClientRecord)6.5.2 Update Existing Client

Dim oClientRecord As RMSPublic.ClientLite 'Retreive the existing Client information using the client id

oClientRecord = oRMSPublic.GetClient(m_sToken, nClientId) 'Update some of the data With oClientRecord .Title = "MRS" .Given = "Wilma" .Email = "[email protected]" End With 'Send the new data back to webservice oRMSPublic.UpdateClient(m_sToken, oClientRecord, Now)




6.6 Using the correct Webservice URLto initialise the WCF Client6.6.1 Initialise PublicServiceClient with custom URL

Private Function InitWebserviceWithURL(ByVal sWebserviceURL As String) As PublicLive.PublicServiceClient

'*** Initialise a PublicServiceClient WCF Client to communicate with the webservice on acustom URL '*** sWebserviceURL is the URL Endpoint of the webservice to connect to

Dim oEndpoint As EndpointAddress Dim oBinding As New BasicHttpBinding 'Establish Endpoint oEndpoint = New EndpointAddress(sWebserviceURL)

'Configure Binding With oBinding

.Security.Mode = BasicHttpSecurityMode.Transport .MaxReceivedMessageSize = "20000000"

.MaxBufferSize = "20000000"

.ReaderQuotas.MaxArrayLength = "20000000" .ReceiveTimeout = New TimeSpan(0, 5, 0, 0)

.SendTimeout = New TimeSpan(0, 0, 5, 0) End With 'Return new instance of Public Service Client with custom endpoint Return New PublicLive.PublicServiceClient(oBinding, oEndpoint)

End Function