Oracle Hospitality FOF Stats API
The Front Desk Statistics module will provide statistical data related to front desk operations in a property.
Oracle Hospitality FOF Stats 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 FOFStats. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 7 operations across 7 paths, and defines 180 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.
7 operations
7 paths
180 schemas
7 GET
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 7
Across 7 paths, the API surfaces 7 operations — 7 GET. Each is listed below with its method, path, parameters, and response codes.
FOFStats 7
The Front Desk Statistics module will provide statistical data related to front desk operations in a property.
GET
/hotels/{hotelId}/frontOfficeStatistics/{statisticsCode}
Get front office Statistics
GET
/hotels/{hotelId}/frontOfficeStatisticsRange/{statisticsCode}
Get front office Statistics
GET
/hotels/{hotelId}/houseKeepingStatistics
Get housekeeping statistics
GET
/hotels/{hotelId}/queueReservationsStatistics
Get reservation queue statistics
GET
/hotels/{hotelId}/reservationStatusStatistics
Get Reservation Status Statistics
GET
/hotels/{hotelId}/roomStatusStatistics
Get counts of rooms by housekeeping status and front office status.
GET
/services/fofStats/status
Ping FOF
Schemas 180
The contract defines 180 schemas that model the data the API accepts and returns. The most detailed are reservationInfoType (53 properties), stayInfoType (37 properties), resGuestInfoType (30 properties), resPaymentCardType (19 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
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
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
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
reservationFolioWindowsType
array
Collection of reservation folio windows.
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
53 properties
personNameType
object
This provides name information for a person.
12 properties
statistics
object
Response element for frontOffice statistics.
5 properties
roomConditionAssigmentType
string
Simple type for Room Condition assignment type. Valid values are Available and NotAvailable Only.
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
reservationIdList
array
Unique Id that references an object uniquely in the system.
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
resCashieringType
object
Cashiering Information for the reservation.
14 properties
roomStatusStatisticsCountType
object
2 properties
resPaymentCardType
object
Information on a credit card for the customer.
19 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
reservationPaymentMethodType
object
8 properties
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
indicatorsType
array
Collection of lamp indicators.
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
indicatorType
object
Lamp indicator Type.
2 properties
roomsOutOfOrderType
array
Date Range and reasons for a room being Out of Order/Out Of Service (If the room is OO/OS).
addressInfoType
object
Provides address information.
3 properties
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.
warningsType
array
Used in conjunction with the Success element to define a business error.
addtionalCodeInfoType
array
Holds name of additional code information
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
reservationQueueRoomTypeStatisticsType
object
Type for Room Type statistics for reservations currently in Queue for Check-In. Statistics would be the number of rooms for each room type which is currently i…
3 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
reservationShortInfoType
object
8 properties
vIPStatusType
object
VIP status of the customer.
2 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
roomStatusStatisticsType
object
4 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…
resProfileTypeType
string
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
reservationStatusEnumType
string
Reservation Status Enum Type
codeListType
array
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
assignedTaskType
object
Holds the assigned task code for a tasksheet.
1 property
assignedTasksType
array
Holds the assigned task codes for a tasksheet.
masterInfoCodeDetailType
string
hotelInterfaceType
object
8 properties
cardProcessingType
string
authorizerInfoType
object
Authorizer Information
5 properties
reservationQueueStatistics
object
Response for the fetch of current Reservations In Queue statistics. Contains the statistic information.
3 properties
resCommunicationType
object
Communication details for a reservation.
2 properties
masterInfoType
object
2 properties
ratePlanRatingType
string
Possible Rate plan rating values.
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
turndownInfoType
object
1 property
roomCleaningPriorityType
object
Type to indicate the cleaning priority for a room.
1 property
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…
nameTypeType
string
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
reservationStatusStatisticsResponseType
object
Reservation Status Statistics
1 property
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
applicationUserType
object
18 properties
taskSheetType
string
Task Sheet classification.
payeeInfoType
object
Payee information.
7 properties
resAccompanyGuestListType
array
Collection of accompany guests
blockIdList
array
Unique Id that references an object uniquely in the system.
basicEmailType
string
Email address
reservationQueueStatisticsType
object
Type for statistics of the reservations currently in Queue for Check-In.
3 properties
resSharedGuestListType
array
Collection of shared guest reservations.
roomTypeShortInfoType
object
Basic information of room type.
14 properties
taskSheetStatistics
object
3 properties
userSessionDefaultsType
object
9 properties
hSKTaskSheetInfoType
object
Holds the information for the task sheet.
11 properties
userSessionInfoType
object
11 properties
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
sitePlanSectionType
object
Represents the site plan section record.
5 properties
codeDescriptionType
object
This contains a generic code and description information.
2 properties
roomSectionType
object
2 properties
roomFeaturesType
array
A recurring element that identifies the room features.
roomConditionType
object
Condition to be assigned on the room.
3 properties
surnameType
string
Family name, last name.
hSKTaskSheetDetailsInfoType
object
Holds the task sheet statistics details information.
1 property
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
housekeepingSectionType
object
Information regarding Housekeeping Sections.
9 properties
reservationStatusStatisticsType
object
Reservation Statistics for a Reservation Status
3 properties
emailInfoType
object
Information on an email for the customer.
3 properties
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
hSKAttendantTimeLogsType
object
Holds the information for the task sheet.
4 properties
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
facilityCodesType
array
List of the facility codes.
resAttachedProfileListType
array
hSKStatCodeType
string
Supported housekeeping statistical 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.
roomPersonsType
object
2 properties
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
masterType
string
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
translationTextType2000
object
Contains Multiple translated texts and language codes.
2 properties
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
phoneNumberType
string
Phone number
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
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
attendantType
object
2 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
10 properties
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
resAttachedProfileType
object
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,…
emailType
object
Information on an email for the customer.
11 properties
hSKStatReportCodeType
string
Supported Housekeeping report codes.
operaVersionNumberType
string
Current Opera Version Number
hSKTaskSheetStatisticsInfoType
object
Holds the task sheet statistics information.
2 properties
hSKStatType
object
Since the statistical value can be represented in different measure of units, this element will provide a flexible definition for the supported Opera9 statisti…
3 properties
addressType
object
Provides address information.
19 properties
taxTypeType
object
Provides information about the Tax Type.
8 properties
codeInfoType
object
4 properties
roomStatusStatisticsListType
object
3 properties
childAgesType
array
Age of a child in years.
roomStatusType
object
4 properties
roomOutOfOrderType
object
Out Of Order and Out Of Service Room information.
8 properties
translationsTextType
array
Language code for the translation.
roomTypeStatisticsType
object
Reservation Statistics for a Room Type
2 properties
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
reservationAllowedActionsType
array
Allowed action.
roomClassStatisticsType
object
Reservation Statistics for a Room Class
3 properties
roomHoldType
object
3 properties
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.
externalReferencesType
array
This type contains unique information of external reference.
countryNameType
object
Code for a country or a nationality.
4 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
roomFeatureType
object
Room Feature Information.
4 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
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.
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
4 properties
dateRangeType
object
Date Range with Start and End dates.
2 properties
interfaceRightsStatusType
object
4 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
currentServicingAttendantType
object
The Attendant Name and ID of the attendant servicing the room.
16 properties
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
13 properties
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
reservationTaxTypeInfo
object
Provides information about the Tax Type.
9 properties
employeeInfoType
object
9 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
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
anonymizationStatusType
string
Guest has been anonymized.
profileIdList
array
Unique Id that references an object uniquely in the system.
childAgeType
object
Defines Child's Age.
1 property
servicingAttendantStatusType
string
Possible values for the Status of a Servicing Attendant.
statUnitCategoryType
string
Supported statistical units.
stayDateInfoType
object
Room attached with stay detail information
2 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
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
externalReferenceType
object
This type contains unique information of external reference.
3 properties
links
array
operaVersion
object
Response for Ping operation.
3 properties
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
commissionPayoutToType
string
hotelInterfaceTypeType
string
XML Posting Interface
housekeepingType
object
Identifies the Housekeeping information.
7 properties
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…
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
#FOFStats
Where this information came from
This is an independent, third-party profile of Oracle Hospitality FOF Stats 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.