Orange Web Services - API Documentation


Error Log Page

Sections

Web Services Version:
7.2.28.28
Sales Database:
SPISalesTEST3 (version 7.2.28.28)
PMS Database:
SPIPMSTest3 (version 7.2.28.28 )

AppHealthMonitor

RecordAppInstallEvent

To Create or Update Record for Application Event (Startup/Shutdown)

RecordAppInstallProcessHeartbeat

To Create or Update Record for Application Process Heartbeat

AutomatedLockboxAccount

Get

Returns the Automated Lockbox Account setup.

GetResortAutomatedLockboxAccount

Returns the Resort Automated Lockbox Account setup.

Availability

GetForWalkIn

Gets the availability for a "Walk-In" (non-owner) customer. Uses the web service client's "UserName" to determine what inventory this client has access to. Takes into account reservation rules and room type maximum occupancy. If a resort / room type fails a custom reservation rule, it will not be included. If a room type does not have it's rates properly setup for these dates and this client's rate type, it will not be included, since this rate will be required to place a reservation. If there are no housekeeping codes setup for a resort, the resort will not be included, since you cannot place reservations without a housekeeping code.

GetForPointsOwner

Gets the availability for an owner with a Points contract. Uses the web service client's "UserName" to determine what inventory this client has access to. Takes into account reservation rules and room type maximum occupancy. If a resort / room type fails a custom reservation rule, it will not be included. If a room type does not have it's rates properly setup for these dates and this client's rate type, it will not be included, since this rate will be required to place a reservation. If there are no housekeeping codes setup for a resort, the resort will not be included, since you cannot place reservations without a housekeeping code.

GetForFloatOwner

Gets the availability for an owner with a Float contract. Uses the web service client's "UserName" to determine what inventory this client has access to. Takes into account reservation rules and room type maximum occupancy. If a resort / room type fails a custom reservation rule, it will not be included. If a room type does not have it's rates properly setup for these dates and this client's rate type, it will not be included, since this rate will be required to place a reservation. If there are no housekeeping codes setup for a resort, the resort will not be included, since you cannot place reservations without a housekeeping code.

GetForFullOwner

Gets the availability for an owner with a Full Owner contract. Uses the web service client's "UserName" to determine what inventory this client has access to. Takes into account reservation rules and room type maximum occupancy. If a resort / room type fails a custom reservation rule, it will not be included. If a room type does not have it's rates properly setup for these dates and this client's rate type, it will not be included, since this rate will be required to place a reservation. If there are no housekeeping codes setup for a resort, the resort will not be included, since you cannot place reservations without a housekeeping code.

GetForFixedOwner

Gets the availability for an owner with a Fixed contract. Uses the web service client's "UserName" to determine what inventory this client has access to. Takes into account reservation rules and room type maximum occupancy. If a resort / room type fails a custom reservation rule, it will not be included. If a room type does not have it's rates properly setup for these dates and this client's rate type, it will not be included, since this rate will be required to place a reservation. If there are no housekeeping codes setup for a resort, the resort will not be included, since you cannot place reservations without a housekeeping code.

GetForOwnerNonUsage

Gets the availability for an owner who's going to make a non-owner (cash, out of contract) reservation. Uses the web service client's "UserName" to determine what inventory this client has access to. Takes into account reservation rules and room type maximum occupancy. If a resort / room type fails a custom reservation rule, it will not be included. If a room type does not have it's rates properly setup for these dates and this client's rate type, it will not be included, since this rate will be required to place a reservation. If there are no housekeeping codes setup for a resort, the resort will not be included, since you cannot place reservations without a housekeeping code.

GetByRoomType

Gets the availability by resort, inventory group , room type, and inclusively between the start and end dates. The minimun amount of days that will be returned is 14, this means that if the number of days between the start and end dates is less than 14 days the web services still will return 14 days as the result. This web services does not take into account custom reservation rules and room type maximum occupancy.

GetAvailRoomTypes

Gets the available Room types by Number Of Occupants, Resort, Owner, Contract and inclusively between the Arrival and Departure dates. This web api does not take into account custom reservation rules.

SetupOverBooking

Setup overbooking limits.

AvailabilityByInvBlockRoomTypeRate

Return the availability. Takes into account reservation rules and room type maximum occupancy. If a resort / room type fails a custom reservation rule, it will not be included. If a room type does not have it's rates properly setup for these dates and this client's rate type, it will not be included, since this rate will be required to place a reservation. If there are no housekeeping codes setup for a resort, the resort will not be included, since you cannot place reservations without a housekeeping code.

Calendars

GetList

Returns a list of week calendars filtered by resort id, week, calendar check-in day and week start date. Ex: If the week calendars need to be obtained for resort "R1", for the week number "30", for the calendar where the check-in day is on a Friday for the defined calendars where the week start date is equal and greater than "2013-01-01" then: resortId = R1 week = 30 occupyDay = 0 minStartDate = 2013-01-01 RESULT: In this case the week calendar for this resort is defined up to the year 2017, therefore the result will be the list of weeks 30 for the calendar Friday to Friday from year 2013 to year 2017 for the given resort.

CheckWeekIsSetup

Checks to see if the week is setup for this resort for the given arrival date, takes into account the check-in day. Let's say that the given date is '2014-04-10' which is a Thursday, if no calendar is defined for the given resort, for the given date for check-in days on a Thursday then an error notification will be returned, otherwise TRUE will be returned.

CancellationCodes

GetAll

Gets all of the reservation cancellation codes.

ConnectionGT

SendAllUnsentSMS

Send all unsent SMS using ConnectionsGT.

SendSimpleSMS

Send all unsent SMS using ConnectionsGT.

GetReservationData

Get reservation data.

GetReservationIDList

Get reservation id list.

GetOwnerDuesData

Get owner dues data.

GetOwnerLoanData

Get owner loan data.

GetSalesMarketingData

Get Sales Marketing data.

GetTourMarketingData

Get Tour Marketing data.

GetDirectPaymentData

Validate payment token.

ContractTypeRules

Validate

Validates that the given contract meets the defined rules for the contract's type.

ContractTypes

GetAll

Gets all contract types

Get

Gets a contract type by id

GetExchangeListByContractType

Gets a Exchange List By Contract Type

Countries

GetAll

Returns all of the countries in the world

CreditCard

Create

Create a credit card.

CreateTokenizeCard

Create a credit card with Token details.

Get

Gets a credit card details.

Custom

WebAvailableWeeks

Gets the list of WebAvailableWeeks

GetPendingPrecheckReservationRoomGuestDetails

Get Pending and Precheck Reservation's Room and Guest Details

CustomDevelopment

Get

Returns the custom development data by item name

Document

GetListByOwner

Gets the list of all attached documents that are web accessible and belong to the owner.

GeFileBytesById

Get single attached document as byte array.

Dues

GetDues

Gets all the dues for this owner, contract and resort

RefreshDuesLoanBalance

Refresh dues,loan balance via external interfaces such as equaint, concord for this owner, contract and resort

GetBillCodes

Gets all dues bill codes by resort

DuesPayment

Create

Makes a dues payment. Returns an error if the payment information is incorrect or the card is not authorized.

SaveDuesPayment

Save a dues payment.

GetDuesi4GOAccessBlock

Get shift4 i4go access block for dues payment

IsLocalCurrencyPaycode

Is LocalCurrency set for paycode

GetDuesPaymentCodes

Gets the maintenance Dues payment code by name and resort id. Note: To interact with the loan payment codes, use the LoanPaymentCodes endpoints instead.

ValidateSetupForDuesPayment

Validate Setups For Dues Payment

DuesTransactions

GetList

Gets all of the unposted dues transactions for this owner

Email

SendByResortSettings

Sends an email from an account who's settings are specified in the resort passed in.

ExchangeReservation

Get

Gets an Exchange Reservation

GetReservationRooms

Gets the reservation rooms from reservation

UpdateReservation

Updates an Exchange reservation

UpdateReservationRoom

Updates an existing room on a Exchange Reservation . Known limitations: -Cannot change resort -Cannot reinstate a cancelled reservation room

ReservationRoomMove

Update the Reservation Room within a same room type (building name and room number). Room move not permitted for Cancelled or CheckedOut reservation rooms.

CheckIn

Check In reservation room in this reservation

CheckOut

Check Out reservation room in this reservation

Cancel

Cancel all of the reservation rooms in this reservation

FixedReservation

ValidateForCreate

Validates the availability and custom reservation rule for fixed reservation with a single reservation room

Create

Creates a Fixed reservation

Get

Gets a Fixed Reservations

GetReservationRooms

Gets the reservation rooms from reservation

UpdateReservation

Updates a fixed reservation

UpdateReservationRoom

Updates an existing room on a fixed reservation. Known limitations: -Cannot change resort -Cannot reinstate a cancelled reservation room

ReservationRoomMove

Update the Reservation Room within a same room type (building name and room number). Room move not permitted for Cancelled or CheckedOut reservation rooms.

CheckIn

Check in reservation room in this reservation

CheckOut

Check Out reservation room in this reservation

Cancel

Cancels all of the reservation rooms in this reservation

UpdateUnconfirmResRoom

Update Unconfirm reservation room status to Pending

ValidatePaymentCode

Validate Res Payment code

FloatReservations

ValidateForCreate

Validates the availability and custom reservation rule for float reservation with a single reservation room

Create

Creates a float reservation with a single reservation room

Get

Gets a float reservation details

GetReservationRooms

Gets the reservation rooms in this reservation

UpdateReservation

Updates a float reservation

UpdateReservationRoom

Updates an existing room on a float reservation. Known limitations: -Cannot change resort -Cannot reinstate a cancelled reservation room

ReservationRoomMove

Update the Reservation Room within a same room type (building name and room number). Room move not permitted for Cancelled or CheckedOut reservation rooms.

CheckIn

Check in reservation room in this reservation

CheckOut

Check Out reservation room in this reservation

Cancel

Cancels all of the reservation rooms in this reservation

GetNotes

Gets all notes associated with this reservation

AddNote

Adds a note to the reservation

UpdateUnconfirmResRoom

Update Unconfirm reservation room status to Pending

ValidatePaymentCode

Validate Res Payment code

FullOwnerReservations

ValidateForCreate

Validates the availability and custom reservation rule for fullOwner reservation with a single reservation room

Create

Creates a fullOwner reservation with a single reservation room

Cancel

Cancels all of the reservation rooms in this reservation

Get

Gets a Full Owner reservation

GetReservationRooms

Gets the reservation rooms in this reservation

UpdateReservation

Updates a full Owner reservation

UpdateReservationRoom

Updates an existing room on a fullOwner reservation. Known limitations: -Cannot change resort -Cannot reinstate a cancelled reservation room

ReservationRoomMove

Update the Reservation Room within a same room type (building name and room number). Room move not permitted for Cancelled or CheckedOut reservation rooms.

CheckIn

Check in reservation room in this reservation

CheckOut

Check Out reservation room in this reservation

GetNotes

Gets all notes associated with this reservation

AddNote

Adds a note to the reservation

UpdateUnconfirmResRoom

Update Unconfirm reservation room status to Pending

ValidatePaymentCode

Validate Res Payment code

HousekeepingConnect

Authenticate

Authenticate an user based on their username and password. The username and password fields must be base64 encoded using iso-8859-1.

Get

Gets the user details by it's id.

GetResorts

Gets the list of resort by user id

GetBuildings

Gets the list of Building by ResortId

GetRoomTypes

Gets the list of Room Type by ResortId

GetRooms

Gets the list of Room by Resort, Building and RoomtType ID

GetServiceCodes

Gets the list of Service Code by Resort

GetRoomStatus

Gets the list of Room Status

GetActivitySummary

Returns the Activity Summary based on criteria

GetWorklist

Returns the Work list assigned to housekeeper user based on criteria

GetRoomDetail

Returns the Room Detail based on criteria

UpdateHousekeepingStatus

Update the HousekeepingStatus of the room

UpdateHousekeepingWorkTime

Update the Housekeeping Work Time of the room

GetEmployees

Gets the list of Employee by Resort

UpdateRoomServiceRequest

Update the Room Service Request

UpdateRoomCleaningEmployee

Update the Room Service Request

GetRequestServiceCodes

Gets the list of Request Service Code by Resort

OpenServiceRequestsSummary

Returns the List of Open Service Requests Summary based on criteria

RoomServiceRequestDetail

Returns the Room Detail based on criteria

InterfaceMappings

Get

Gets a list of interface maps by name

GetGlobalInterfaces

Gets a list of Global Interface details by name

LoanPayment

Create

Makes a loan payment. Returns an error if the payment information is incorrect or the card is not authorized.

SaveLoanPayment

Save a loan payment.

GetLoani4GOAccessBlock

Get shift4 i4go access block for Loan payment

PaymentCodeByPaycode

Gets the Loan payment code by code and resort id.

PaymentCodeBySPIPaycode

Gets the Loan payment code by SPIPay code and resort id.

ValidateSetupForLoanPayment

Validate Setups For Loan Payment

MerchantAccounts

GetForWalkInReservationAdvancePayments

Get Advance Payments for Walk In Reservations

OTAConnect

GetOTAChannelDetails

Gets the details of OTA Channel for requested Channel Type and ID

GetOTAChannelDetails_All

Gets the detail of all OTA Channel for requested Channel Type

UpdateOTAChannels

Update the detail of OTA Channel

GetOTAChannelAccessDetail

Gets list of resort's mapping for OTA channel and resort

GetOTAResortByChannelID

Gets the list of resort which are mapped or unmapped to OTA Channels

GetResortAccessDetail

Gets list of all resort's mapping for OTA Channels

GetOTAChannelAccessDetailByResort

Gets list of resort's mapping present for OTA Channels by Resort. It will get the list of active or inactive resort's mapping detail at a time.

GetOTAChannelAccessDtlByChannelResortMapcode

Gets the list of resort mappings for given channel and mapped resort code

CreateOTAChannelAccessDetail

Creates resort's mapping for an OTA Channel

UpdateOTAChannelAccessDetail

Updates resort's mapping for an OTA Channel

DeleteOTAChannelAccessDetail

Deletes resort's mapping for an OTA Channel and resort

GetOTAChannelMappingsByResortChannel

Gets list of room/rate mappings for this OTA channel and resort

GetOTAChannelMappings

Gets the room/rate mapping details by ID

CreateOTAChannelMappings

Creates an OTA Channel resort's room/rate mapping

UpdateOTAChannelMappings

Updates the OTA Channel resort's room/rate mapping

DeleteOTAChannelMappings

Deletes the OTA Channel resort's room/rate mapping

GetAvailabilityChanges

Gets the pending list of Availability/Restriction from last call.

GetInventoryChanges

Gets the pending list of inventory from last call

GetRoomRateChanges

Gets the pending list of roomrate from last call.

GetRoomTypeAvail

Gets the list of inventory details for this resortID, groupID, roomTypeID and given date range

GetOTARoomRates

Gets the list of room rates for this resort,room type and given date range

GetAllOTARoomrate

Gets the list of all room rates

GetRestrictionsByResortDateRange

Gets the list of Restrictions for this resort and date range

GetOTAEvents

Gets the list of all OTA Events

CreateOTAEvent

Creates an OTA Event

UpdateOTAEvent

Updates an OTA Event

CleanOTAEvents

Delete an OTAEvent before specified days

GetPendingOTAEvents

Gets the list Pending OTA Events

CreateReservation

Creates a Walk-In (non-owner) reservation.

UpdateReservation

Update a Walk-In (non-owner) reservation

Cancel

Cancels all the reservation rooms in this reservation

GetResvByResno

Gets reservation id by reference number and OTA Channel

CreateTravelAgency

Creates a Travel Agency

GetReservationRoomID

Gets the first reservation room in this reservation

GetRateList

Gets the list of Rate types for resort.

GetExchangeList

Gets the list of inventory group available for resortID and reservation sub type

GetRoomTypesByGroupID

Gets the list of room types for resort and inventory group.

GetOTACurrency

Get the Currency Detail by Resort

GetMarketSourceByResort

Gets the list of marketSource for a resort.

GetBusinessSource

Gets the list of Business Source by resort

GetCityLedgerByResort

Gets the list of CityLedger for a resort.

GetTravelAgency

Gets the list of Travel Agency by resort

GetOTAChannelEntityMappings

Gets the list of all entity mappings for OTA Channels

GetOTAChannelEntityMappingsByResortChannel

Gets the list of entity mappings for OTA Channel

CreateOTAChannelEntityMapping

Creates entity mappings for OTAChannel

UpdateOTAChannelEntityMapping

Updates entity mappings for OTAChannel

DeleteOTAChannelEntityMapping

Deletes entity mappings for OTAChannel

ReSyncARI

It does the full synchronization of the changes done in SPI system for Availability(Restrictions), Roomrate, Inventory(ARI) for a interface supported days and whatever the mappings presents for a resort at the time of Re-Sync call.

GetRoomRateSyncStatus

Gets the status of sync is required or not from last call

GetOwnerProfiles

Returns the list of triggerd Owners detail get created or modified.

GetGuestProfiles

Returns the list of triggerd Guest detail get created or modified.

UpdateOTAControls

Updates the last fetched data for OTA

GetTriggeredResv

Returns the list of triggerd Reservation detail get created or modified.

OwnerNonUsageCashReservation

Create

Creates a Non Usage Owner reservation.

GetFlywireConfiguration

Get flywire configuration details

ChargeResRuleOverride

Charge Res Rule Override

GetResi4GOAccessBlock

Get shift4 i4go access block for reservation

GetResNMIDetails

Get NMI URL and Security key for reservation

Get

Gets a Non Usage Owner reservation.

GetReservationRooms

Gets the reservation rooms from reservation

GetPackageAddons

Gets the package addons from reservation

GetFolio

Gets the folio from reservation to create package addons

UpdateReservation

Updates a Non Usage Owner reservation.

UpdateReservationRoom

Updates an existing room on a Non Usage Owner reservation. Known limitations: -Cannot change resort -Cannot reinstate a cancelled reservation room -Reservation deposit balance is not refunded

ReservationRoomMove

Update the Reservation Room within a same room type (building name and room number). Room move not permitted for Cancelled or CheckedOut reservation rooms.

CheckIn

Check in reservation room in this reservation

CheckOut

Check Out reservation room in this reservation

Cancel

Cancels all of the reservation rooms in this reservation

CreatePackageAddon

Create a Reservation Package Addon.

CreateAdvanceDeposit

Creates Advance Reservation Deposit

UpdateUnconfirmResRoom

Update Unconfirm reservation room status to Pending

ValidatePaymentCode

Validate Res Payment code

GetStayCost

Get StayCost

Owners

PointsHistorySummary

Gets the points history summary for the given Owner

StayHistory

Gets a list of stay history by owner id

ActiveLoans

Gets a list of the owner's active loans

Update

Updates the owner's information

UpdatePaperlessStatement

Updates the owner's paperless statement option for loan and dues and Eletronic communication.

Authenticate

Authenticates an owner based on their username (owner id or email) and their password. The username and password fields must be base64 encoded using iso-8859-1.

UserAuthenticate

Authenticates an User based on their username (User id or email) and their password. The username and password fields must be base64 encoded using iso-8859-1.

UpdatePassword

Updates the owner's password, after authenticating their current credentials (username and password). The username, password, and new password properties must be base64 encoded using iso-8859-1.

ForgotPassword

Creates a temporary password reset token for the given owner id/email information. A valid and active OwnerId is required in order for the token to be generated.

ValidResetPasswordToken

Validates if the given reset password token is valid.

ResetPassword

Resets the owner's password by the given reset passsword token. The reset will only be performed if the token is valid.

Get

Gets the owner by id

OwnerSiteSettings

Get

Gets the owner site's settings

OwnerUsageReservation

Get

Get list of Owner Usage Reservation details.

GetResvListing

Get list of Owner Usage Reservation details with owner listing.

GetResvStayHistory

Get list of Owner Usage Reservation details by stay history.

GetResvByDaysAway

Get list of Owner Usage Reservation details by no. of days ways from arrival date.

CreateOwnerBanking

Creates a Banking Reservation.

PaymentCodes

Get

Gets the maintenance Dues payment code by name and resort id. Note: To interact with the loan payment codes, use the LoanPaymentCodes endpoints instead.

PhoneNumbers

GetPhoneNumbersByOwner

Get phone numbers by owner.

PMSSetup

GetResSubType

Gets the Reservation Sub Type Details

GetBudgetAccount

Gets the list of Budget Account

GetTransactionRefID

Gets the Transaction Reference ID

LogFNTCTransaction

Log FNTC Payment Transactions

PointsReasons

GetAll

Gets list of PointsReason

PointsReservation

ValidateForCreate

Validates the availability and custom reservation rule for Points Reservation with a single reservation room

Create

Creates a points reservation

Get

Gets a Points Reservations

GetReservationRooms

Gets the reservation rooms from reservation

UpdateReservation

Updates a Points reservation

UpdateReservationRoom

Updates an existing room on a points reservation. Known limitations: -Cannot change resort -Cannot reinstate a cancelled reservation room

ReservationRoomMove

Update the Reservation Room within a same room type (building name and room number). Room move not permitted for Cancelled or CheckedOut reservation rooms.

CheckIn

Check in reservation room in this reservation

CheckOut

Check Out reservation room in this reservation

Cancel

Cancels all of the reservation rooms in this reservation

UpdateUnconfirmResRoom

Update Unconfirm reservation room status to Pending

ValidatePaymentCode

Validate Res Payment code

GetPointsPuchaseAmount

Gets The amount reqired to purchase the points

ApplyPointsPurchase

Creates point transaction and reservation folio

PointsTransaction

CreatePointTransaction

Creates a points Transaction

PointsTypes

GetAll

Gets list of Points type

GetPointsTypeByUniqueID

Gets list of Points type pointstype unique id

PreCheck

GetPreCheckResSummary

Returns a PreCheck Reservation Summary

GetPreCheckResDetail

Returns a PreCheck Reservation Detail

UpdateResVehicleInfo

Updates Reservation Vehicle Info

UpdatePreCheckResRoomInfo

Updates PreCheck ResRoom Info

AddPreCheckReservationGuest

Add PreCheck Reservation Guest

PayPreCheck

Pay for PreCheck process

CompletePreCheck

Complete PreCheck process

GeneratePreCheckURL

Generate PreCheck URL

AddPreCheckTempResGuest

Add PreCheck Temporal Reservation Guest

AddPreCheckTempVehicle

Add PreCheck Temporal Reservation Guest

AddPreCheckTempBilling

Add PreCheck Temporal Reservation Guest

AddPreCheckTempRoom

Add PreCheck Temporal Reservation Guest

RefCodes

SalesSalutation

Get the list of Salutation from Sales database

ResortAttributes

GetWithResorts

Get Attributes for given resort.

Resorts

GetStayCostPerDayByClientLogin

Returns the stay cost for each date inclusively between startDate and endDate. The rate used is determined by the GDSGroupsRates setup, which uses the client's login If rates aren't setup for certain resorts, roomTypes, or dates, these will not be included. Uses to Revenue Management setups if they exist.

GetPermittedByContract

Returns all resorts permitted by a contract. This endpoint differs from GetAvailableToContract in that this only returns the resorts available to this contract.

GetResortLogo

Returns resort logo imgame Base64.

GetAvailableToContract

Get Resorts available to contract. Unlike the GetPermittedByContract endpoint, this returns ALL resorts, but specifies if each resort is available to this contract or not.

GetInventoryBlocks

Get Inventory Blocks.

GetMarketSourceByResort

Gets the list of marketSource for a resort.

GetBusinessSource

Gets the list of Business Source by resort

GetTravelAgency

Gets the list of Travel Agency by resort

GetReasonForStay

Gets the list of Reason For Stay by resort

GetHouseKeepingcode

Gets the list of House keeping code by resort

GetCityLedger

Gets the list of City Ledger by resort

GetAll

Returns all resorts the client's login has access to.

SelectedAttributes

Returns the resort's selected attributes

GetCascadeCharges

Gets list of cascade charges for the given resort/roomType on the specified date range. The rate used will be determined out of the Interface ID that is consuming the web service.

GetTermsOfConditionByPromoCode

Returns a Terms Of Condition

GetDepositPolicy

Gets the Deposit Policy by resort

GetReservationType

Returns the type of Reservation

GetInterfaces

Gets a list of Resort Interface details by name and resort id

GetPackageDetails

Gets Reservation Package Details

Get

Get the resort by id

RevenueAccounts

GetForCreditCardTransaction

Get for Credit Card Transaction

RevenueAnalytics

GetReservations

Get Reservations

GetRestrictions

Get restrictions

GetRates

Get Rates

GetDerivedRates

Get DerivedRates

GetInventorys

Get Inventory

GetBlocks

Get Blocks

UpdateRate

Update Rates

UpdateOverbooking

Update Overbooking

UpdateRestrictions

Update restictions. Fields to update (StayDays, Active, RoomType, RateCode).

Rooms

AdjoiningRooms

Gets the child rooms for this room

RoomTypes

GetBookableRoomTypes

Gets the Bookable room types,filterd by resortID, contractTypeID, contractRoomTypeID, activeOnly .

Get

Returns the RoomType by id

SalesContractDetails

GetWithDates

Gets a sales contract's details, along with date information

GetByContract

Gets a sales contract's details, along with the unit information, by contract id.

Usage

Gets the owner's usage given the contract detail id and arrival date

UsageByUseYear

Gets the owner's usage given the contract detail id and use year

UsageByContractDetailId

Gets the list of the owner's usage periods for the given contract detail.

Get

Gets a sales contract's details by id

SalesContracts

ByContractId

Gets the sales contract by Id.

GetForOwnerNonUsageReservation

Gets the sales contract for Owner Non Usage Reservation.

GetPointStatement

Gets the Points Statement Report .

GetList

Gets the sales contract by owner.

PointsAvailable

Gets a list of the point types and their associated amounts available.

ReservationRooms

Gets the contract reservation rooms for this contract

GetpointType

Gets a list of the point types and their associated amounts available.

Seasons

GetByResort

Gets the seasons by resort

Dates

Gets the season dates for each calendar year which is setup from the dateToCheckFrom

NextAvailableDate

Gets the next date which is within this season

DatesOutOfSeason

Gets the list of dates that are out of the given season for the sepecified date range.

SecondoryOwners

Get

Gets the additional Owner details by id

Update

Update additional Owner info by id

Taxes

Get

Returns the taxes for the specified resort and client's rate. If no resortId is provided, taxes for all resorts will be returned.

VGInsurance

VerifyIfOwnerIsAlreadyInsured

Verify If Owner is Already Insured

VerifyIfResvIsAlreadyInsured

Verify If Reservation is Already Insured

GetByInterfaceAndProductID

Get the Vacation Guard insurance by ProductID

CreateVGInsurancePayment

It makes an Vacation Guard insurance payment. Returns an error if the payment information is incorrect or the card is not authorized.

PartnerPurchasePolicy

Purchase Vacation Guard Policy

ValidateVacationGuardSettings

Validate Vacation Guard Setting

SaveInsurancePayment

Save payment and create insurance.

WalkInReservation

ValidateForCreate

Validates the availability and custom reservation rule for Walk-In Reservation with a single reservation room

Create

Creates a Walk-In (non-owner) Reservation. If the payment is included, creates a payment first before creating the reservation.

Get

Gets a Walk In Reservation

GetReservationRooms

Gets the reservation rooms from reservation

GetPackageAddons

Gets the package addons from reservation

GetFolio

Gets the folio from reservation to create package addons

UpdateReservation

Updates a Walk In reservation

UpdateReservationRoom

Updates an existing room on a Walk In Reservation . Known limitations: -Cannot change resort -Cannot reinstate a cancelled reservation room

ReservationRoomMove

Update the Reservation Room within a same room type (building name and room number). Room move not permitted for Cancelled or CheckedOut reservation rooms.

CheckIn

Check in reservation room in this reservation

CheckOut

Check Out reservation room in this reservation

Cancel

Cancels all of the reservation rooms in this reservation

CreatePackageAddon

Create a Reservation Package Addon.

CreateAdvanceDeposit

Creates Advance Reservation Deposit

UpdateUnconfirmResRoom

Update Unconfirm reservation room status to Pending

ValidatePaymentCode

Validate Res Payment code

WalkInSiteSettings

Get

Get Walk In Settings

© Systems Products International, Inc.