Oracle Hospitality Front Desk Operations API
Front Desk module provides APIs related to a guests stay in the property. For example, checking a guest into the property, providing room information, splitting reservations, as well as adding wake-up calls to a reservation. This module goes hand-in-hand with cashiering module.
Oracle Hospitality Front Desk Operations API is one of 154 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include FrontDeskOperations. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 61 operations across 45 paths, and defines 597 schemas. It is described by OpenAPI 3.2.0, at version 26.2.0.0.
Requests are made against a single base URL, /fof/v1.
61 operations
45 paths
597 schemas
8 DELETE24 GET16 POST13 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 61
Across 45 paths, the API surfaces 61 operations — 8 DELETE, 24 GET, 16 POST, 13 PUT. Each is listed below with its method, path, parameters, and response codes.
FrontDeskOperations 61
Front Desk module provides APIs related to a guests stay in the property. For example, checking a guest into the property, providing room information, splitting reservations, as w…
GET
/hotels/{hotelId}/authorizationReservations
Get resrvation for batch CCAuth
PUT
/hotels/{hotelId}/batchReservationAuthorizations
Process batch CC Auth
GET
/hotels/{hotelId}/billingReservations
Get Reservations for billing
GET
/hotels/{hotelId}/dailyDocket
Get Daily Docket
PUT
/hotels/{hotelId}/dailyDocket
Change Daily Docket
POST
/hotels/{hotelId}/dailyDocket
Create Daily Docket
DELETE
/hotels/{hotelId}/dailyDocket/{docketId}
Delete Daily Docket
POST
/hotels/{hotelId}/externalRoomKeysdeprecated
Requests room key(s)
GET
/hotels/{hotelId}/floorPlans
Get floor plans
GET
/hotels/{hotelId}/fulfillmentActivityLogs
Get the fullfillment activity log
GET
/hotels/{hotelId}/interfaces/{interfaceId}/roomStatuses
Get room interface status
PUT
/hotels/{hotelId}/interfaces/{interfaceId}/roomStatuses
Change room interface status
GET
/hotels/{hotelId}/keyInterfaces
Get key encoder interface configuration details
GET
/hotels/{hotelId}/queuedReservations
Get the reservation in queue
PUT
/hotels/{hotelId}/queuedReservations/{reservationId}
Add reservation to queue
DELETE
/hotels/{hotelId}/queuedReservations/{reservationId}
Delete reservation from queue
GET
/hotels/{hotelId}/reservationSummaries
Get reservation summaries
POST
/hotels/{hotelId}/reservations/ai/rooms
AI Assign Rooms
GET
/hotels/{hotelId}/reservations/ai/rooms
Automated Intelligence Room Assignment last run status
POST
/hotels/{hotelId}/reservations/autoRoomAssignments
Assign the room automatically
DELETE
/hotels/{hotelId}/reservations/autoRoomAssignments
Auto unassign room
POST
/hotels/{hotelId}/reservations/massAdvanceCheckIns
Mass Advance Check in Reservations
POST
/hotels/{hotelId}/reservations/massCheckIns
Mass checkin reservations
POST
/hotels/{hotelId}/reservations/{reservationId}/advanceCheckIns
Advance checkin a reservation
DELETE
/hotels/{hotelId}/reservations/{reservationId}/advanceCheckIns
Reverse Advance Checkin
DELETE
/hotels/{hotelId}/reservations/{reservationId}/checkIns
Revert a checked-in Reservation
POST
/hotels/{hotelId}/reservations/{reservationId}/checkIns
Checks in a guest
GET
/hotels/{hotelId}/reservations/{reservationId}/keyOptions
Fetch the keysOptions
GET
/hotels/{hotelId}/reservations/{reservationId}/linked
Get linked reservations
PUT
/hotels/{hotelId}/reservations/{reservationId}/priority
Change the reservation queue priority
POST
/hotels/{hotelId}/reservations/{reservationId}/roomAssignments
Assign a Room to a Reservation
GET
/hotels/{hotelId}/reservations/{reservationId}/roomKeys
Fetch the room keys
POST
/hotels/{hotelId}/reservations/{reservationId}/roomKeys
Requests room key(s)
DELETE
/hotels/{hotelId}/reservations/{reservationId}/roomKeys
Delete room key
PUT
/hotels/{hotelId}/reservations/{reservationId}/roomKeys
Update room keys.
GET
/hotels/{hotelId}/reservations/{reservationId}/roomMoveHistory
Get room move history of a reservation
PUT
/hotels/{hotelId}/reservations/{reservationId}/rooms
Remove an assigned room
PUT
/hotels/{hotelId}/reservations/{reservationId}/rooms/{roomId}/roomMoves
Move in-house guest
GET
/hotels/{hotelId}/reservations/{reservationId}/suggestedRooms
Get Suggested Rooms
PUT
/hotels/{hotelId}/reservations/{reservationId}/textMessages/{messageType}
Deliver Queue rooms text message
GET
/hotels/{hotelId}/reservations/{reservationId}/verifyCheckIns
Verify checkin reservation
GET
/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls
Get Wake Up Call
PUT
/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls
Change Wake Up Call
DELETE
/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls
Delete Wake Up Call
POST
/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls
Create Wake Up Call
GET
/hotels/{hotelId}/reservationsKeyOptions
Fetch keysOptions for the reservation and the guest profile
GET
/hotels/{hotelId}/roomKeysDetails
Read room key
POST
/hotels/{hotelId}/roomKeysExternal
Requests room key(s)
GET
/hotels/{hotelId}/rooms
Get hotel rooms
POST
/hotels/{hotelId}/rooms/onHold
Place Rooms On Hold
POST
/hotels/{hotelId}/rooms/onHold/release
Release Rooms On Hold
GET
/hotels/{hotelId}/serviceRequests
Get Service Requests
PUT
/hotels/{hotelId}/serviceRequests
Change Service Requests
POST
/hotels/{hotelId}/serviceRequests
Create Service Requests
DELETE
/hotels/{hotelId}/serviceRequests/{serviceRequestId}
Delete Service Requests
PUT
/hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/shiftRooms
Operation for Shift Rooms between two reservations
PUT
/hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/swapRooms
Operation for Swap/Shift Rooms between two reservations
GET
/hotels/{hotelId}/textMessages/{messageType}
Get Queue room text message
GET
/hotels/{hotelId}/wakeUpCallsdeprecated
Get Wake Up Calls
POST
/hotels/{hotelId}/wakeUpCalls/searches
Get Wake Up Calls
GET
/services/frontDeskOperations/status
Ping Front Desk Service
Schemas 597
The contract defines 597 schemas that model the data the API accepts and returns. The most detailed are hotelReservationType (101 properties), profileType (55 properties), reservationInfoType (53 properties), reservationMembershipType (43 properties). Each schema is shown below with its type and property counts.
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
prepaidCardsType
array
Holds fixed charge detail.
cardReIssueType
string
Request to re issue a new card.
resAccompanyGuestInfoType
object
5 properties
stayInfoType
object
Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaini…
37 properties
entityType
string
Indicates the rule is based on Minutes associated with the charge.
reservationECertificatesType
array
Collection of ECertificateType object.
configPackageUsageDetailType
object
A Config Package Usage Detail type.
4 properties
policyBasisTypeType
string
Full Amount.
salesInfoType
object
Provides sales information about the profiles of type company, travel agent, source and contact.
13 properties
folioStatusType
string
The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
dailyRatesType
array
Defines room rate information on a daily basis.
reservationsSummaryType
object
Type which shows all fetched reservations summary depends on Fetch Summary Instruction.
3 properties
profileSubscriptionListType
array
Details of the OPERA Profile subscription to external system
pkgInventoryItemType
object
4 properties
negotiatedType
object
This holds a list of NegotiatedInfoType.
3 properties
roomsAI
object
Request to run AI Room Assignment and allocate rooms to incoming reservations.
2 properties
massAdvanceCheckInReservations
object
Request object to Submit Batch job for Mass Advance Check In of Reservations.
3 properties
wakeUpCalls
object
Fetch wake up calls response.
3 properties
characterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
alertType
object
25 properties
timeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to…
3 properties
assignedRoom
object
Possible errors that the operation will generate: The reservation is not in Reserved state. The room being requested does not exist.
5 properties
indicatorType
object
Lamp indicator Type.
2 properties
roomKeyGuest
object
Information about the guest for whom a key can be created.
9 properties
fixedChargesType
array
Holds fixed charge detail.
imageStyleType
string
An enumeration of image styles.
addressInfoType
object
Provides address information.
3 properties
keyTrackType
object
4 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
roomKeysExternalDetails
object
Response for the key request made to DLS from OPERA Cloud.
20 properties
8 required
roomKeyMultipleGuests
object
Short room key information containing information about the multiple guests and room key options .
4 properties
transactionDiversionDailyDetailType
object
List of daily details for Transaction Diversion rule.
3 properties
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
eCertificateInfoType
object
E-Certificates details.
14 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
customerType
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
26 properties
callType
object
Holds call information.
11 properties
housekeepingRoomStatusType
string
Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOf…
dateTimeRangeType
object
Date Range with Start and End dates.
2 properties
excludedDateType
object
Specifies all the enabled dates.
2 properties
profileSubscriptionType
object
Contains details of the profile subscription. The subscription represents the link between the OPERA profile and the external profile within a particular exter…
11 properties
profileDeliveryModuleType
string
Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..
discountType
object
Identifies and provides details about the discount. This allows for both percentages and flat amounts. If one field is used, the other should be zero/not speci…
5 properties
hotelInterfaceType
object
8 properties
reservationPaymentMethodsType
array
Defines reservation payment methods.
cardProcessingType
string
reservationHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
hotelRoomsType
object
Collection of Room record that contain Housekeeping and Out Of Order information.
2 properties
changeInterfaceStatusType
object
This will contain reservation id and corresponding interface information for which the interface status needs to be updated.
3 properties
QueueRoomsTextMessage
object
Response for delivering a text message via Queue Reservations (to a guest) or Queue Rush (to housekeeping).
3 properties
turndownInfoType
object
1 property
roomCleaningPriorityType
object
Type to indicate the cleaning priority for a room.
1 property
packageConsumptionType
object
Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.
4 properties
errorType
object
Standard way to indicate that an error occurred during the processing of an message. If the message successfully processes, but there are business errors, thos…
10 properties
prepaidCardType
object
Holds fixed charge information.
17 properties
blockId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
searchWakeUpCallsRequest
object
15 properties
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
resAccompanyGuestListType
array
Collection of accompany guests
resSharedGuestListType
array
Collection of shared guest reservations.
shareDistributionInstructionType
string
The type of Rate Amount Change to be done on the Sharer reservation. This can be FULL - Full Rate for each Sharer. SPLIT- Split the Rate amount between Sharer…
benefitsType
array
Basic information about membership benefit.
userSessionInfoType
object
11 properties
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
sitePlanSectionType
object
Represents the site plan section record.
5 properties
reservationPoliciesType
object
A collection of reservation deposit and cancellation policies.
4 properties
downgradeType
string
Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.
codeDescriptionType
object
This contains a generic code and description information.
2 properties
productSourceType
string
Sources of Products
roomSectionType
object
2 properties
reservationQueuePriority
object
Response to the request to add a reservation to the Queue for Check-In.
3 properties
resAwardsType
object
Membership Awards code applied on the reservation.
4 properties
roomKeysExternal
object
Request for generation of room key used for OutBound.
24 properties
6 required
massAdvanceCheckInCriteriaType
object
Criteria for performing Mass Advance Check In of Reservations
4 properties
roomConditionType
object
Condition to be assigned on the room.
3 properties
postingRhythmType
string
Simple type for posting Rhythm types.
room
object
The reservation must still be reserved to use this operation.
3 properties
surnameType
string
Family name, last name.
housekeepingSectionType
object
Information regarding Housekeeping Sections.
9 properties
ownerType
object
Generic type for information about an owner.
11 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
reservationECertificateType
object
Reservation ECertificate Type Information.
3 properties
confDeliveryMethod
string
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
reservationsInfo
object
Response object to the Fetch Reservation Request operation. Based on the criteria, reservation information is returned.
4 properties
attendantType
object
2 properties
unAssignedRoom
object
Response Body.
2 properties
hotelReservationsType
object
A collection of Reservation objects and Unique IDs of Reservation.
4 properties
prepaidCardTrxTypeType
string
Reload transaction.
profileDeliveryMethod
object
Delivery Information type to the profile.
7 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
roomKeyResponseCodeType
string
Response Code
commissionPaymentMethods
string
Check
operaVersionNumberType
string
Current Opera Version Number
compRoutingStatusType
string
Status which indicates that the Request of Comp Routing was declined
errorsType
array
An error that occurred during the processing of a message.
confirmationsType
array
List of confirmation letters.
addressType
object
Provides address information.
19 properties
autoRoomAssignType
object
Collection of error and warning if any.
9 properties
folioShortInfoType
object
This type contains information of generated bills.
8 properties
nameValueDetailType
object
Detailed information returned during name value search.
1 property
serviceRequests
array
Service request.
totalType
object
The total amount charged for the service including additional amounts and fees.
11 properties
taxesType
object
A collection of taxes.
3 properties
rateByAgeBucketType
object
Rate amount by age bucket.
3 properties
overrideInstructionsType
array
List of override actions done.
sentConfirmationStatus
string
stayFutureListType
object
A collection of reservation history details attached to Profiles.
4 properties
countryNameType
object
Code for a country or a nationality.
4 properties
dailyRateType
object
The total amount charged for the service including additional amounts and fees.
14 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
queueReservation
object
Request to add a reservation to the Queue for Check-In. A reservation can be added to the queue prior to Check-In on the day of arrival.
4 properties
userDefinedFieldsType
object
A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.
3 properties
relationshipAddressType
object
Provides address information for a Relationship.
5 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
additionalGuestAmountType
object
2 properties
hotelRoomsOrderBy
string
This type is used to support various sortings for available rooms search results.
dateRangeType
object
Date Range with Start and End dates.
2 properties
messageDeliveryType
object
Holds the Delivery Information of the Message
8 properties
roomRoomsType
array
Collection of rooms.
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
serviceRequestStatusType
string
benefitType
object
Basic information about membership benefit.
3 properties
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
13 properties
compAccountingType
object
Authorizer Information
12 properties
reservationTaxTypeInfo
object
Provides information about the Tax Type.
9 properties
dailyDocket
object
Response object for fetching log book entries.
3 properties
trackItLogType
object
Individual activity log related to the Track It ticket.
9 properties
roomKeysInfoListType
array
Contains details of Room key.
privacyInfoType
object
Defines Privacy related information for the profile.
14 properties
mealPlanCodeType
object
Meal plan codes associated with the rate codes.
5 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
operaVersion
object
Response for Ping operation.
3 properties
resCancellationPolicyType
object
A cancellation policy attached with the reservation.
5 properties
profileCashieringType
object
Contains cashiering related details for the profile
14 properties
keyOptionsInfoType
object
Response of fetch keyOptions operation.
4 properties
roomKeyStatus
object
Respose for the reading of room key.
9 properties
relationshipInfoType
object
Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.
8 properties
depositCancelRevenueType
string
The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
transactionDiversionRuleTypeType
string
The rule type on which the Transaction Diversion Rule is based. If a reservation has any of the following code, Transaction Diversion rule gets active for that…
turndownStatusType
string
Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Complet…
bookingTimeSpanType
object
The booking time span of the reservation, only applicable when time increments are being used.
2 properties
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
nameValueType
object
Contains name value pair.
6 properties
roomKeyInterfaceDetailsType
array
Configuration details of room key interface.
webUserHistoryType
object
Creation date time, Creator Id, last modification date time and last Modifier Id.
8 properties
keyOptionsInfoListType
object
9 properties
alertAreaType
string
negotiatedInfoType
object
This provides information for a profile negotiated rate.
6 properties
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
53 properties
roomKey
object
Request for generation of room key.
19 properties
membershipEarningPreferenceType
string
The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points.
fetchActivityBookingsType
object
Used in the request message to describe the "filtering Criteria" when executing an activity lookup.
5 properties
reservationTransactionDiversionsType
array
List of Transaction Diversion rules.
reservationPackageScheduleType
object
A HotelPackageSchedule type.
8 properties
foreignExchangeType
object
Foreign Exchange info.
2 properties
resCashieringType
object
Cashiering Information for the reservation.
14 properties
eCertificateType
object
E-Certificates details.
23 properties
swapShiftOverrideInstructionType
object
Contains information for the override actions performed while swapping or shifting rooms.
1 property
reservationDepositType
object
Reservation Deposit Type.
7 properties
hotelReservationType
object
The Reservation class contains the current reservation being created or altered.
101 properties
suggestedRoomType
object
List of suggested rooms and component rooms.
2 properties
routingInstructionType
object
Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit
8 properties
profileMembershipType
object
Detailed information of the memberships.
41 properties
reservationPaymentMethodType
object
8 properties
mealPlansType
array
Meal plan codes associated with the rate codes.
roomKeyExternalDetails
object
Response for the key request made to DLS from Opera PMS.
11 properties
3 required
wakeUpCallResvInfoType
object
Criteria to search and retrieve wake up calls.
16 properties
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
roomRangeType
object
2 properties
linkedReservations
object
3 properties
colorDefinitionType
string
Color definition type. This color definition type is used to determine the defintion of color
reservationList
object
A collection of reservation details attached to Profiles.
4 properties
reservationInterface
object
Request to change the interface status for a reservation.
3 properties
queuedRoomsTextMessage
object
Response for retrieving a predefined text message, for Queue Reservations or Queue Rush.
3 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
reservationKeyInfoType
object
Holds the room key information provided by the Door Lock System.
1 property
effectiveRatesType
array
Collection of effective rate amount per guest on specific dates.
dateTimeStampGroupType
object
5 properties
trackItActionType
object
Identifies the response expected from staff or other parties relative to a Track It ticket.
2 properties
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
activityLogListType
object
7 properties
floorPlans
object
Response object to the Fetch Reservation Request operation. Based on the criteria, reservation information is returned.
3 properties
awardType
object
Detailed information of the awards.
34 properties
eventId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
nameValueOriginType
object
Contains origin details.
4 properties
identificationInfoType
object
Information on the identification of the customer.
3 properties
wakeUpCallsType
array
List of the wake up calls
masterInfoCodeDetailType
string
status
object
Response Body.
2 properties
profileRestrictions
object
3 properties
promotionType
object
Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.
3 properties
holdRooms
object
Request to place rooms on hold.
4 properties
advanceCheckInReservation
object
Request object to perform Advance Check In of a Reservation.
3 properties
resvForBatchCCAut
object
Response which contains a listing of reservations, and associated payment methods, that require credit card authorization.
4 properties
roomKeyOutBoundType
string
Simple type for representing room key type.
fixedChargeScheduleType
object
Holds schedule of fixed charge.
5 properties
customChargeQuantityType
object
Contains quantity of custom charge exemptions.
2 properties
configPackageTransactionType
object
A HotelPackageTransaction type.
5 properties
linkedReservationType
string
Enumeration of the different Linked Reservation Types.
trxInfoType
object
Transaction codes info.
10 properties
roomKeyInterfaceRightType
object
3 properties
relationshipInfoSummaryType
object
RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact p…
7 properties
callHistoryType
array
Holds call information.
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
resAttachedProfileListType
array
eCertificateConsumptionType
object
E-Certificates details.
13 properties
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
relationshipProfileSummaryType
object
11 properties
awardsType
array
List of awards.
ownerResTypeType
string
rateChangeInstructionType
object
Defines override rate type.
2 properties
givenNameType
string
Given name, first name or names
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
eCouponType
object
Reservation eCoupon Type Information.
9 properties
companyInfoType
object
Company Information of the Profile.
3 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
10 properties
changedWakeUpCalls
object
Response Body.
2 properties
imageSetType
object
Represents on image set record.
11 properties
customChargeExemptionDateType
object
Contains Custom Charge Exemption information for a day.
2 properties
linkedReservationsInfoType
object
Linked Reservations.
7 properties
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
parametersType
array
Collection of generic Name-Value-Pair parameters.
roomDiscrepancyType
string
Simple type for discrepant room status instructions to be used in requests for fetching housekeeping and front office room discrepancy. Valid values are Sleep,…
exclusionReasonType
string
Custom Charge has already been Processed for this date within the reservation stay.
messageType
object
Holds the Message Information
5 properties
floorPlanType
object
Floor information containing collection of Room records that contain Housekeeping and Out Of Order information.
4 properties
eCertificateUsageCriteriaType
object
E-Certificates details.
8 properties
alienInfoType
object
immigration/visa information of a foreign person.
3 properties
requestType
string
Simple type for representing request type.
eCouponsType
array
Collection of ECouponType object.
currentRoomInfoType
object
Room information of the reservation for the current day.
8 properties
floorPlanRoomType
object
This type represents the primary room attributes.
27 properties
typeOfMessageType
string
The type of Message for Guest Messages.
queueRoomsTextCriteriaType
object
Text message criteria type, used to deliver a text message via Queue Reservations (to a guest) or Queue Rush (to housekeeping).
4 properties
compAuthorizerInfoType
object
Authorizer Information
3 properties
rateRangeType
object
Rate Range details like maximum rate amount and minimum rate amount in each available rate category.
2 properties
confirmationStyle
object
7 properties
amountType
object
Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentage…
10 properties
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
eCertificateIssueSourceType
string
Indicates that OPERA E-Certificate is issued by external system.
batchCCAuth
object
Request to start a batch job that will process a list of reservation, and their associated payment methods, that require credit card authorizations.
4 properties
serviceRequestsInfo
object
Response object for service requests.
3 properties
guestMessageType
object
Holds the Message information for a Reservation
13 properties
compRoutingRequestType
object
Type for the details of a Comp Routing Request
4 properties
excludedDatesType
array
Contains list of dates which are valid for custom charge exemptions.
interfaceRightsStatusType
object
4 properties
profileNameType
object
This provides name information for a person.
8 properties
traceTimeInfoType
object
4 properties
roomOccupancyInfoType
object
Information about room's recent and upcoming stays to help determine vacancy history and future occupancy.
4 properties
stayReservationInfoType
object
The Reservation class contains the current reservation being created or altered.
6 properties
mailingActionsType
object
Defines mailing action list for the profile.
5 properties
roomKeyExternal
object
Request for generation of room key used for OutBound.
19 properties
3 required
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
profileId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
hotelReservationTracesType
array
List of Reservation Traces.
reservationId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
profileStatusType
string
visaInfoType
object
3 properties
parameterType
object
Name value pair type that will hold generic parameter information. Only use this type when the parameters being passed are too dynamic to be defined.
2 properties
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
billingInstructionsType
array
Set of Billing Instruction codes.
blockResvSummaryType
object
Indicates summary of the Total reservations for the block.
1 property
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
depositPolicyType
object
Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.
10 properties
commissionPayoutToType
string
childAgesType
array
Age of a child in years.
housekeepingType
object
Identifies the Housekeeping information.
7 properties
ticketType
object
Reservation Ticket Type Information.
13 properties
changeHistoryType
object
Creation date time, Creator Id, last modification date time and last Modifier Id.
5 properties
rateByAgeBucketsType
array
Rate amount by age bucket.
activityLog
object
Fulfillment activity log response.
3 properties
lastStayInfoType
object
Contains last stay related details for the profile
4 properties
rewardCertificateType
string
Point Saver reward.
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
backToBackResSequenceType
object
Type object represents Back To Back Sequence Position and Total Count of Linked Back To Back Reservations ordered by consecutive Stay Dates.
2 properties
batchCCAuthReservationStatusType
string
reservation statuses for credit card authorizations
profileSharedLevelType
string
Simple types for Shared level.
reservationFolioWindowsType
array
Collection of reservation folio windows.
prepaidCardTransactionType
object
Prepaid Card transaction.
9 properties
activityList
array
A collection of Activity objects.
roomConditionAssigmentType
string
Simple type for Room Condition assignment type. Valid values are Available and NotAvailable Only.
packageCodeHeaderType
object
4 properties
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
commentInfoType
object
Comment related to the profile/reservation.
8 properties
nameValuesType
array
List of name value pairs.
reservationIdList
array
Unique Id that references an object uniquely in the system.
routingInfoType
object
A routing info object can either be of type Folio OR of type Room with its corresponding object.
5 properties
directBillingType
object
This is the preconfigured routing instruction type.
2 properties
eCertificateStatusType
string
Indicates that OPERA E-Certificate is reserved.
alertsType
array
List of alerts.
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
eCertificateScopeType
string
Indicates that OPERA E-Certificate is available for a specific list of hotels.
actionStatusType
string
Action status of the Track It item(Open, Closed, InProgress).
gdsNegotiatedInfoType
object
This provides information for a channel negotiated rate.
5 properties
thresholdDetailsType
object
Type for the threshold elements.
5 properties
roomKeyEncodersType
array
Holds the key encoder right.
billingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
4 properties
eCertificateGenerationType
object
E-Certificates details.
3 properties
resInventoryItemSourceType
object
Defines whether the item is setup due to a Rate Plan, Package or a Block.
5 properties
assignedRoomsSummaryType
object
Indicates summary of the assigned rooms.
1 property
eCertificatesType
array
List of e-certificates for the profile.
frontOfficeRoomStatusType
string
Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied.
keywordType
object
3 properties
childBucketsType
object
Defines children counts with Age Qualifying Group(Child Bucket) classification.
5 properties
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
rateChangeType
string
Simple type for rate change type.
profileTaxInfoType
object
Profile information related to tax.
7 properties
reservationTransactionDiversionType
object
A Transaction Diversion Rule Type
16 properties
resInventoryItemsType
object
Defines a collection of inventory items attached to a reservation.
2 properties
shortReservation
object
10 properties
roleUserEntryType
object
Role or User in which the log book entry belongs to.
2 properties
profileRoutingInstructionsType
object
The type contains routing instructions for the profile.
3 properties
roomRateType
object
43 properties
reservationRoomSelectionType
object
Defines search criteria needed to configure a room to a reservation.
16 properties
vIPStatusType
object
VIP status of the customer.
2 properties
roomKeyType
string
Simple type for representing room key type.
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
foliosShortInfoType
array
This type contains a list of generated bills for a reservation.
reservationRoomSelectionOverrideType
object
Define the override flag which will be used when configuring a room to a reservation.
18 properties
resProfileTypeType
string
roomMoveDetailType
object
Room move history information.
8 properties
airaLastRunStatusInfo
object
Response of last execution status for AI Room Assignment
6 properties
codeListType
array
futureListType
object
A collection of reservation history details attached to Profiles.
4 properties
customChargeExemptionsType
array
List of Custom Charge Exemptions.
customChargeExemptionType
object
Contains custom charges exemption information.
6 properties
checkedInReservationInstructionType
string
Fetch Instruction to indicate if any automatically generated folios information should be returned in the response. For example, in a scenario when automatic c…
trackItGroup
string
Group to which the Track It items belong.
checkedinReservation
object
CheckIn response will commonly be errors over warnings. If a check has to be done before checking a reservation to a hotel, then the VerifyCheckinReservation o…
3 properties
activityLookUpList
array
Criteria for fetching Activity Bookings.
reservationStayHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
associatedResType
object
Information regarding associated reservations to the reservation.
2 properties
packagePostingRhythmType
object
Package Posting rhythm type.
5 properties
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
19 properties
functionArgumentType
object
This type provided details of a function argument and the value it holds.
5 properties
scheduledRoomMoveType
object
Scheduled Room Move information.
4 properties
housekeepingRoomReservationStatusType
string
Room Reservation status types used in housekeeping. These may be different from the actual reservation statuses as these relate to the current reservation for…
articlePostItType
object
Post it information of an article.
2 properties
shiftRooms
object
To quickly shift rooms for two reservations that are for the same arrival date and room type
5 properties
nameTypeType
string
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
resDepositPolicyType
object
A deposit policy attached with the reservation.
6 properties
payeeInfoType
object
Payee information.
7 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
reservationsForCCAuthType
array
List of reservations with their payment methods.
roomMoveDetailsType
array
List of room move details
resGuestAdditionalInfoType
object
8 properties
roomKeyDetails
object
Response for room key creation.
6 properties
massCheckInReservations
object
Request object to Submit Batch job for Mass Checkin of Reservations.
3 properties
roomTypeShortInfoType
object
Basic information of room type.
14 properties
verifiedCheckinReservation
object
3 properties
nameValueDataTypeType
string
userSessionDefaultsType
object
9 properties
roomKeyInterfaceDetailType
object
11 properties
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
hotelReservationTraceType
object
Extended Trace object to hold information for a reservation.
16 properties
autoAssignRoom
object
Request for auto assignment of rooms to reservations.
3 properties
linkedReservationInfoType
object
20 properties
membershipType
object
Detailed information of the memberships.
41 properties
attachmentType
object
Attached files.
12 properties
historyListType
object
A collection of reservation history details attached to Profiles.
4 properties
callerType
object
Holds caller information.
11 properties
trackItId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
profileKeyOptionsType
object
2 properties
roomFeaturesType
array
A recurring element that identifies the room features.
welcomeOfferType
object
2 properties
roomStayType
object
27 properties
massCheckInCriteriaType
object
This will have details of reservations and advance criteria for performing Mass Checkin of Reservations
4 properties
webUserAccountsType
array
Web User Accounts List.
roomOccupancyType
object
Room Occupancy information.
6 properties
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
profileCashieringDetailType
object
The type contains routing instructions for the profile.
6 properties
trackItLogListType
array
trackItReservationInfoType
object
Reservation info associated with a Track It item.
9 properties
emailInfoType
object
Information on an email for the customer.
3 properties
resGuestType
object
A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGu…
6 properties
ratesType
object
Individual rate amount.
2 properties
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
cateringResInfoType
object
Information regarding catering event and catering revenue type associated to the reservation.
2 properties
facilityCodesType
array
List of the facility codes.
roomRoomType
object
This type represents the primary room attributes.
14 properties
roomDiscrepanciesType
array
Room Discrepancies between front office and housekeeping room status and number of persons in the room.
personNameTypeType
string
Person's name in an external system.
welcomeOfferOptionsType
string
None of the Welcome Offer option is selected.
dateUDFsType
array
Used to hold collection of user defined fields of Date Type.
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
translationTextType2000
object
Contains Multiple translated texts and language codes.
2 properties
feeType
object
Applicable service charges or fees.
5 properties
dateUDFType
object
Used to hold user defined field of Date Type.
3 properties
keyUserType
string
Simple type for representing key user type. 'Guest' = request Opera Guest room key
uRLInfoType
object
Web site address.
3 properties
awardId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
guestMessagesType
array
Holds the Message Information
unAssignRoomCriteria
object
Request to the remove a room(unassign) from a reserved reservation.
6 properties
roomSummaryType
object
2 properties
resAttachedProfileType
object
3 properties
transactionDiversionDailyDetailsType
array
List of daily details for Transaction Diversion rule.
reservationLocatorType
object
Holds the information for a Reservation Guest Locator
6 properties
keywordDetailType
object
1 property
roomKeyInfoType
object
Contains detail information of room keys .
12 properties
taxTypeType
object
Provides information about the Tax Type.
8 properties
roomMoveHistory
object
Response for the fetch room move history of a reservation.
3 properties
printDataType
object
Lists the text, file or picture to print onto a Guest room key (only for roomKeyType is HardKey).
3 properties
roomKeyInterfaceDetails
object
Response with the configuration details of active room key interfaces including the available key encoders.
3 properties
feesType
object
A collection of fees or service charges.
3 properties
roomStatusListType
array
Room Status Type.
roomStatusType
object
4 properties
roomOutOfOrderType
object
Out Of Order and Out Of Service Room information.
8 properties
translationsTextType
array
Language code for the translation.
floorPlanRoomGuestType
object
6 properties
eCertificateIssueType
string
Indicates that guest purchased OPERA E-Certificate.
configPackagePrimaryDetailsType
object
A Config Package Info type.
6 properties
roomsHoldType
object
Hold reason and the list of the rooms that are to be put on hold under that reason.
4 properties
roomHoldType
object
3 properties
webUserAccountType
object
Web User Account of the guest.
11 properties
externalReferencesType
array
This type contains unique information of external reference.
fixedChargeDetailType
object
Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.
7 properties
roomFeatureType
object
Room Feature Information.
4 properties
reservationPackageType
object
A ReservationPackageType class.
13 properties
autoAssignedRoom
array
Collection of result set which is made of reservation id, error and warning.
pMS_ResStatusType
string
This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.
suggestedRooms
object
Response of fetch suggested rooms operation.
3 properties
employeeInfoType
object
9 properties
profileTypeType
string
The types of Profile handled by the web service.
profileIdList
array
Unique Id that references an object uniquely in the system.
primaryShareTypeType
string
routingInfoListType
array
A routing info object can either be of type Folio OR of type Room with its corresponding instructions.
fBAInfoType
object
FBA ( Flexible Benefits Awards ) related fields.
22 properties
prepaidCardDetailsType
object
Prepaid Card Details.
10 properties
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
links
array
trackItType
object
Identifies the kind of Parcel, Baggage, or Lost items or Valet-managed vehicles or services.
2 properties
packagePostingRulesType
object
5 properties
awardStatusType
string
Indicates that certificate is in use.
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
eCertificateClassficationType
string
Enumeration of the different type of Ecertificate.
batchCCAuthToProcess
object
Response for starting a credit card authorization batch job, which contains the batch ID upon success.
4 properties
numericUDFType
object
Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Rese…
3 properties
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
personNameType
object
This provides name information for a person.
12 properties
keyCardType
string
Key card types.
fBAStatusType
string
Flexible benefit award has been reimbursed.
scopeType
string
Minimum required and complimentary values are applicable Per Stay.
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
amountDeterminationType
string
Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.
resPaymentCardType
object
Information on a credit card for the customer.
19 properties
effectiveRateType
object
Effective rate amount per guest on specific dates.
22 properties
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
indicatorsType
array
Collection of lamp indicators.
trackItItemType
object
Detailed information of a Track It item.
14 properties
roomsOutOfOrderType
array
Date Range and reasons for a room being Out of Order/Out Of Service (If the room is OO/OS).
reservationAutoRoomAssignRequestType
object
Request criteria for auto assignment of rooms to reserved reservations.
3 properties
timeWindowType
object
Defines a Time period with start time and an end time.
2 properties
stringLength2000
string
Used for Character Strings, length 0 to 2000.
addtionalCodeInfoType
array
Holds name of additional code information
externalRoomKeyType
string
Simple type for representing room key request type. 'HardKey' = request for physical key card with RFID; 'MobileKey' = request for mobile key (no physical key)…
roomOwnershipType
object
Define the search criteria for retrieving room ownership records
9 properties
messageStatusType
string
Status of the Message.
movedInHouseGuest
object
Potential errors which this operation might respond are the following: - Reservation is NOT In-House. - The room is NON-EXISTENT for the hotel. - The room is N…
5 properties
reservationForCCAuthType
object
Reservation details, including a list of the associated payment methods.
13 properties
uniqueID_Type
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
2 properties
telephoneType
object
Information on a telephone number for the customer.
12 properties
dailyDocketType
array
log book entry.
reservationShortInfoType
object
8 properties
keyOptionsResponseType
object
This contains code and description information for key options.
4 properties
transactionDiversionRuleLevelType
string
Reservation level.
reservation
object
Validation checks includes the following: - Reservation is not valid to be checked in. - Split is still required before the reservation can be checked in. - Ro…
5 properties
nameValueModuleType
string
confDeliveryInfoTypes
array
List of confirmation letter delivery methods and their status
scheduledRoomMoveInfoType
object
Scheduled Room Move information.
6 properties
reservationQueuePriorityNumber
object
Request to change the current priority of a reservation in Queue for Check-In.
3 properties
unassignedRoomsSummaryType
object
Indicates summary of the unassigned rooms.
1 property
preferenceType
object
Guest Preference details for the profile.
8 properties
tierAdministrationType
string
Do not upgrade membership. The membership may be downgraded.
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
alertGuestInfoType
object
13 properties
roomRateAvailReasonType
string
Indicates the Room Rate is not available due to unavailability of enough items for the rate code.
roomKeyInfo
object
Response of fetch room keys operation.
5 properties
updateRoomKeys
object
Collection of error and warning if any.
2 properties
configPostingAttributesType
object
A config Package posting attributes type.
18 properties
traceResolveType
object
2 properties
authorizerInfoType
object
Authorizer Information
5 properties
keyOptionsType
object
This contains code and description information for key options.
2 properties
resCommunicationType
object
Communication details for a reservation.
2 properties
ratePlanRatingType
string
Possible Rate plan rating values.
masterInfoType
object
2 properties
transportInfoType
object
7 properties
packageTransactionCodeType
object
3 properties
roomsHoldsType
array
List of rooms, reason, and comments.
resDepositPoliciesType
array
A list of deposit policies attached with the reservation.
reservationProfileType
object
3 properties
wakeUpCallType
object
Criteria to search and retrieve wake up calls.
16 properties
moveInHouseGuest
object
To move a reservation, the reservation needs to be in Checked-In state.
3 properties
dateTimeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to…
2 properties
overrideInstructionType
object
Type for Overrides. Contains information for the override action performed while booking a reservation.
6 properties
reservationMembershipType
object
Detailed information of the memberships.
43 properties
applicationUserType
object
18 properties
itemInfoType
object
Basic information regarding an Item.
15 properties
stayRoominfo
object
Request which contains parameters needed to swap or shift rooms
3 properties
basicEmailType
string
Email address
paymentMethodsSummaryType
object
2 properties
awardVouchersType
array
This stores the Membership Awards code applied on the reservation.
deliverQueueRoomsTextMessage
object
Request to deliver a text message via Queue Reservations (for a guest) or Queue Rush (for housekeeping).
3 properties
profileCommissionType
object
This is the preconfigured routing instruction type.
7 properties
serviceRequest
object
Service request.
19 properties
identificationType
object
Identification information of the customer.
10 properties
articleInfoType
object
Information regarding an article.
9 properties
relationshipProfileType
object
13 properties
reservationsInQueue
object
Response for the operation to fetch Reservations in Queue
4 properties
policyAmountPercentType
object
Defines the percentage basis for calculating the fee amount or the amount.
5 properties
resInventoryItemType
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
10 properties
masterAccountInfoType
object
2 properties
keyOptionsInfo
object
Response of fetch keyOptions operation.
5 properties
numericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
roomType
object
This type represents the primary room attributes.
30 properties
packageCalculationRuleType
string
Simple type for package caluculation rules.
offsetUnitType
string
Indicates deadline offset unit type.
advanceCheckInReservationType
object
Information needed to perform Advance Check In of a Reservation
7 properties
roomPersonsType
object
2 properties
activityLogType
object
12 properties
masterType
string
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
queueRoomsTextMessageType
string
Text message will be delivered via Queue Rush, to housekeeping.
phoneNumberType
string
Phone number
membershipTypeLevelType
object
2 properties
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
eCertificateConsumeSourceType
string
Indicates that OPERA E-Certificate is consumed by hotelPMS.
confRecipientInfoType
object
7 properties
upsellInfoType
object
Information regarding upsell for a reservation.
2 properties
dailyDocketEntryType
object
Log book entry.
7 properties
iATAInfoType
object
IATA Information of the profile.
3 properties
reservationCertificateType
string
Certificate is incentive.
awardKindType
string
Indicates that this is electronic certificate.
preferenceTypeType
object
Preference details for the profile.
13 properties
attachmentsType
array
Attachment List.
wakeUpCallStatusType
string
Statuses of the wake up call.
guestCountsType
object
A collection of GuestCount by age group.
4 properties
emailType
object
Information on an email for the customer.
11 properties
swapRooms
object
To quickly swap or shift rooms for two reservations that are for the same arrival date and room type
5 properties
ticketsType
array
Collection of TicketType objects.
fixedChargeType
object
Holds fixed charge information.
8 properties
codeType
string
Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
confDeliveryInfoType
object
4 properties
uRLType
object
Web site address, in IETF(The Internet Engineering Task Force) specified format.
5 properties
customChargeExemptionDatesType
array
Contains List of Custom Charge Exemption information for a day.
codeInfoType
object
4 properties
companyType
object
20 properties
resStatClassificationType
object
Statistical Classification information for the reservation.
2 properties
trxCodesInfoType
array
List of Transaction codes info.
changeRelationsType
object
Detailed information regarding the changes made to relationships for the profile.
5 properties
stayHistoryListType
object
A collection of reservation history details attached to Profiles.
4 properties
resCancelPenaltyType
object
The CancelPenalty class defines the cancellation policy of the hotel facility.
9 properties
roomKeyInterfaceRightsType
array
Holds the key encoder right.
reservationAllowedActionsType
array
Allowed action.
vIPType
object
The supplier's ranking of the customer.
2 properties
searchMatchesType
array
List of Generic Name-Value-Pair Parameters used for super search matches.
hotelRooms
object
9 properties
stringLength200
string
Used for Character Strings, length 0 to 200.
reservationDisplayColorInfoType
object
Information of reservation display color, determined based on OPERA parameter RESERVATIONCOLORDEFINITION
3 properties
languageType
string
taxType
object
Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should…
5 properties
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
4 properties
scheduledRoomMoveStatusType
string
Flag indicating scheduled room move status.
userInfoType
object
Opera User Information
2 properties
trackItItemsType
array
requestActionType
string
confirmationType
object
11 properties
functionArgumentsType
array
Collection of function arguments and their corresponding values.
roomKeyEncoderType
object
5 properties
currentServicingAttendantType
object
The Attendant Name and ID of the attendant servicing the room.
16 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
fixedChargeFrequencyType
string
Yearly.
resCancellationPoliciesType
array
A list of reservation cancellation policies.
anonymizationStatusType
string
Guest has been anonymized.
characterUDFType
object
Used to hold user defined field of Character/String Type.
3 properties
policyDeadlineType
object
Cancellation deadline, absolute or relative.
4 properties
childAgeType
object
Defines Child's Age.
1 property
packageElementType
object
15 properties
roomInterfaceStatus
object
Response object for fetching room interface status
3 properties
servicingAttendantStatusType
string
Possible values for the Status of a Servicing Attendant.
stayDateInfoType
object
Room attached with stay detail information
2 properties
externalReferenceType
object
This type contains unique information of external reference.
3 properties
gdsNegotiatedType
object
This holds a list of GdsNegotiatedInfoType.
4 properties
profileAccessType
object
4 properties
profileType
object
Type provides the detailed information about the profile and its children.
55 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
3 properties
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
hotelInterfaceTypeType
string
XML Posting Interface
reservationLocatorsType
array
Holds the Locator Information.
reservationRoomOwnershipType
string
Indicates if the assigned reservation room is an Owner/Referral or Regular room.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle Hospitality 12
Other APIs Oracle Hospitality publishes across the network.
OPERA Cloud RnA Activities GraphQL API
OPERA Cloud RnA ARAccountsReceivable GraphQL API
OPERA Cloud RnA ARAgingReport GraphQL API
OPERA Cloud RnA ARLedger GraphQL API
OPERA Cloud RnA BookingReservationExtended GraphQL API
OPERA Cloud RnA BookingsBlockProductionChanges GraphQL API
OPERA Cloud RnA BookingsBlockStatusChanges GraphQL API
OPERA Cloud RnA BookingsBlock GraphQL API
OPERA Cloud RnA BookingsReservation GraphQL API
OPERA Cloud RnA CateringEventForecast GraphQL API
OPERA Cloud RnA CateringEventPostings GraphQL API
OPERA Cloud RnA CateringEventStatusChanges GraphQL API
#FrontDeskOperations
Where this information came from
This is an independent, third-party profile of Oracle Hospitality Front Desk Operations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.