Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: OPERA Cloud Front Desk Operations Service FOF Stats API
description: APIs to cater for Front Desk Operations and Front Desk Statistic functionality in OPERA Cloud. <br /><br /> Front Desk features some of the most commonly used operations in OPERA Cloud, such as managing guest arrivals, managing in-house guests, and managing guest departures. Some additional tasks you can complete from the Front Desk menu are room searches, room assignments, and quick check outs as well as opening folios, creating registration cards, setting wake up calls, and sending messages to guests.<br /><br /> Compatible with OPERA Cloud release 26.2.0.0.<br /><br /><p> This document and all content within is available under the Universal Permissive License v 1.0 (https://oss.oracle.com/licenses/upl). Copyright (c) 2020, 2026 Oracle and/or its affiliates.</p>
version: 26.2.0.0
termsOfService: https://www.oracle.com/legal/terms.html
contact:
email: hospitality_apis_ww_grp@oracle.com
license:
name: UPL
url: https://opensource.org/licenses/upl
servers:
- url: /fof/v1
tags:
- name: FOFStats
description: The Front Desk Statistics module will provide statistical data related to front desk operations in a property.
paths:
/hotels/{hotelId}/frontOfficeStatistics/{statisticsCode}:
get:
summary: Get front office Statistics
description: Use this API to return front office statistics for a specific hotel based on search criteria such as statisticsCode, hotelId, date, parameterNames, parameterValues, room Classes. <p><strong>OperationId:</strong>getFrontOfficeStatistics</p>
operationId: getFrontOfficeStatistics
parameters:
- name: statisticsCode
in: path
required: true
description: Below are the Statistics Code mapping for valid metric code.<p><strong>AdvanceCheckIn:</strong></p>IndividualAdvanceCheckedInCurrent,BlockAdvanceCheckedInInhouse,BlockAdvanceCheckedInTotal,IndividualAdvanceCheckedInInhouse,IndividualAdvanceCheckedInTotal,BlockAdvanceCheckedInCurrent;<p><strong>AIRoomAssignment:</strong></p>MaxPercentageOccupiedTonightRooms,ArrivalResvs,ArrivalVIPResvs,ArrivalMemberResvs,ArrivalUnallocResvs,ArrivalManualAssgnResvs,ArrivalAIAssgnResvs,ArrivalAIUpgResvs,ArrivalAIAssgnVIPResvs,ArrivalAIAssgnMemberResvs,ArrivalAIAssgnOverridden;<p><strong>AvailableRooms:</strong></p>MinAvailableTonightRooms;<p><strong>CheckIns:</strong></p>ArrivalsTotal,CheckedInsTotal,ExpectedCheckInsTotal,QueueRooms;CheckOuts:DeparturesTotal,CheckedOutsTotal,AdultsDeparted,ChildrenDeparted,ExpectedCheckOutsTotal,AdultsExpectedCheckedOut,ChildrenExpectedCheckedOut,ScheduledCheckOutsTotal;<p><strong>ComplimentaryOrHouseUse:</strong></p>ComplimentaryArrivalRooms,ComplimentaryArrivalPersons,ComplimentaryArrivalVIP,ComplimentaryStayoverRooms,ComplimentaryStayoverPersons,ComplimentaryStayoverVIP,ComplimentaryDepartureRooms,ComplimentaryDeparturePersons,ComplimentaryDepartureVIP,HouseUseArrivalRooms,HouseUseArrivalPersons,HouseUseArrivalVIP,HouseUseStayoverRooms,HouseUseStayoverPersons,HouseUseStayoverVIP,HouseUseDepartureRooms,HouseUseDeparturePersons,HouseUseDepartureVIP;<p><strong>DailyProjection:</strong></p>IndividualRooms,IndividualPersons,IndividualVIP,GroupAndBlockRooms,GroupAndBlockPersons,GroupAndBlockVIP,MaxOccupiedTonightRooms,MaxOccupiedTonightPersons,MaxOccupiedTonightVIP,BlocksNotPickedUp,MaxPercentageOccupiedTonightRooms,MinAvailableTonightRooms,RoomRevenue,TotalRevenue,AverageRoomRevenue,RevPar;<p><strong>HouseSummary:</strong></p>TotalPhysicalRooms,TotalOutOfOrder,TotalOutOfService,TotalRoomsToSell,MaxOccupiedTonightRooms,PercentRoomsOccupied,RoomRevenue,TotalRevenue,RevPar,AverageRoomRevenue;<p><strong>HouseSummaryMonthToDate:</strong></p>TotalPhysicalRooms,TotalOutOfOrder,TotalOutOfService,TotalRoomsToSell,MaxOccupiedTonightRooms,PercentRoomsOccupied,RoomRevenue,RevPar,TotalRevenue,AverageRoomRevenue;<p><strong>HouseSummaryYearToDate:</strong></p>TotalPhysicalRooms,TotalOutOfOrder,TotalOutOfService,TotalRoomsToSell,MaxOccupiedTonightRooms,PercentRoomsOccupied,RoomRevenue,RevPar,TotalRevenue,AverageRoomRevenue;<p><strong>InHouse:</strong></p>AdultsInHouse,ChildrenInHouse,InHouseRooms,InHouse;<p><strong>LastHourStatus:</strong></p>ArrivalsInLastHour,DeparturesInLastHour,InspectedRooms,CleanedRooms;<p><strong>ReservationActivity:</strong></p>StayoverRooms,StayoverPersons,StayoverVIP,DeparturesExpectedRooms,DeparturesExpectedPersons,DeparturesExpectedVIP,DeparturesActualRooms,DeparturesActualPersons,DeparturesActualVIP,ArrivalsExpectedRooms,ArrivalsExpectedPersons,ArrivalsExpectedVIP,ArrivalsActualRooms,ArrivalsActualPersons,ArrivalsActualVIP,ArrivalsExpectedRoomsMadeToday,ArrivalsExpectedPersonsMadeToday,ArrivalsExpectedVIPMadeToday,ExtendedStaysRooms,ExtendedStaysPersons,ExtendedStaysVIP,EarlyDeparturesRooms,EarlyDeparturesPersons,EarlyDeparturesVIP,DayUseRooms,DayUsePersons,DayUseVIP,WalkInRooms,WalkInPersons,WalkInVIP,CanceledOnArrivalRooms,CanceledOnArrivalPersons,CanceledOnArrivalVIP,AverageCheckInTime;<p><strong>ReservationActivityDaily:</strong></p>AdultsInHouse,ChildrenInHouse,ArrivalsTotal,TurndownRequired,DeparturesTotal,MaxOccupancyPercentage,Stayover,TotalRoomsReserved;<p><strong>ReservationActivityMonthToDate:</strong></p>ArrivalsActualRooms,ArrivalsActualPersons,DeparturesActualRooms,DeparturesActualPersons,ExtendedStaysRooms,ExtendedStaysPersons,EarlyDeparturesRooms,EarlyDeparturesPersons,DayUseRooms,DayUsePersons;<p><strong>ReservationActivityYearToDate:</strong></p>ArrivalsActualRooms,ArrivalsActualPersons,DeparturesActualRooms,DeparturesActualPersons,ExtendedStaysRooms,ExtendedStaysPersons,EarlyDeparturesRooms,EarlyDeparturesPersons,DayUseRooms,DayUsePersons;<p><strong>ReservationsCancellationsToday:</strong></p>CancellationsTotal,NewReservationsTotal;<p><strong>ReservationStatistics:</strong></p>PreRegisteredTotal,VIPPreRegisteredTotal,TurndownTotal,VIPTurndownTotal,OpenFolioTotal,ExpectedCheckOutsTotal;<p><strong>RoomMaintenance:</strong></p>RoomMaintenanceResolvedTotal,RoomMaintenanceUnResolvedTotal;<p><strong>RoomStatus:</strong></p>InspectedVacant,InspectedAssigned,InspectedOccupied,CleanVacant,CleanAssigned,CleanOccupied,DirtyVacant,DirtyAssigned,DirtyOccupied,PickupVacant,PickupAssigned,PickupOccupied,OutOfOrderVacant,OutOfOrderAssigned,OutOfOrderOccupied,OutOfServiceVacant,OutOfServiceAssigned,OutOfServiceOccupied,TotalOutOfOrder,TotalOutOfService,QueueRooms,CurrentAveWaitTime,SkipRooms,SleepRooms;<p><strong>Turndown:</strong></p>TurndownRequired,TurndownNotRequired,TurndownCompletedRequired;<p><strong>VIPGuests:</strong></p>VIPGuestsArriving,VIPGuestsDeparting;
schema:
type: string
enum:
- AdvanceCheckIn
- AIRoomAssignment
- AvailableRooms
- CheckIns
- CheckOuts
- ComplimentaryOrHouseUse
- DailyProjection
- HouseSummary
- HouseSummaryMonthToDate
- HouseSummaryYearToDate
- InHouse
- LastHourStatus
- ReservationActivity
- ReservationActivityDaily
- ReservationActivityMonthToDate
- ReservationActivityYearToDate
- ReservationsCancellationsToday
- ReservationStatistics
- RoomMaintenance
- RoomStatus
- Turndown
- VIPGuests
- CompRouting
- RoomMoveStatistics
maxLength: 2000
minLength: 1
- name: hotelId
in: path
required: true
description: ''
schema:
type: string
maxLength: 2000
minLength: 1
- name: date
in: query
required: false
description: Start date of the report.
schema:
type: string
format: date
- name: metric
in: query
description: Supported housekeeping statistical codes.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- AdultsDeparted
- AdultsExpectedCheckedOut
- AdultsInHouse
- ArrivalAIAssgnMemberResvs
- ArrivalAIAssgnOverridden
- ArrivalAIAssgnResvs
- ArrivalAIAssgnVIPResvs
- ArrivalAIUpgResvs
- ArrivalManualAssgnResvs
- ArrivalMemberResvs
- ArrivalResvs
- ArrivalsActualPersons
- ArrivalsActualRooms
- ArrivalsActualVIP
- ArrivalsExpectedPersons
- ArrivalsExpectedPersonsMadeToday
- ArrivalsExpectedRooms
- ArrivalsExpectedRoomsMadeToday
- ArrivalsExpectedVIP
- ArrivalsExpectedVIPMadeToday
- ArrivalsInLastHour
- ArrivalsTotal
- ArrivalUnallocResvs
- ArrivalVIPResvs
- AverageCheckInTime
- AverageRoomRevenue
- BlockAdvanceCheckedInCurrent
- BlockAdvanceCheckedInInhouse
- BlockAdvanceCheckedInTotal
- BlocksNotPickedUp
- CanceledOnArrivalPersons
- CanceledOnArrivalRooms
- CanceledOnArrivalVIP
- CancellationsTotal
- CheckedInsTotal
- CheckedOutsTotal
- ChildrenDeparted
- ChildrenExpectedCheckedOut
- ChildrenInHouse
- CleanAssigned
- CleanedRooms
- CleanOccupied
- CleanVacant
- ComplimentaryArrivalPersons
- ComplimentaryArrivalRooms
- ComplimentaryArrivalVIP
- ComplimentaryDeparturePersons
- ComplimentaryDepartureRooms
- ComplimentaryDepartureVIP
- ComplimentaryStayoverPersons
- ComplimentaryStayoverRooms
- ComplimentaryStayoverVIP
- CurrentAveWaitTime
- DayUsePersons
- DayUseRooms
- DayUseVIP
- DeparturesActualPersons
- DeparturesActualRooms
- DeparturesActualVIP
- DeparturesExpectedPersons
- DeparturesExpectedRooms
- DeparturesExpectedVIP
- DeparturesInLastHour
- DeparturesTotal
- DirtyAssigned
- DirtyOccupied
- DirtyVacant
- EarlyDeparturesPersons
- EarlyDeparturesRooms
- EarlyDeparturesVIP
- ExpectedCheckInsTotal
- ExpectedCheckOutsTotal
- ExtendedStaysPersons
- ExtendedStaysRooms
- ExtendedStaysVIP
- GroupAndBlockPersons
- GroupAndBlockRooms
- GroupAndBlockVIP
- HouseUseArrivalPersons
- HouseUseArrivalRooms
- HouseUseArrivalVIP
- HouseUseDeparturePersons
- HouseUseDepartureRooms
- HouseUseDepartureVIP
- HouseUseStayoverPersons
- HouseUseStayoverRooms
- HouseUseStayoverVIP
- IndividualAdvanceCheckedInCurrent
- IndividualAdvanceCheckedInInhouse
- IndividualAdvanceCheckedInTotal
- IndividualPersons
- IndividualRooms
- IndividualVIP
- InHouse
- InHouseBlocksTotal
- InHouseRooms
- InspectedAssigned
- InspectedOccupied
- InspectedRooms
- InspectedVacant
- MaxOccupancyPercentage
- MaxOccupiedTonightPersons
- MaxOccupiedTonightRooms
- MaxOccupiedTonightVIP
- MaxPercentageOccupiedTonightRooms
- MinAvailableTonightRooms
- NewReservationsTotal
- OpenFolioTotal
- OutOfOrderAssigned
- OutOfOrderOccupied
- OutOfOrderVacant
- OutOfServiceAssigned
- OutOfServiceOccupied
- OutOfServiceVacant
- PercentRoomsOccupied
- PickupAssigned
- PickupOccupied
- PickupVacant
- PreRegisteredTotal
- QueueRooms
- RevPar
- RoomMaintenanceResolvedTotal
- RoomMaintenanceUnResolvedTotal
- RoomRevenue
- ScheduledCheckOutsTotal
- SkipRooms
- SleepRooms
- Stayover
- StayoverPersons
- StayoverRooms
- StayoverVIP
- TotalOutOfOrder
- TotalOutOfService
- TotalPhysicalRooms
- TotalRevenue
- TotalRoomsReserved
- TotalRoomsToSell
- TurndownCompletedRequired
- TurndownNotRequired
- TurndownRequired
- TurndownTotal
- VIPGuestsArriving
- VIPGuestsDeparting
- VIPGuestsTotal
- VIPPreRegisteredTotal
- VIPTurndownTotal
- WalkInPersons
- WalkInRooms
- ApprovedCompPostings
- StagedCompPostings
- DeclinedCompPostings
- CompRoutingInstructionsRequests
- WalkInVIP
- CompletedRoomMoves
- PendingRoomMoves
uniqueItems: true
- name: parameterNames
in: query
description: Required when statisticsCode is ReservationsCancellationsToday
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: parameterValues
in: query
description: Required when statisticsCode is ReservationsCancellationsToday
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: roomClasses
in: query
description: Room Class of the Room.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
maxItems: 4000
- $ref: '#/components/parameters/authKey'
- $ref: '#/components/parameters/externalData'
- $ref: '#/components/parameters/x-app-key'
- $ref: '#/components/parameters/x-request-id'
- $ref: '#/components/parameters/x-originating-application'
- $ref: '#/components/parameters/x-hotelid'
- $ref: '#/components/parameters/x-externalsystem'
- $ref: '#/components/parameters/Accept-Language'
responses:
'200':
headers:
Content-Language:
description: Audience language
x-example: en-GB
schema:
type: string
pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
description: Response element for housekeeping statistics.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/statistics'
'204':
description: FrontOfficeStatistics not found.
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'413':
$ref: '#/components/responses/413'
'414':
$ref: '#/components/responses/414'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
tags:
- FOFStats
/hotels/{hotelId}/frontOfficeStatisticsRange/{statisticsCode}:
get:
summary: Get front office Statistics
description: This API is useful to retrieve statistics regarding front office operations <p><strong>OperationId:</strong>getFrontOfficeStatisticsWithDateRange</p> <p>This API allows a time span of <strong>7</strong> days.</p>
operationId: getFrontOfficeStatisticsWithDateRange
parameters:
- name: statisticsCode
in: path
required: true
description: Below are the Statistics Code mapping for valid metric code.<p><strong>ReservationActivityDaily:</strong></p>AdultsInHouse,ChildrenInHouse,ArrivalsTotal,TurndownRequired,DeparturesTotal,MaxOccupancyPercentage,Stayover,TotalRoomsReserved,PendingRoomMoves;
schema:
type: string
enum:
- ReservationActivityDaily
maxLength: 2000
minLength: 1
- name: hotelId
in: path
required: true
description: ''
schema:
type: string
maxLength: 2000
minLength: 1
- name: endDate
in: query
required: false
description: End date of the report.
schema:
type: string
format: date
- name: date
in: query
required: false
description: Start date of the report.
schema:
type: string
format: date
- name: metric
in: query
description: Supported housekeeping statistical codes.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- AdultsDeparted
- AdultsExpectedCheckedOut
- AdultsInHouse
- ArrivalAIAssgnMemberResvs
- ArrivalAIAssgnOverridden
- ArrivalAIAssgnResvs
- ArrivalAIAssgnVIPResvs
- ArrivalAIUpgResvs
- ArrivalManualAssgnResvs
- ArrivalMemberResvs
- ArrivalResvs
- ArrivalsActualPersons
- ArrivalsActualRooms
- ArrivalsActualVIP
- ArrivalsExpectedPersons
- ArrivalsExpectedPersonsMadeToday
- ArrivalsExpectedRooms
- ArrivalsExpectedRoomsMadeToday
- ArrivalsExpectedVIP
- ArrivalsExpectedVIPMadeToday
- ArrivalsInLastHour
- ArrivalsTotal
- ArrivalUnallocResvs
- ArrivalVIPResvs
- AverageCheckInTime
- AverageRoomRevenue
- BlockAdvanceCheckedInCurrent
- BlockAdvanceCheckedInInhouse
- BlockAdvanceCheckedInTotal
- BlocksNotPickedUp
- CanceledOnArrivalPersons
- CanceledOnArrivalRooms
- CanceledOnArrivalVIP
- CancellationsTotal
- CheckedInsTotal
- CheckedOutsTotal
- ChildrenDeparted
- ChildrenExpectedCheckedOut
- ChildrenInHouse
- CleanAssigned
- CleanedRooms
- CleanOccupied
- CleanVacant
- ComplimentaryArrivalPersons
- ComplimentaryArrivalRooms
- ComplimentaryArrivalVIP
- ComplimentaryDeparturePersons
- ComplimentaryDepartureRooms
- ComplimentaryDepartureVIP
- ComplimentaryStayoverPersons
- ComplimentaryStayoverRooms
- ComplimentaryStayoverVIP
- CurrentAveWaitTime
- DayUsePersons
- DayUseRooms
- DayUseVIP
- DeparturesActualPersons
- DeparturesActualRooms
- DeparturesActualVIP
- DeparturesExpectedPersons
- DeparturesExpectedRooms
- DeparturesExpectedVIP
- DeparturesInLastHour
- DeparturesTotal
- DirtyAssigned
- DirtyOccupied
- DirtyVacant
- EarlyDeparturesPersons
- EarlyDeparturesRooms
- EarlyDeparturesVIP
- ExpectedCheckInsTotal
- ExpectedCheckOutsTotal
- ExtendedStaysPersons
- ExtendedStaysRooms
- ExtendedStaysVIP
- GroupAndBlockPersons
- GroupAndBlockRooms
- GroupAndBlockVIP
- HouseUseArrivalPersons
- HouseUseArrivalRooms
- HouseUseArrivalVIP
- HouseUseDeparturePersons
- HouseUseDepartureRooms
- HouseUseDepartureVIP
- HouseUseStayoverPersons
- HouseUseStayoverRooms
- HouseUseStayoverVIP
- IndividualAdvanceCheckedInCurrent
- IndividualAdvanceCheckedInInhouse
- IndividualAdvanceCheckedInTotal
- IndividualPersons
- IndividualRooms
- IndividualVIP
- InHouse
- InHouseBlocksTotal
- InHouseRooms
- InspectedAssigned
- InspectedOccupied
- InspectedRooms
- InspectedVacant
- MaxOccupancyPercentage
- MaxOccupiedTonightPersons
- MaxOccupiedTonightRooms
- MaxOccupiedTonightVIP
- MaxPercentageOccupiedTonightRooms
- MinAvailableTonightRooms
- NewReservationsTotal
- OpenFolioTotal
- OutOfOrderAssigned
- OutOfOrderOccupied
- OutOfOrderVacant
- OutOfServiceAssigned
- OutOfServiceOccupied
- OutOfServiceVacant
- PercentRoomsOccupied
- PickupAssigned
- PickupOccupied
- PickupVacant
- PreRegisteredTotal
- QueueRooms
- RevPar
- RoomMaintenanceResolvedTotal
- RoomMaintenanceUnResolvedTotal
- RoomRevenue
- ScheduledCheckOutsTotal
- SkipRooms
- SleepRooms
- Stayover
- StayoverPersons
- StayoverRooms
- StayoverVIP
- TotalOutOfOrder
- TotalOutOfService
- TotalPhysicalRooms
- TotalRevenue
- TotalRoomsReserved
- TotalRoomsToSell
- TurndownCompletedRequired
- TurndownNotRequired
- TurndownRequired
- TurndownTotal
- VIPGuestsArriving
- VIPGuestsDeparting
- VIPGuestsTotal
- VIPPreRegisteredTotal
- VIPTurndownTotal
- WalkInPersons
- WalkInRooms
- ApprovedCompPostings
- StagedCompPostings
- DeclinedCompPostings
- CompRoutingInstructionsRequests
- WalkInVIP
- PendingRoomMoves
- AdultsArrivals
- ChildrenArrivals
- Children1Arrivals
- Children2Arrivals
- Children3Arrivals
- Children1InHouse
- Children2InHouse
- Children3InHouse
uniqueItems: true
- name: parameterNames
in: query
description: Required when statisticsCode is ReservationsCancellationsToday
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: parameterValues
in: query
description: Required when statisticsCode is ReservationsCancellationsToday
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: roomClasses
in: query
description: Room Class of the Room.
required: false
style: form
explode: true
schema:
type: array
items:
type: string
maxItems: 4000
- $ref: '#/components/parameters/authKey'
- $ref: '#/components/parameters/externalData'
- $ref: '#/components/parameters/x-app-key'
- $ref: '#/components/parameters/x-request-id'
- $ref: '#/components/parameters/x-originating-application'
- $ref: '#/components/parameters/x-hotelid'
- $ref: '#/components/parameters/x-externalsystem'
- $ref: '#/components/parameters/Accept-Language'
responses:
'200':
headers:
Content-Language:
description: Audience language
x-example: en-GB
schema:
type: string
pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
description: Response element for housekeeping statistics.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/statistics'
'204':
description: FrontOfficeStatisticsWithDateRange not found.
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'413':
$ref: '#/components/responses/413'
'414':
$ref: '#/components/responses/414'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
tags:
- FOFStats
/hotels/{hotelId}/houseKeepingStatistics:
get:
summary: Get housekeeping statistics
description: This Api will get the housekeeping statistics for your property. <p><strong>OperationId:</strong>getTaskSheetStatistics</p>
operationId: getTaskSheetStatistics
parameters:
- name: hotelId
in: path
required: true
description: ''
schema:
type: string
maxLength: 2000
minLength: 1
- name: includeAllAssignedTasks
in: query
required: false
description: This flag, if true, enables fetching statistics for all the housekeeping tasks assigned.
schema:
type: boolean
default: true
- name: includeTaskSheetsDetails
in: query
required: false
schema:
type: boolean
default: false
- name: taskCode
in: query
required: false
description: Task code of the task sheet.
schema:
type: string
- $ref: '#/components/parameters/authKey'
- $ref: '#/components/parameters/externalData'
- $ref: '#/components/parameters/x-app-key'
- $ref: '#/components/parameters/x-request-id'
- $ref: '#/components/parameters/x-originating-application'
- $ref: '#/components/parameters/x-hotelid'
- $ref: '#/components/parameters/x-externalsystem'
- $ref: '#/components/parameters/Accept-Language'
responses:
'200':
headers:
Content-Language:
description: Audience language
x-example: en-GB
schema:
type: string
pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
description: Response element for housekeeping statistics.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/taskSheetStatistics'
'204':
description: TaskSheetStatistics not found.
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'413':
$ref: '#/components/responses/413'
'414':
$ref: '#/components/responses/414'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
tags:
- FOFStats
/hotels/{hotelId}/queueReservationsStatistics:
get:
summary: Get reservation queue statistics
description: Use this API to return reservation queue statistics for a specific hotel. <p><strong>OperationId:</strong>getReservationQueueStatistics</p>
operationId: getReservationQueueStatistics
parameters:
- name: hotelId
in: path
required: true
description: ''
schema:
type: string
maxLength: 2000
minLength: 1
- $ref: '#/components/parameters/authKey'
- $ref: '#/components/parameters/externalData'
- $ref: '#/components/parameters/x-app-key'
- $ref: '#/components/parameters/x-request-id'
- $ref: '#/components/parameters/x-originating-application'
- $ref: '#/components/parameters/x-hotelid'
- $ref: '#/components/parameters/x-externalsystem'
- $ref: '#/components/parameters/Accept-Language'
responses:
'200':
headers:
Content-Language:
description: Audience language
x-example: en-GB
schema:
type: string
pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
description: Response for the fetch of current Reservations In Queue statistics. Contains the statistic information.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/reservationQueueStatistics'
'204':
description: ReservationQueueStatistics not found.
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'406':
$ref: '#/components/responses/406'
'413':
$ref: '#/components/responses/413'
'414':
$ref: '#/components/responses/414'
'415':
$ref: '#/components/responses/415'
'500':
$ref: '#/components/responses/500'
'502':
$ref: '#/components/responses/502'
'503':
$ref: '#/components/responses/503'
tags:
- FOFStats
/hotels/{hotelId}/reservationStatusStatistics:
get:
summary: Get Reservation Status Statistics
description: This API will fetch reservation statistics for the given status per room type. <p><strong>OperationId:</strong>getReservationStatusStatistics</p>
operationId: getReservationStatusStatistics
parameters:
- name: hotelId
in: path
required: true
description: Hotel Code
schema:
type: string
- name: reservationStatus
in: query
required: true
description: Reservation statuses to fetch statistics for
style: form
explode: true
schema:
type: array
items:
type: string
enum:
- DueIn
- DueOut
- CheckedIn
- CheckedOut
- $ref: '#/components/parameters/authKey'
- $ref: '#/components/parameters/externalData'
- $ref: '#/components/parameters/x-app-key'
- $ref: '#/components/parameters/x-request-id'
- $ref: '#/components/parameters/x-originating-application'
- $ref: '#/components/parameters/x-hotelid'
- $ref: '#/components/parameters/x-externalsystem'
- $ref: '#/components/parameters/Accept-Language'
responses:
'200':
headers:
Content-Language:
description: Audience language
x-example: en-GB
schema:
type: string
pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
description: Response of get Reservation Status Statistics.
content:
application/json;charset=UTF-8:
schema:
$ref: '#/components/schemas/reservationStatusStatisticsResponseType'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/res
# --- truncated at 32 KB (185 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-hospitality/refs/heads/main/openapi/oracle-hospitality-fofstats-api-openapi.yml