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.
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.OperationId:getFrontOfficeStatistics
operationId: getFrontOfficeStatistics parameters: - name: statisticsCode in: path required: true description: Below are the Statistics Code mapping for valid metric code.AdvanceCheckIn:
IndividualAdvanceCheckedInCurrent,BlockAdvanceCheckedInInhouse,BlockAdvanceCheckedInTotal,IndividualAdvanceCheckedInInhouse,IndividualAdvanceCheckedInTotal,BlockAdvanceCheckedInCurrent;AIRoomAssignment:
MaxPercentageOccupiedTonightRooms,ArrivalResvs,ArrivalVIPResvs,ArrivalMemberResvs,ArrivalUnallocResvs,ArrivalManualAssgnResvs,ArrivalAIAssgnResvs,ArrivalAIUpgResvs,ArrivalAIAssgnVIPResvs,ArrivalAIAssgnMemberResvs,ArrivalAIAssgnOverridden;AvailableRooms:
MinAvailableTonightRooms;CheckIns:
ArrivalsTotal,CheckedInsTotal,ExpectedCheckInsTotal,QueueRooms;CheckOuts:DeparturesTotal,CheckedOutsTotal,AdultsDeparted,ChildrenDeparted,ExpectedCheckOutsTotal,AdultsExpectedCheckedOut,ChildrenExpectedCheckedOut,ScheduledCheckOutsTotal;ComplimentaryOrHouseUse:
ComplimentaryArrivalRooms,ComplimentaryArrivalPersons,ComplimentaryArrivalVIP,ComplimentaryStayoverRooms,ComplimentaryStayoverPersons,ComplimentaryStayoverVIP,ComplimentaryDepartureRooms,ComplimentaryDeparturePersons,ComplimentaryDepartureVIP,HouseUseArrivalRooms,HouseUseArrivalPersons,HouseUseArrivalVIP,HouseUseStayoverRooms,HouseUseStayoverPersons,HouseUseStayoverVIP,HouseUseDepartureRooms,HouseUseDeparturePersons,HouseUseDepartureVIP;DailyProjection:
IndividualRooms,IndividualPersons,IndividualVIP,GroupAndBlockRooms,GroupAndBlockPersons,GroupAndBlockVIP,MaxOccupiedTonightRooms,MaxOccupiedTonightPersons,MaxOccupiedTonightVIP,BlocksNotPickedUp,MaxPercentageOccupiedTonightRooms,MinAvailableTonightRooms,RoomRevenue,TotalRevenue,AverageRoomRevenue,RevPar;HouseSummary:
TotalPhysicalRooms,TotalOutOfOrder,TotalOutOfService,TotalRoomsToSell,MaxOccupiedTonightRooms,PercentRoomsOccupied,RoomRevenue,TotalRevenue,RevPar,AverageRoomRevenue;HouseSummaryMonthToDate:
TotalPhysicalRooms,TotalOutOfOrder,TotalOutOfService,TotalRoomsToSell,MaxOccupiedTonightRooms,PercentRoomsOccupied,RoomRevenue,RevPar,TotalRevenue,AverageRoomRevenue;HouseSummaryYearToDate:
TotalPhysicalRooms,TotalOutOfOrder,TotalOutOfService,TotalRoomsToSell,MaxOccupiedTonightRooms,PercentRoomsOccupied,RoomRevenue,RevPar,TotalRevenue,AverageRoomRevenue;InHouse:
AdultsInHouse,ChildrenInHouse,InHouseRooms,InHouse;LastHourStatus:
ArrivalsInLastHour,DeparturesInLastHour,InspectedRooms,CleanedRooms;ReservationActivity:
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;ReservationActivityDaily:
AdultsInHouse,ChildrenInHouse,ArrivalsTotal,TurndownRequired,DeparturesTotal,MaxOccupancyPercentage,Stayover,TotalRoomsReserved;ReservationActivityMonthToDate:
ArrivalsActualRooms,ArrivalsActualPersons,DeparturesActualRooms,DeparturesActualPersons,ExtendedStaysRooms,ExtendedStaysPersons,EarlyDeparturesRooms,EarlyDeparturesPersons,DayUseRooms,DayUsePersons;ReservationActivityYearToDate:
ArrivalsActualRooms,ArrivalsActualPersons,DeparturesActualRooms,DeparturesActualPersons,ExtendedStaysRooms,ExtendedStaysPersons,EarlyDeparturesRooms,EarlyDeparturesPersons,DayUseRooms,DayUsePersons;ReservationsCancellationsToday:
CancellationsTotal,NewReservationsTotal;ReservationStatistics:
PreRegisteredTotal,VIPPreRegisteredTotal,TurndownTotal,VIPTurndownTotal,OpenFolioTotal,ExpectedCheckOutsTotal;RoomMaintenance:
RoomMaintenanceResolvedTotal,RoomMaintenanceUnResolvedTotal;RoomStatus:
InspectedVacant,InspectedAssigned,InspectedOccupied,CleanVacant,CleanAssigned,CleanOccupied,DirtyVacant,DirtyAssigned,DirtyOccupied,PickupVacant,PickupAssigned,PickupOccupied,OutOfOrderVacant,OutOfOrderAssigned,OutOfOrderOccupied,OutOfServiceVacant,OutOfServiceAssigned,OutOfServiceOccupied,TotalOutOfOrder,TotalOutOfService,QueueRooms,CurrentAveWaitTime,SkipRooms,SleepRooms;Turndown:
TurndownRequired,TurndownNotRequired,TurndownCompletedRequired;VIPGuests:
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 operationsOperationId:getFrontOfficeStatisticsWithDateRange
This API allows a time span of 7 days.
operationId: getFrontOfficeStatisticsWithDateRange parameters: - name: statisticsCode in: path required: true description: Below are the Statistics Code mapping for valid metric code.ReservationActivityDaily:
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.OperationId:getTaskSheetStatistics
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.OperationId:getReservationQueueStatistics
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.OperationId:getReservationStatusStatistics
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/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}/roomStatusStatistics: get: summary: Get counts of rooms by housekeeping status and front office status. description: For current business date, rooms are grouped by the roomClass and roomType to display their housekeeping roomStatus. operationId: getRoomsByRoomStatus parameters: - name: hotelId in: path required: true description: '' schema: type: string maxLength: 2000 minLength: 1 - name: frontOfficeStatus in: query required: false description: Filter by frontOfficeStatus. If nothing is passed, we fetch all. schema: type: string enum: - Vacant - Occupied 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/roomStatusStatisticsListType' '204': description: RoomStatusStatistics 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 /services/fofStats/status: get: summary: Ping FOF description: Ping FOF stats serviceOperationId:pingFOFStatsService
operationId: pingFOFStatsService parameters: - $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 Ping operation. content: application/json;charset=UTF-8: schema: $ref: '#/components/schemas/operaVersion' '204': description: pingFOFStatsService 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 components: schemas: reservationQueueInformationType: type: object description: Information regarding the Date, Duration and Priority of the reservation on Queue for Check in. properties: timeSpan: description: 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 add to the StartDate to yield end date. type: object properties: startDate: type: string format: date maxLength: 8 endDate: type: string format: date maxLength: 8 duration: type: string durationInSeconds: description: The total duration, in seconds, the reservation is on Queue. type: integer guestTextInfo: description: Information for the message sent to the user $ref: '#/components/schemas/queueTextInfoType' priority: description: The Queue Priority given to this reservation. type: integer averageQueueTimeToCheckIn: description: The average time, in seconds, a reservation was on queue prior to Check-In. type: integer averageQueueTimeCurrentReservations: description: The average time, in seconds, of the reservations currently in queue. type: integer queueDate: description: The Business date on which the reservation was due to arrive and is currently placed on Queue for Check In. type: string format: date maxLength: 8 guestHousekeepingServiceRequestType: type: string description: Possible values for the Guest Service Status. enum: - DoNotDisturb - MakeUpRoom - NoStatusSelected - ServiceDeclined resAccompanyGuestInfoType: type: object properties: firstName: description: Given name, first name or names type: string lastName: description: Family name, last name. type: string fullName: description: String representation of the full name type: string registrationCardNo: description: Unique identifier of the police registration card number. type: string minLength: 0 maxLength: 40 profileIdList: description: Unique identifiers for the Profile for both internal and external systems. In case of Travel Agent the IATA code and in case of Company can be any form of identifier as id. $ref: '#/components/schemas/profileIdList' stayInfoType: type: object description: Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaining to this particular Room Stay and finally financial information related to the Room Stay, including Guarantee, Deposit and Payment and Cancellation Penalties. properties: arrivalDate: type: string format: date departureDate: type: string format: date originalTimeSpan: description: The Original Time Span covers the Room Stay dates of the original reservation. $ref: '#/components/schemas/timeSpanType' expectedTimes: description: The expected arrival, return and departure times of the guest. $ref: '#/components/schemas/resExpectedTimesType' adultCount: description: A collection of Guest Counts associated with Room Stay. type: integer childCount: description: A collection of Child Counts associated with Room Stay. type: integer roomClass: description: Room class code type: string minLength: 0 maxLength: 20 roomType: description: Room type code type: string minLength: 0 maxLength: 20 componentRoomType: description: True indicates room type is a component type. type: boolean numberOfRooms: description: Room Id type: integer roomId: description: Room Id type: string minLength: 0 maxLength: 20 ratePlanCode: description: Rate plan code type: string minLength: 0 maxLength: 20 rateAmount: description: Rate amount $ref: '#/components/schemas/currencyAmountType' points: description: The Points contains the number of points used to book a particular room type. $ref: '#/components/schemas/pointsType' rateSuppressed: description: Whether this rate should be suppressed from view type: boolean reservationBlock: description: Key information about the block for this reservation. $ref: '#/components/schemas/reservationBlockType' bookingChannelCode: description: Booking channel code type: string minLength: 0 maxLength: 20 linkCode: description: Party code type: string maxLength: 2000 fixedRate: description: True if the rate is a fixed rate, otherwise false type: boolean totalAmount: description: The total amount charged for the Room Stay including additional occupant amounts and fees. If TaxInclusive is set to True, then taxes are included in the total amount. $ref: '#/components/schemas/currencyAmountType' guarantee: description: The guarantee information associated to the Room Stay. A maximum of 5 occurances are available for use depending on the context. $ref: '#/components/schemas/resGuaranteeType' promotion: description: Promotion Codes $ref: '#/components/schemas/promotionType' marketCode: description: Market code type: string minLength: 0 maxLength: 20 marketDescription: description: Description of Market code type: string minLength: 0 maxLength: 4000 sourceCode: description: Source of business type: string minLength: 0 maxLength: 20 sourceCodeDescription: description: Description of the source of business. type: string minLength: 0 maxLength: 4000 balance: description: Balance amount $ref: '#/components/schemas/currencyAmountType' compBalance: description: Comp Balance amount $ref: '#/components/schemas/currencyAmountType' roomTypeCharged: description: Room type code that was charged type: string minLength: 0 maxLength: 20 depositPayments: description: A collection of deposit and/or payments for the Room Stay. $ref: '#/components/schemas/currencyAmountType' guestServiceStatus: description: Service Status of In House guest like DND or MUP $ref: '#/components/schemas/guestHousekeepingServiceRequestType' scheduledCheckoutTime: description: Indicates that this reservation is scheduled for automated check out. type: string format: date roomNumberLocked: description: When true, indicates a room number cannot be changed. When false, indicates a room number may be changed. type: boolean pseudoRoom: description: True indicates as pseudo room type. This is usually used for a posting master reservation. type: boolean assignedByAI: description: Represents the room was assigned by AI Room Assignment. type: boolean upgradedByAI: description: Represents the room was assigned by AI Room Assignment. type: boolean childAges: description: Defines Children's Ages. Number of children ages mentioned may mot match with children counts. $ref: '#/components/schemas/childAgesType' resSharedGuestInfoType: type: object description: Contains information regarding the share reservation. properties: profileId: $ref: '#/components/schemas/profileId' firstName: description: Given name, first name or names type: string lastName: description: Family name, last name. type: string fullName: description: String representation of the full name type: string cardTypeType: type: string description: This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method. enum: - Ab - Am - Ax - Cb - Dc - Ds - Dt - Ec - Er - Jc - Jl - Mc - Nb - So - St - Sw - Va - Xy - Zz - Cp - Cu reservationFolioWindowsType: type: array description: Collection of reservation folio windows. maxItems: 4000 items: $ref: '#/components/schemas/reservationFolioWindowType' namePrefixType: type: string description: Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.) minLength: 0 maxLength: 40 reservationInfoType: type: object description: The Reservation class contains the current reservation being created or altered. properties: reservationIdList: description: Unique identifiers for the reservation for both internal and external systems $ref: '#/components/schemas/reservationIdList' externalReferences: description: External Reference information for Reservation. $ref: '#/components/schemas/externalReferencesType' roomStay: description: Collection of room stays. $ref: '#/components/schemas/stayInfoType' reservationGuest: description: Collection of guests associated with the reservation. $ref: '#/components/schemas/resGuestInfoType' sharedGuests: description: Collection of guests who share this reservation. $ref: '#/components/schemas/resSharedGuestListType' attachedProfiles: description: List of attached profiles $ref: '#/components/schemas/resAttachedProfileListType' reservationPaymentMethod: description: Payment method used for this reservation $ref: '#/components/schemas/reservationPaymentMethodType' reservationFolioWindows: description: Collection of reservation folio windows. $ref: '#/components/schemas/reservationFolioWindowsType' specials: description: Set of reservation preferences which belongs to the Specials group. type: string minLength: 0 maxLength: 4000 lastPrivacyPromptDate: description: Last Privacy Prompt Date type: string format: date maxLength: 8 displayColor: description: Color setting of the reservation. type: string minLength: 0 maxLength: 20 reservationIndicators: description: Indicators of additional information attached to the reservation $ref: '#/components/schemas/indicatorsType' roomStatus: description: Current room status $ref: '#/components/schemas/housekeepingRoomStatusType' searchMatches: description: Super Search matching terms. $ref: '#/components/schemas/searchMatchesType' sourceOfSale: description: Point of Sale of reservation. Identifies the entity/channel who made the reservation. $ref: '#/components/schemas/sourceOfSaleType' waitlist: description: Information regarding why reservation has been/was waitlisted. This could hold information as history even if reservation is not in Waitlist status anymore. $ref: '#/components/schemas/waitlistResType' queue: description: Information about the time and duration this reservation was on Queue for Checkin. $ref: '#/components/schemas/reservationQueueInformationType' housekeeping: description: Information regarding housekeeping for this reservation. $ref: '#/components/schemas/resHousekeepingType' cashiering: description: Holds cashiering related information for the reservation. $ref: '#/components/schemas/resCashieringType' taxType: description: This stores the code for the type of tax calculation especially with tax exemption, etc. $ref: '#/components/schemas/taxTypeType' deposit: description: Holds reservation deposit information. $ref: '#/components/schemas/reservationDepositType' allowedActions: description: Collection of reservation allowed actions. $ref: '#/components/schemas/reservationAllowedActionsType' revenuesAndBalances: description: Revenues and Balances Amount summary for the reservation. $ref: '#/components/schemas/resRevenueBalanceType' hotelInterfaceStatusList: description: Collection of Hotel Interfaces and rights, this is populated only when fetching interface status for rooms. type: array maxItems: 4000 items: $ref: '#/components/schemas/reservationInterfaceStatusType' guestPreferredCurrency: description: Currency code preferred by guest. type: string minLength: 0 maxLength: 20 turndownInfo: description: Currency code preferred by guest. $ref: '#/components/schemas/reservationTurndownInfoType' mobileNotifications: description: Denotes the status of Room Ready, Key Ready messages. $ref: '#/components/schemas/resMobileNotificationsType' reservationCommunication: description: Collection of reservation communication details. $ref: '#/components/schemas/resCommunicationType' advanceCheckIn: description: Information relating to Reservation's Advance Checked In state and Expected Time of Return $ref: '#/components/schemas/advanceCheckInType' welcomeOffer: description: This flag will determine wheather the reservation is eligible for Welcome Offer or not. type: boolean cancellationInfo: description: Information regarding why reservation has been/was cancelled. type: object properties: description: type: string minLength: 0 maxLength: 2000 code: type: string minLength: 0 maxLength: 20 date: description: Date when reservation was last cancelled. type: string format: date maxLength: 8 keyCount: description: Number of keys created for the reservation. type: integer hotelId: type: string minLength: 0 maxLength: 20 hotelName: type: string minLength: 0 maxLength: 80 expectedServiceTime: type: string minLength: 0 maxLength: 20 roomStayReservation: description: Boolean True if this reservation is reserving rooms. False if it is only reserving services. type: boolean createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 reservationStatus: description: Indicates the status of the reservation. $ref: '#/components/schemas/pMS_ResStatusType' computedReservationStatus: description: Indicates the status of the reservation. $ref: '#/components/schemas/pMS_ResStatusType' walkInIndicator: description: When true, indicates the reservation is for a guest that walks-in without a reservation. When false, the reservation is not a walk-in. type: boolean accessRestriction: description: Indicates user restriction on the reservation based on the Access exclusion functionality such as Restriction on Changes, Cancellation or both. $ref: '#/components/schemas/resAccessRestrictionType' commissionPayoutTo: description: If not null, reservation is considered to pay out commission to either Travel Agent, Source or both. $ref: '#/components/schemas/commissionPayoutToType' paymentMethod: description: Payment Method. type: string minLength: 0 maxLength: 20 preRegistered: description: Defines if the reservation is pre-registered or not. type: boolean openFolio: description: Returns true when reservation has an open folio. type: boolean allowMobileCheckout: description: Flag containing true or false value for reservation to be eligible for self-checkout by guest using mobile device . Pass the 'true' or 'false' values when creating / modifying reservation to indicate whether a reservation is eligible for mobile checkout yes / no. Upon fetch, the current state of the flag will show true or false. type: boolean allowMobileViewFolio: description: Attribute AllowMobileViewFolio is set to true when the reservation is eligible for viewing folio using mobile device. type: boolean optedForCommunication: description: Attribute OptedForCommunication is set to true when the guest has opted for receiving communicationsl related to the reservation. type: boolean backToBack: description: Back to Back functionality is available when the Back to Back Handling of Linked Reservations OPERA Control is active. type: boolean personNameType: type: object description: This provides name information for a person. properties: namePrefix: description: Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.) type: string minLength: 0 maxLength: 40 givenName: description: Given name, first name or names. type: string minLength: 0 maxLength: 40 middleName: description: The middle name of the person name. type: string minLength: 0 maxLength: 40 surname: description: Family name, last name. May also be used for full name if the sending system does not have the ability to separate a full name into its parts, e.g. the surname element may be used to pass the full name. type: string minLength: 0 maxLength: 40 nameSuffix: description: Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.) type: string minLength: 0 maxLength: 40 nameTitle: description: Degree or honors (e.g., Ph.D., M.D.) type: string minLength: 0 maxLength: 80 nameTitleSuffix: description: Title Suffix. Must be populated if ADVANCED_TITLE is on. type: integer envelopeGreeting: description: Envelope Greeting of the profile type: string salutation: description: Salutation of the profile type: string nameType: description: Type of name of the individual, such as former, nickname, alternate or alias name. $ref: '#/components/schemas/personNameTypeType' language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' externalSystem: description: When name type is external, indicates the external system the name belongs to. type: string minLength: 0 maxLength: 40 statistics: type: object description: Response element for frontOffice statistics. properties: statisticsCode: description: . $ref: '#/components/schemas/hSKStatReportCodeType' calendarDate: description: Statistical date of the requested report. type: string format: date metricSet: type: array description: Base statistic set holder which defines the span of the statistical data. items: type: object description: . properties: metrics: type: array maxItems: 4000 items: $ref: '#/components/schemas/hSKStatType' code: type: string maxLength: 2000 start: type: string format: date end: type: string format: date links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' roomConditionAssigmentType: type: string description: Simple type for Room Condition assignment type. Valid values are Available and NotAvailable Only. enum: - Available - NotAvailable pointsType: type: object description: The Redeem Points contains the number of points required to book a room type. properties: awardsType: description: Awards type for the award type rate code. type: string points: description: No of points required to book this Room Stay. type: integer resAccessRestrictionType: type: string description: Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed. enum: - Change - Cancel - ChangeOrCancel reservationIdList: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' communicationStatusType: type: string description: Enum to denote the Status of Readiness messages sent to Guest Devices. enum: - Pending - Completed - Failed - Sent - Received - Cancelled - PendingAvailability resCashieringType: type: object description: Cashiering Information for the reservation. properties: revenuesAndBalances: description: Revenues and Balances Amount summary for the reservation. $ref: '#/components/schemas/resRevenueBalanceType' billingPrivileges: description: Billing privileges set on the reservation. $ref: '#/components/schemas/billingPrivilegesType' taxType: description: This stores the code for the type of tax calculation especially with tax exemption, etc. $ref: '#/components/schemas/reservationTaxTypeInfo' bedTaxReporting: description: This stores the information for Bed Tax Reporting. Mainly used in Maldives. $ref: '#/components/schemas/bedTaxReportingType' folioTexts: description: Additional text fields to display on the folio. $ref: '#/components/schemas/folioTextsType' periodicFolio: description: Information regarding periodic folios set on the reservation. $ref: '#/components/schemas/resPeriodicFolioType' compAccounting: description: Information regarding comp accounting on the reservation. $ref: '#/components/schemas/resCompAccountingType' reservationPreConfiguredRoutingInstruction: description: Information regarding the selected preconfigured routing instruction on the reservation. $ref: '#/components/schemas/resPreConfiguredRoutingInstrType' financiallyResponsible: description: The guest from whom payment has to be recovered (direct guest). type: boolean proratedBilling: description: In case of Appartment style billing indicates whether a prorated amount should be used for an Apartment Style Billing rate. type: boolean lastRoomAndTaxPostedDate: description: Date of the last Room And Tax posting. Used primarily to know the date in case of Advance Billing. type: string format: date maxLength: 8 reverseCheckInAllowed: description: This attribute is to verify if reverse check-in is allowed for the reservation. type: boolean reverseAdvanceCheckInAllowed: description: This attribute is to verify if reverse advance check-in is allowed for the reservation. type: boolean transactionsPosted: description: Specifies whether reservation has a financial transaction associated with it. type: boolean roomStatusStatisticsCountType: type: object properties: housekeepingRoomStatus: type: string housekeepingRoomStatusCount: type: integer resPaymentCardType: type: object description: Information on a credit card for the customer. properties: cardId: description: credit card id $ref: '#/components/schemas/uniqueID_Type' currentAuthorizedAmount: $ref: '#/components/schemas/currencyAmountType' approvalAmountNeeded: $ref: '#/components/schemas/currencyAmountType' approvalCode: description: Approval code sent by the credit card company on a successful authorization. type: string minLength: 0 maxLength: 20 cardType: description: Indicates the type of credit card from a defined list $ref: '#/components/schemas/cardTypeType' userDefinedCardType: description: Indicates the user defined credit card type if credit card type from a defined list is not provided type: string minLength: 0 maxLength: 2 cardNumber: type: string minLength: 0 maxLength: 80 cardNumberMasked: type: string minLength: 0 maxLength: 80 cardNumberLast4Digits: type: string minLength: 0 maxLength: 80 expirationDate: description: Expiration date of the credit card type: string format: date maxLength: 8 expirationDateMasked: description: Masked Expiration date of the credit card type: string minLength: 0 maxLength: 20 expirationDateExpired: type: boolean cardHolderName: type: string minLength: 0 maxLength: 200 attachCreditCardToProfile: description: Attach the credit card to profile. type: boolean processing: description: This contains information on whether EFT is enabled. A value of 'C' indicates EFT is enabled and 'M' indicates manual authorization is available for this payment card type. $ref: '#/components/schemas/cardProcessingType' swiped: type: boolean cardPresent: description: Flag to determine if the credit card was swiped/manually entered , This element is only used when PAYMENT SERVICE DIRECTIVE(PSD) Opera Control is active. type: boolean cardOrToken: description: This contains information on whether credit card is tokenized (token enabled). A value of 'Token' indicates credit card is token enabled and 'CardNumber' indicates non token environment for this payment card type. $ref: '#/components/schemas/cardNumberTypeType' citId: description: Customer Initiated Transaction(CIT) Id for Credit Cards. This is only used when PAYMENT SERVICES DIRECTIVE (PSD2) Opera Control is active. type: string minLength: 0 maxLength: 30 reservationDepositType: type: object description: Reservation Deposit Type. properties: amountRequired: description: Deposit Amount Required. type: number amountPaid: description: Deposit Amount Paid. type: number amountOwed: description: Deposit Amount Owed. type: number dueDate: description: Deposit Due Date. type: string format: date maxLength: 8 postingDate: description: Deposit Posting Date. type: string format: date maxLength: 8 hasPaid: description: Resolves whether reservation has paid deposit. type: boolean hasOutstanding: description: Resolves whether reservation has outstanding deposit. type: boolean resHousekeepingType: type: object description: Holds housekeeping turndown service information for the room. properties: instructions: description: Turndown instructions for the room. type: string facilityTaskInfo: description: The facility task applicable for the current day. This will be information only and not used for any updates. $ref: '#/components/schemas/facilityTaskType' linenChange: description: Indicates if a linen change is necessary. type: boolean turndownRequested: description: Indicates whether guest wants turndown facility or not. type: boolean serviceTime: description: This is the Turndown room service time. type: string format: date maxLength: 8 expectedServiceTime: description: Expected Start Time for housekeeping task(s). type: string roomStatus: description: Current room status. Current room status is populated only if room is assigned to the reservation and reservation is due in or in house. $ref: '#/components/schemas/housekeepingRoomStatusType' reservationPaymentMethodType: type: object properties: paymentCard: $ref: '#/components/schemas/resPaymentCardType' balance: $ref: '#/components/schemas/currencyAmountType' authorizationRule: $ref: '#/components/schemas/authorizationRuleType' emailFolioInfo: description: Information on an email for the customer. type: object properties: email: description: eMail deatils for the profile. $ref: '#/components/schemas/emailType' emailFolio: type: boolean id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 paymentMethod: type: string minLength: 0 maxLength: 20 description: type: string minLength: 0 maxLength: 2000 folioView: type: integer confidential: type: boolean description: Flag indicating a billing window (2-8) as confidential. Applied only when Confidential Billing Window Opera Control is active. queueTextInfoType: type: object description: Information regarding the message sent to guest. properties: sentTime: description: Time the text was last sent to the user. type: string format: date-time sentBy: description: User name of the user who sent message. type: string minLength: 0 maxLength: 40 indicatorsType: type: array description: Collection of lamp indicators. maxItems: 4000 items: $ref: '#/components/schemas/indicatorType' timeSpanType: type: object description: 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 add to the StartDate to yield end date. properties: startDate: type: string format: date maxLength: 8 endDate: type: string format: date maxLength: 8 duration: type: string indicatorType: type: object description: Lamp indicator Type. properties: indicatorName: description: Name of the indicator. type: string minLength: 0 maxLength: 80 count: description: Indicates number of occurrences of the indicator. type: integer roomsOutOfOrderType: type: array description: Date Range and reasons for a room being Out of Order/Out Of Service (If the room is OO/OS). maxItems: 4000 items: $ref: '#/components/schemas/roomOutOfOrderType' addressInfoType: type: object description: Provides address information. properties: address: description: Address details for the profile. $ref: '#/components/schemas/addressType' id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 frontOfficeRoomStatusType: type: string description: Simple type for front office room status instructions to be used in requests for fetching housekeeping rooms. Valid values are Vacant and Occupied. enum: - Vacant - Occupied warningsType: type: array description: Used in conjunction with the Success element to define a business error. maxItems: 4000 items: $ref: '#/components/schemas/warningType' addtionalCodeInfoType: type: array description: Holds name of additional code information maxItems: 4000 items: type: object properties: name: description: Holds name of additional code information $ref: '#/components/schemas/masterInfoCodeDetailType' value: description: Holds value of additional code information type: string minLength: 0 maxLength: 2000 folioTextsType: type: array description: This stores the description for the type of tax calculation especially with tax exemption, etc. maxItems: 2 items: type: object properties: text: description: Additional text field to display on the folio. type: string minLength: 0 maxLength: 50 row: description: Row number of the additional text. type: integer aRAccountShortInfoType: type: object description: Accounts Receivabales Account details type charged for batched posting. properties: accountName: description: Name of the AR Account. type: string minLength: 0 maxLength: 200 accountId: description: The unique ID for the Account. $ref: '#/components/schemas/uniqueID_Type' accountNo: description: The Account Number for the Account. type: string minLength: 0 maxLength: 20 status: description: The status of the account. $ref: '#/components/schemas/aRAccountStatusType' cardNumberTypeType: type: string description: Simple type for indicating if credit card number is tokenized. enum: - CardNumber - Token reservationQueueRoomTypeStatisticsType: type: object description: 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 in Queue. Statistics will also include the current number of rooms for each room status for the resort at the current time i.e the number of dirty rooms, clean rooms for each room type. In addition, the statistics will include the number of rooms per room type which are Vacant / Occupied. properties: roomType: description: The room type for the statistics. type: string minLength: 0 maxLength: 20 fOStatus: description: The number of rooms for the room type grouped by their FO status i.e Vacant or Occupied. type: array maxItems: 4000 items: type: object properties: roomStatus: description: The total number of rooms for the room type grouped by their Room Status i.e Clean, Dirty etc.. type: array maxItems: 4000 items: type: object properties: housekeepingRoomStatus: description: The room status code example Clean, Dirty etc. $ref: '#/components/schemas/housekeepingRoomStatusType' totalRooms: description: The total number of rooms for the room status. type: integer frontOfficeStatus: description: The FO status code i.e Vacant, Occupied. $ref: '#/components/schemas/frontOfficeRoomStatusType' totalRooms: description: The total number of rooms for the Front Office status. type: integer totalInQueue: description: The total number of reservations in Queue for this room type. type: integer uniqueID_Type: type: object description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). properties: id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 telephoneType: type: object description: Information on a telephone number for the customer. properties: phoneTechType: description: Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. type: string minLength: 0 maxLength: 20 phoneUseType: description: Describes the type of telephone number, in the context of its general use (e.g. Home, Business, Emergency Contact, Travel Arranger, Day, Evening). type: string minLength: 0 maxLength: 20 phoneUseTypeDescription: description: Description of the PhoneUseType code type: string minLength: 0 maxLength: 2000 phoneNumber: description: Telephone number assigned to a single location. type: string minLength: 0 maxLength: 40 extension: description: Extension to reach a specific party at the phone number. type: string minLength: 0 maxLength: 20 primaryInd: description: When true, indicates a primary information. type: boolean orderSequence: description: Display Order sequence. type: number createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 reservationShortInfoType: type: object properties: guestName: description: Guest name that is registered for the reservation. type: string minLength: 0 maxLength: 80 reservationId: $ref: '#/components/schemas/reservationId' reservationStatusInfo: $ref: '#/components/schemas/housekeepingRoomReservationStatusType' stayDateInfo: $ref: '#/components/schemas/stayDateInfoType' vipStatus: description: VIP status of the guest. $ref: '#/components/schemas/vIPStatusType' profileId: description: ProfileId of the guest. $ref: '#/components/schemas/uniqueID_Type' scheduledRoomMoveOut: description: This flag will be set to true for rooms assigned to reservations that are scheduled to move to another room. type: boolean scheduledRoomMoveOutTime: description: This time indicates when the reservation is scheduled to move out of the room. Uses the hotel's time zone. type: string format: date-time vIPStatusType: type: object description: VIP status of the customer. properties: value: type: string description: Used for Character Strings, length 0 to 2000. minLength: 0 maxLength: 2000 code: description: VIP status of the customer. type: string minLength: 0 maxLength: 20 currencyAmountType: type: object description: A monetary value expressed with a currency code. properties: amount: description: A monetary amount. type: number currencyCode: description: Provides a currency code to reflect the currency in which an amount may be expressed. type: string minLength: 3 maxLength: 3 telephoneInfoType: type: object description: Information on a telephone number for the customer. properties: telephone: description: Phone details for the profile. $ref: '#/components/schemas/telephoneType' id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 reservationTurndownInfoType: type: object description: Turndown information for a reservation properties: allowed: description: Indicates if turndown is allowed or not type: boolean status: description: Indicates turndown status, values could be required, not required, completed $ref: '#/components/schemas/turndownStatusType' roomStatusStatisticsType: type: object properties: roomClass: type: string roomType: type: string frontOfficeStatus: type: string roomStats: type: array items: $ref: '#/components/schemas/roomStatusStatisticsCountType' housekeepingRoomStatusType: type: string description: Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService. enum: - Clean - Dirty - Pickup - Inspected - OutOfOrder - OutOfService resProfileTypeType: type: string enum: - Guest - Company - Group - TravelAgent - Source - ReservationContact - BillingContact - Addressee waitlistResType: type: object description: Information regarding why reservation is being /has been waitlisted. properties: reasonDescription: description: Waitlist Reason Description. type: string minLength: 0 maxLength: 2000 priorityDescription: description: Waitlist priority Description. type: string minLength: 0 maxLength: 2000 description: description: Description why the reservation is being /has been waitlisted. type: string minLength: 0 maxLength: 2000 reasonCode: description: Waitlist Reason Code. type: string minLength: 0 maxLength: 20 priorityCode: description: Waitlist Priority Code. type: string minLength: 0 maxLength: 20 telephone: description: Guest telephone number. type: string minLength: 0 maxLength: 40 reservationStatusEnumType: type: string description: Reservation Status Enum Type enum: - DueIn - DueOut - CheckedIn - CheckedOut codeListType: type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 instanceLink: type: object description: Metadata describing link description objects that MAY appear in the JSON instance representation. properties: href: description: URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true. type: string rel: description: Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile. type: string templated: description: Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false. type: boolean default: false method: description: HTTP method for requesting the target of the link. type: string enum: - GET - POST - PUT - DELETE - PATCH - OPTIONS - HEAD targetSchema: description: Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.. type: string operationId: description: The operationId of the path you can call to follow this link. This allows you to look up not only the path and method, but the description of that path and any parameters you need to supply. type: string title: description: Exact copy of the "summary" field on the linked operation. type: string assignedTaskType: type: object description: Holds the assigned task code for a tasksheet. properties: taskCode: description: The Code for the task. type: string minLength: 0 maxLength: 20 assignedTasksType: type: array description: Holds the assigned task codes for a tasksheet. maxItems: 4000 items: $ref: '#/components/schemas/assignedTaskType' masterInfoCodeDetailType: type: string enum: - LongDescription - ShortDescription hotelInterfaceType: type: object properties: interfaceId: description: Unique DB internal number of a Hotel Interface record. $ref: '#/components/schemas/uniqueID_Type' hotelId: description: Hotel Code type: string minLength: 0 maxLength: 20 interfaceName: description: Name of the Hotel Interface type: string minLength: 0 maxLength: 40 interfaceType: description: Three letter code for each interface that identifies the interface. $ref: '#/components/schemas/hotelInterfaceTypeType' logo: description: Hotel Interface Logo. On the database, this is also referred as DBF Logo. This is a three letter code followed by an underscore(_). This tells us which DBF files and log files with the prefix that IFC7 is going to create. type: string minLength: 0 maxLength: 20 machineName: description: Unique machine name of the running IFC. type: string minLength: 0 maxLength: 80 status: description: The current status of the IFC. $ref: '#/components/schemas/hotelInterfaceStatusType' activeFlag: description: Indicator if the Hotel Interface is active or not. This is different from the Interface Status, which is either STOPPED or RUNNING. type: boolean cardProcessingType: type: string enum: - Eft - Manual authorizerInfoType: type: object description: Authorizer Information properties: authorizerId: $ref: '#/components/schemas/uniqueID_Type' authorizerUserName: description: Application user name of the authorizer type: string minLength: 0 maxLength: 40 authorizerName: description: Full name of the authorizer. type: string minLength: 0 maxLength: 100 authorizerRateCode: description: Rate code of the authorizer. type: string minLength: 0 maxLength: 20 inheritAuthorizerRateCode: description: Indicates whether user has the choice to have reservation inherit rate code from the authorizer. type: boolean reservationQueueStatistics: type: object description: Response for the fetch of current Reservations In Queue statistics. Contains the statistic information. properties: statistics: description: Queue Reservation statistics. Currently statistic is by Room Type. $ref: '#/components/schemas/reservationQueueStatisticsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' resCommunicationType: type: object description: Communication details for a reservation. properties: telephones: description: List of Telephone Number Information type: object properties: telephoneInfo: description: Collection of Detailed information on telephone/fax for the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/telephoneInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer emails: description: List of email address for the customer. type: object properties: emailInfo: description: Collection of Detailed information on an eMail address for the customer. type: array maxItems: 4000 items: $ref: '#/components/schemas/emailInfoType' hasMore: description: Indicates whether all the records are included in the response or not. Absence of the attribute values should be consider as all rows fetched in the response. type: boolean totalResults: description: Total number of rows queried type: integer count: description: Total number of rows returned type: integer masterInfoType: type: object properties: codeInfo: type: array maxItems: 4000 items: $ref: '#/components/schemas/codeInfoType' codeType: $ref: '#/components/schemas/masterType' ratePlanRatingType: type: string description: Possible Rate plan rating values. enum: - MostImportant - Important - SomewhatImportant - LessImportant - LeastImportant - NoValueSet promotionType: type: object description: Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation. properties: promotionCode: description: Promotion code associated with the rate plan. type: string minLength: 0 maxLength: 20 promotionName: description: Promotion code Name associated with the rate plan. type: string minLength: 0 maxLength: 20 couponCode: description: Promotion Coupon Code when promotion is setup to have a valid coupon code. type: string minLength: 0 maxLength: 40 turndownInfoType: type: object properties: turndownStatusInfo: $ref: '#/components/schemas/turndownStatusType' roomCleaningPriorityType: type: object description: Type to indicate the cleaning priority for a room. properties: prioritySequence: description: Priority sequence of the room for cleaning. type: integer housekeepingRoomReservationStatusType: type: string description: Room Reservation status types used in housekeeping. These may be different from the actual reservation statuses as these relate to the current reservation for the room. enum: - Arrival - Arrived - DayUse - DueOut - Departed - NotReserved - StayOver nameTypeType: type: string enum: - Guest - Company - Agent - Contact - Source - Group - Employee - Hotel - Purge membershipInfoType: type: object description: The Membership object identifies the frequent customer reward program. properties: membershipId: description: Membership ID (Unique ID from the memberships table). type: number programCode: description: The code or name of the membership program ('Hertz', 'AAdvantage', etc.). type: string minLength: 0 maxLength: 20 bonusCode: description: The code or name of the bonus program. BonusCode can be used to indicate the level of membership (Gold Club, Platinum member, etc.) type: string minLength: 0 maxLength: 20 membershipTypeDesc: description: The description of the ProgramCode.(Delta Previlige for code DP) type: string minLength: 0 maxLength: 2000 membershipLevelDesc: description: The description of the Bonus Code.(Platinum for code P) type: string minLength: 0 maxLength: 2000 accountId: description: The account identification number for this particular member in this particular program. type: string minLength: 0 maxLength: 50 membershipLevel: description: The code or name of the membership level and indicates the level of membership (Gold Club, Platinum member, etc.). This is same as the BonusCode. type: string minLength: 0 maxLength: 20 playerRanking: description: Ranking assigned to the Player Profile by the Gaming system. type: integer reservationStatusStatisticsResponseType: type: object description: Reservation Status Statistics properties: reservationStatusStatistics: type: array maxItems: 4 description: Statistics for each Reservation Status items: $ref: '#/components/schemas/reservationStatusStatisticsType' housekeepingTaskCodeType: type: object description: Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management. properties: description: description: Description of the Task Code. type: string minLength: 0 maxLength: 80 instructions: description: Instructions for this Task Code. type: string minLength: 0 maxLength: 2000 facilityDepartureTask: description: Indicates if this task code is the Departure Room Default Task to be scheduled on the departure date of the reservations. Defining a Departure Room Default Task is available when the 'Housekeeping Task Scheduling' OPERA Control is active. type: boolean linenChange: description: Indicates if a linen change is necessary. type: boolean hotelId: description: Property where this task code is configured. type: string minLength: 0 maxLength: 20 code: description: The Code for the task. type: string minLength: 0 maxLength: 20 sequence: description: Ordering sequence for display. type: integer applicationUserType: type: object properties: hotel: description: Hotel where user belongs. $ref: '#/components/schemas/codeDescriptionType' appUser: type: string minLength: 0 maxLength: 250 lDAPUser: type: string minLength: 0 maxLength: 60 actAs: type: string minLength: 0 maxLength: 20 actAt: type: string minLength: 0 maxLength: 20 userDefaultLanguage: type: string minLength: 0 maxLength: 20 appUserId: $ref: '#/components/schemas/uniqueID_Type' cashierId: type: integer cashierTitle: description: Cashier title. type: string minLength: 0 maxLength: 2000 department: type: string minLength: 0 maxLength: 60 departmentLocation: type: string minLength: 0 maxLength: 60 salesRepCode: type: string minLength: 0 maxLength: 20 expiryDate: type: string format: date maxLength: 8 disabledUntil: type: string format: date maxLength: 8 passwordChangeDate: type: string format: date maxLength: 8 userInfo: $ref: '#/components/schemas/employeeInfoType' userSessionInfo: description: This is only used during log-in. $ref: '#/components/schemas/userSessionInfoType' attendantInfo: $ref: '#/components/schemas/attendantType' taskSheetType: type: string description: Task Sheet classification. enum: - NoServiceRequired - DoNotDisturb - ManuallyCreated - AutomaticGeneration - Isolated - ExtraRooms payeeInfoType: type: object description: Payee information. properties: payeeId: description: Opera name id of the payee. $ref: '#/components/schemas/uniqueID_Type' payeeName: description: Name of the payee. type: string minLength: 0 maxLength: 80 payeeAddress: description: Address of the payee. $ref: '#/components/schemas/addressInfoType' payeeAddressCount: description: Payee multiple address count. type: integer payeeReferenceCurrency: description: Reference currency of the payee. type: string minLength: 0 maxLength: 20 payeeAccountInfo: description: AR account short info of the payee. $ref: '#/components/schemas/aRAccountShortInfoType' payeeTaxNumber: description: The tax number of the payee. type: string minLength: 0 maxLength: 40 resAccompanyGuestListType: type: array description: Collection of accompany guests maxItems: 4000 items: $ref: '#/components/schemas/resAccompanyGuestInfoType' blockIdList: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' basicEmailType: type: string description: Email address minLength: 0 maxLength: 2000 reservationQueueStatisticsType: type: object description: Type for statistics of the reservations currently in Queue for Check-In. properties: roomType: description: Room Type statistics for the reservations currently in Queue for Check-In. type: array maxItems: 4000 items: $ref: '#/components/schemas/reservationQueueRoomTypeStatisticsType' averageQueueTimeToCheckIn: description: The average time, in seconds, a reservation was on queue prior to Check-In. type: integer averageQueueTimeCurrentReservations: description: The average time, in seconds, of the reservations currently in queue. type: integer resSharedGuestListType: type: array description: Collection of shared guest reservations. maxItems: 4000 items: $ref: '#/components/schemas/resSharedGuestInfoType' roomTypeShortInfoType: type: object description: Basic information of room type. properties: pseudo: description: Indicates if room is a pseudo. This is read-only. type: boolean suite: description: Indicates if room is a suite. This is read-only. type: boolean roomClass: description: Room Class of the room. This is read-only. type: string minLength: 0 maxLength: 20 shortDescription: description: Short Description of room type. type: string minLength: 0 maxLength: 200 houseKeeping: description: Indicates if room type of the room is flagged as housekeeping. This is read-only. type: boolean smokingPreference: description: Specifies the smoking preference for room type of the room. type: string minLength: 0 maxLength: 20 building: description: Building associated with the room. type: string minLength: 0 maxLength: 20 roomAssignmentRating: description: Assignment Rating associated with the room. $ref: '#/components/schemas/ratePlanRatingType' minimumOccupancy: description: Minimum occupancy for the room type. type: integer maximumOccupancy: description: Maximum occupancy for the room type. type: integer roomFeatures: description: Room Features for the room. $ref: '#/components/schemas/roomFeaturesType' accessible: description: Indicates if room type is accessible. type: boolean roomType: description: Room type of the room. type: string minLength: 0 maxLength: 20 meetingRoom: description: Indicates whether function space can be meeting room. type: boolean taskSheetStatistics: type: object properties: taskStatisticsInfo: description: Information regarding the Task Sheet statistics. $ref: '#/components/schemas/hSKTaskSheetStatisticsInfoType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' userSessionDefaultsType: type: object properties: dbDateFormat: type: string oracleDateFormat: type: string oracleTimeFormat: type: string javaDateFormat: type: string javaTimeFormat: type: string currencyCode: type: string minLength: 0 maxLength: 20 currencyFormat: type: string defaultLanguage: type: string baseLanguage: type: string minLength: 0 maxLength: 20 hSKTaskSheetInfoType: type: object description: Holds the information for the task sheet. properties: assignedTasks: $ref: '#/components/schemas/assignedTasksType' attendant: type: string minLength: 0 maxLength: 100 taskSeqNo: type: integer taskSheetType: $ref: '#/components/schemas/taskSheetType' taskSheetNo: type: integer taskDate: type: string format: date maxLength: 8 totalTaskCredits: type: integer totalCompletedCredits: type: integer averageActualTimeInSecs: type: integer taskSheetDetails: $ref: '#/components/schemas/hSKTaskSheetDetailsInfoType' roomSummary: type: array maxItems: 4000 items: type: object properties: housekeepingRoomStatusType: description: Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOfOrder, OutOfService. type: string enum: - Clean - Dirty - Pickup - Inspected - OutOfOrder - OutOfService totalCount: type: integer userSessionInfoType: type: object properties: businessDate: type: string format: date maxLength: 8 systemDate: type: string format: date maxLength: 8 terminal: type: string runningApp: type: string shareProfiles: type: boolean hotel: $ref: '#/components/schemas/codeDescriptionType' cro: $ref: '#/components/schemas/codeDescriptionType' chain: type: string minLength: 0 maxLength: 20 cROCountryCode: type: string minLength: 0 maxLength: 20 sessionDefaults: $ref: '#/components/schemas/userSessionDefaultsType' parameters: $ref: '#/components/schemas/parametersType' resMobileNotificationsType: type: object description: Contains the status of Room Ready and Key Ready messages. properties: roomReady: description: Denotes the status of Room Ready message. It can have one of the values:PENDING, COMPLETED or FAILED $ref: '#/components/schemas/communicationStatusType' keyReady: description: Denotes the status of Key Ready message. It can have one of the values:PENDING, COMPLETED or FAILED $ref: '#/components/schemas/communicationStatusType' checkoutMessageReceived: description: Indicates if the Mobile checkout message is received. type: boolean requiresAction: description: Indicates if user action is required. The action could be for sending Room Ready or Key Ready Notification. It could also be for initiating Checkout type: boolean errorMessage: description: Error message when Mobile Notification has failed. type: string facilityTaskType: type: object description: Information regarding facility task on a reservation. properties: task: description: The Task Code. $ref: '#/components/schemas/housekeepingTaskCodeType' supplies: description: Supplies associated with the task. $ref: '#/components/schemas/facilityCodesType' date: description: The Date on which the task is applicable. type: string format: date maxLength: 8 sourceOfSaleType: type: object description: Point of Sale of reservation. Identifies the entity/channel who made the reservation. properties: sourceType: description: Type of entity/channel who made the reservation.. type: string minLength: 0 maxLength: 40 sourceCode: description: The entity/channel who made the reservation. type: string minLength: 0 maxLength: 20 sitePlanSectionType: type: object description: Represents the site plan section record. properties: sectionCode: description: The site plan section code. type: string minLength: 0 maxLength: 20 sectionType: description: The section type. type: string minLength: 0 maxLength: 20 linkCode: description: The link code for the section. type: string minLength: 0 maxLength: 20 coordinates: description: The coordinates for this section. type: string description: description: The description of this section. type: string codeDescriptionType: type: object description: This contains a generic code and description information. properties: code: description: Code. type: string minLength: 0 maxLength: 20 description: description: description. type: string minLength: 0 maxLength: 2000 roomSectionType: type: object properties: daySectionCode: type: string minLength: 0 maxLength: 20 eveningSectionCode: type: string minLength: 0 maxLength: 20 roomFeaturesType: type: array description: A recurring element that identifies the room features. maxItems: 4000 items: $ref: '#/components/schemas/roomFeatureType' roomConditionType: type: object description: Condition to be assigned on the room. properties: roomCondition: description: Code and Decription of Condition to be assigned on the room. $ref: '#/components/schemas/codeDescriptionType' assignmentType: description: Determine if room, after applying condition, is available or not in Room Assignment listing. $ref: '#/components/schemas/roomConditionAssigmentType' remarks: description: Remarks on room condition assignment. type: string minLength: 0 maxLength: 2000 surnameType: type: string description: Family name, last name. minLength: 0 maxLength: 80 hSKTaskSheetDetailsInfoType: type: object description: Holds the task sheet statistics details information. properties: rooms: description: Details of the room which is part of the Task Sheet. The room details will be returned when the request for IncludeTaskSheetDetails(flag in the search type) is true. type: array maxItems: 4000 items: type: object properties: roomType: description: Room type basic information of the room. $ref: '#/components/schemas/roomTypeShortInfoType' floor: description: Floor of the Room. type: string minLength: 0 maxLength: 20 floorDescription: description: Description for the Floor of the Room. type: string minLength: 0 maxLength: 20 roomFeatures: description: Room Features for the room. $ref: '#/components/schemas/roomFeaturesType' roomDescription: description: Detail Long Description Of The Room. type: string minLength: 0 maxLength: 20 description: description: Description of the room. $ref: '#/components/schemas/translationTextType2000' smokingPreference: description: This indicates room smoking preference. type: string minLength: 0 maxLength: 20 smokingPreferenceDescription: description: This indicates the description of the room smoking preference. type: string minLength: 0 maxLength: 20 building: description: Building associated with the room. type: string minLength: 0 maxLength: 20 roomAssignmentRating: description: Assignment Rating associated with the room. $ref: '#/components/schemas/ratePlanRatingType' accessible: description: Indicates whether the room is accessibility compliant. type: boolean roomId: description: Code of the room. type: string minLength: 0 maxLength: 20 meetingRoom: description: Indicates whether the room is a Meeting Room type: boolean roomSection: description: Room sections of the room. $ref: '#/components/schemas/roomSectionType' housekeeping: description: Identifies the Housekeeping information.. $ref: '#/components/schemas/housekeepingType' outOfOrder: description: Identifies the room Out of Order/Out of Service information. $ref: '#/components/schemas/roomsOutOfOrderType' discrepancy: description: Identifies the room discrepancy information. $ref: '#/components/schemas/roomDiscrepanciesType' sitePlanSection: description: Identifies the site plan location of the room. $ref: '#/components/schemas/sitePlanSectionType' componentRoomNumber: description: This flag indicates component room. type: string minLength: 0 maxLength: 20 connectingRooms: description: This flag indicates connecting rooms. $ref: '#/components/schemas/roomRoomsType' componentRooms: description: This flag indicates component rooms. $ref: '#/components/schemas/roomRoomsType' attendant: type: array maxItems: 4000 items: $ref: '#/components/schemas/currentServicingAttendantType' hold: description: Hold attributes if any. $ref: '#/components/schemas/roomHoldType' turndownInfo: $ref: '#/components/schemas/turndownInfoType' resvInfo: type: array maxItems: 4000 items: $ref: '#/components/schemas/reservationShortInfoType' componentRoomNumbers: description: List of component room numbers. type: array maxItems: 4000 items: type: string minLength: 0 maxLength: 20 reservationInfo: type: array maxItems: 4000 items: $ref: '#/components/schemas/reservationInfoType' servicingInfo: description: Information regarding the current servicing of the room. type: array maxItems: 4000 items: $ref: '#/components/schemas/currentServicingAttendantType' attendantTimeEntriesInfo: type: array maxItems: 4000 items: $ref: '#/components/schemas/hSKAttendantTimeLogsType' instructions: description: Task Sheet instructions at the room level. type: string minLength: 0 maxLength: 2000 totalCredits: description: Total credits for this room. type: integer wakeUpTime: description: The wake up time of the current date type: string format: date maxLength: 8 cleaningSequence: description: The sequence for cleaning this room in the task sheet. This would apply only for Pickup and Dirty rooms. type: integer defaultSequence: description: The sequence for this room from configuration. type: integer hasPriority: description: The priority for this room. type: boolean actualTimeInMins: description: The actual time spent by the attendant when doing a service to the room. type: integer roomSkipCount: description: The number of skip count for that room. type: integer description: This type represents the primary room attributes. guestLastStayInfoType: type: object description: Contains last stay related details of the guest. properties: lastStayDate: description: Guest's last stay date. type: string format: date maxLength: 8 lastStayRoom: description: Room Number where the guest stayed. type: string minLength: 0 maxLength: 20 lastStayRate: description: The Rate amount of the guest's last stay. $ref: '#/components/schemas/currencyAmountType' totalStay: description: The total number of previous stay of the guest. type: integer housekeepingSectionType: type: object description: Information regarding Housekeeping Sections. properties: hotelId: description: Property where this section is defined. type: string minLength: 0 maxLength: 20 code: description: The Housekeeping Section Code. type: string minLength: 0 maxLength: 20 description: description: Description of the Section. type: string minLength: 0 maxLength: 80 sectionGroup: description: Housekeeping Section Group. type: string minLength: 0 maxLength: 20 targetCredits: description: Target Credit for each task sheet created for this section when auto task assignment is broken out by section. type: integer rooms: description: Rooms count for this section code. This is auto populated while creating/fetching record. type: integer roomCredits: description: Number of housekeeping credits. This is auto populated while creating/fetching record. type: integer sequence: description: Display sequence when task assignment is automatically broken out by Section Group. type: integer inactive: description: Indicates if the Section Code is active. type: boolean reservationStatusStatisticsType: description: Reservation Statistics for a Reservation Status type: object properties: reservationStatus: description: Reservation Status. $ref: '#/components/schemas/reservationStatusEnumType' total: description: Number of reservations. type: integer minimum: 0 maximum: 4000 roomClasses: type: array description: Reservation Statistics for each Room Class maxItems: 4000 items: $ref: '#/components/schemas/roomClassStatisticsType' emailInfoType: type: object description: Information on an email for the customer. properties: email: description: eMail deatils for the profile. $ref: '#/components/schemas/emailType' id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 warningType: type: object description: Used when a message has been successfully processed to report any warnings or business errors that occurred. properties: value: type: string description: Property Value shortText: description: An abbreviated version of the error in textual format. type: string maxLength: 2000 code: description: If present, this refers to a table of coded values exchanged between applications to identify errors or warnings. type: string minLength: 0 maxLength: 20 docURL: description: If present, this URL refers to an online description of the error that occurred. type: string maxLength: 2000 status: description: If present, recommended values are those enumerated in the ErrorRS, (NotProcessed Incomplete Complete Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration. type: string maxLength: 2000 tag: description: If present, this attribute may identify an unknown or misspelled tag that caused an error in processing. It is recommended that the Tag attribute use XPath notation to identify the location of a tag in the event that more than one tag of the same name is present in the document. Alternatively, the tag name alone can be used to identify missing data [Type=ReqFieldMissing]. type: string maxLength: 2000 recordId: description: If present, this attribute allows for batch processing and the identification of the record that failed amongst a group of records. This value may contain a concatenation of a unique failed transaction ID with specific record(s) associated with that transaction. type: string maxLength: 2000 type: description: The Warning element MUST contain the Type attribute that uses a recommended set of values to indicate the warning type. The validating XSD can expect to accept values that it has NOT been explicitly coded for and process them by using Type ="Unknown". type: string minLength: 0 maxLength: 20 language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' rph: description: Reference Place Holder used as an index for this warning. type: string minLength: 1 maxLength: 8 hSKAttendantTimeLogsType: type: object description: Holds the information for the task sheet. properties: startRoomStatus: $ref: '#/components/schemas/housekeepingRoomStatusType' endRoomStatus: $ref: '#/components/schemas/housekeepingRoomStatusType' startTime: type: string minLength: 0 maxLength: 20 endTime: type: string minLength: 0 maxLength: 20 resPeriodicFolioType: type: object description: Information regarding periodic folios set on the reservation. properties: lastSettlementDate: description: Latest date when a direct bill settlement was automatically done using the "Direct Bill Batch Folios" option. type: string format: date maxLength: 8 lastFolioDate: description: Latest date when a folio was printed using the "Periodic Batch Folios" option type: string format: date maxLength: 8 frequency: description: Frequency in number of days when folios should be printed for this reservation. type: integer exceptionDetailType: title: Error Detail description: Complex type that contains error details for a REST call. type: object properties: type: type: string description: Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML). title: type: string description: Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization. status: type: integer description: HTTP status code for this occurrence of the problem, set by the origin server. detail: type: string description: Human-readable description specific to this occurrence of the problem. instance: type: string description: Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced. o:errorCode: type: string description: Application error code, which is different from HTTP error code. o:errorPath: type: string description: Path to the problem at the resource or property level. o:errorDetails: description: Details of the error message, consisting of a hierarchical tree structure. type: array items: $ref: '#/components/schemas/errorInstance' links: $ref: '#/components/schemas/links' required: - type - title facilityCodesType: type: array description: List of the facility codes. maxItems: 4000 items: $ref: '#/components/schemas/facilityCodeType' resAttachedProfileListType: type: array maxItems: 4000 items: $ref: '#/components/schemas/resAttachedProfileType' hSKStatCodeType: type: string description: Supported housekeeping statistical codes. enum: - ApprovedCompPostings - StagedCompPostings - DeclinedCompPostings - CompRoutingInstructionsRequests - TotalPhysicalRooms - TotalRoomsToSell - TotalOutOfOrder - TotalOutOfService - TotalRevenue - PercentRoomsOccupied - StayoverRooms - StayoverPersons - StayoverVIP - DeparturesExpectedRooms - DeparturesExpectedPersons - DeparturesExpectedVIP - DeparturesActualRooms - DeparturesActualPersons - DeparturesActualVIP - DeparturesInLastHour - ArrivalsInLastHour - ArrivalsTotal - ArrivalsExpectedRooms - ArrivalsExpectedPersons - ArrivalsExpectedVIP - ArrivalsExpectedRoomsMadeToday - ArrivalsExpectedPersonsMadeToday - ArrivalsExpectedVIPMadeToday - ArrivalsActualRooms - ArrivalsActualPersons - ArrivalsActualVIP - ExtendedStaysRooms - ExtendedStaysPersons - ExtendedStaysVIP - DeparturesTotal - EarlyDeparturesRooms - EarlyDeparturesPersons - EarlyDeparturesVIP - DayUseRooms - DayUsePersons - DayUseVIP - WalkInRooms - WalkInPersons - WalkInVIP - CanceledOnArrivalRooms - CanceledOnArrivalPersons - CanceledOnArrivalVIP - ComplimentaryArrivalRooms - ComplimentaryArrivalPersons - ComplimentaryArrivalVIP - ComplimentaryStayoverRooms - ComplimentaryStayoverPersons - ComplimentaryStayoverVIP - ComplimentaryDepartureRooms - ComplimentaryDeparturePersons - ComplimentaryDepartureVIP - HouseUseArrivalVIP - HouseUseStayoverRooms - HouseUseStayoverPersons - HouseUseStayoverVIP - HouseUseDepartureRooms - HouseUseDeparturePersons - HouseUseDepartureVIP - MinAvailableTonightRooms - MaxOccupiedTonightRooms - MaxOccupiedTonightPersons - MaxOccupiedTonightVIP - MaxPercentageOccupiedTonightRooms - BlocksNotPickedUp - IndividualRooms - IndividualPersons - IndividualVIP - GroupAndBlockRooms - GroupAndBlockPersons - GroupAndBlockVIP - RoomRevenue - AverageRoomRevenue - InspectedRooms - InspectedVacant - InspectedAssigned - InspectedOccupied - CleanedRooms - CleanVacant - CleanAssigned - CleanOccupied - DirtyVacant - DirtyAssigned - DirtyOccupied - PickupVacant - PickupAssigned - PickupOccupied - OutOfOrderVacant - OutOfOrderAssigned - OutOfOrderOccupied - OutOfServiceVacant - OutOfServiceAssigned - OutOfServiceOccupied - QueueRooms - TurndownRequired - TurndownNotRequired - TurndownCompletedRequired - AdultsInHouse - ChildrenInHouse - AdultsExpectedCheckedOut - ChildrenExpectedCheckedOut - AdultsDeparted - ChildrenDeparted - InHouseRooms - InHouse - MaxOccupancyPercentage - Stayover - TotalRoomsReserved - RevPar - SkipRooms - SleepRooms - HouseUseArrivalRooms - HouseUseArrivalPersons - AverageCheckInTime - CurrentAveWaitTime - CheckedInsTotal - ExpectedCheckInsTotal - CheckedOutsTotal - ExpectedCheckOutsTotal - ScheduledCheckOutsTotal - RoomMaintenanceResolvedTotal - RoomMaintenanceUnResolvedTotal - PreRegisteredTotal - VIPPreRegisteredTotal - OpenFolioTotal - TurndownTotal - VIPTurndownTotal - VIPGuestsArriving - VIPGuestsDeparting - VIPGuestsTotal - IndividualAdvanceCheckedInCurrent - BlockAdvanceCheckedInCurrent - IndividualAdvanceCheckedInInhouse - BlockAdvanceCheckedInInhouse - IndividualAdvanceCheckedInTotal - BlockAdvanceCheckedInTotal - InHouseBlocksTotal - CancellationsTotal - NewReservationsTotal - ArrivalResvs - ArrivalVIPResvs - ArrivalMemberResvs - ArrivalUnallocResvs - ArrivalManualAssgnResvs - ArrivalAIAssgnResvs - ArrivalAIUpgResvs - ArrivalAIAssgnVIPResvs - ArrivalAIAssgnMemberResvs - ArrivalAIAssgnOverridden - CompletedRoomMoves - PendingRoomMoves - AdultsArrivals - ChildrenArrivals - Children1Arrivals - Children2Arrivals - Children3Arrivals - Children1InHouse - Children2InHouse - Children3InHouse - PersonRooms roomRoomType: type: object description: This type represents the primary room attributes. properties: roomType: description: Room type basic information of the room. $ref: '#/components/schemas/roomTypeShortInfoType' floor: description: Floor of the Room. type: string minLength: 0 maxLength: 20 floorDescription: description: Description for the Floor of the Room. type: string minLength: 0 maxLength: 20 roomFeatures: description: Room Features for the room. $ref: '#/components/schemas/roomFeaturesType' roomDescription: description: Detail Long Description Of The Room. type: string minLength: 0 maxLength: 20 description: description: Description of the room. $ref: '#/components/schemas/translationTextType2000' smokingPreference: description: This indicates room smoking preference. type: string minLength: 0 maxLength: 20 smokingPreferenceDescription: description: This indicates the description of the room smoking preference. type: string minLength: 0 maxLength: 20 building: description: Building associated with the room. type: string minLength: 0 maxLength: 20 roomAssignmentRating: description: Assignment Rating associated with the room. $ref: '#/components/schemas/ratePlanRatingType' accessible: description: Indicates whether the room is accessibility compliant. type: boolean roomId: description: Code of the room. type: string minLength: 0 maxLength: 20 meetingRoom: description: Indicates whether the room is a Meeting Room type: boolean roomCondition: description: Code and description of condition assigned on the room. $ref: '#/components/schemas/codeDescriptionType' roomDiscrepanciesType: type: array description: Room Discrepancies between front office and housekeeping room status and number of persons in the room. maxItems: 4000 items: $ref: '#/components/schemas/roomDiscrepancyType' personNameTypeType: type: string description: Person's name in an external system. enum: - Primary - Alternate - Incognito - External - Phonetic roomPersonsType: type: object properties: frontOfficePersons: type: integer houseKeepingPersons: type: integer resGuestExternalInfoType: type: object description: Specifies Company or Travel Agent profile using IATA or Corp. No. properties: givenName: description: Given name, first name or names $ref: '#/components/schemas/givenNameType' surname: description: Family name, last name. $ref: '#/components/schemas/surnameType' masterType: type: string enum: - Country - State - AddressType - PhoneType - RateCategory - CalculationRule - PostingRythym - BillingInstruction - TransactionCode - DisplaySet - MailingActions - DistanceType - District - Territory - FiscalRegion - InventoryItem - Package - RoomFeaturePreference - SpecialPreference - Promotion - Department - ReservationPreference - FacilityTask - RoomType - RateCode - OutOfOrderReason - Block searchMatchType: type: object description: Search match indicating attribute and the matching value. properties: attribute: description: Search match attribute. type: string minLength: 0 maxLength: 2000 value: description: Search match value. type: string minLength: 0 maxLength: 2000 resGuaranteeType: type: object description: Validations type record returned after Validations are done. properties: guaranteeCode: description: Guarantee Code. type: string minLength: 0 maxLength: 20 shortDescription: description: Guarantee Code. type: string minLength: 0 maxLength: 80 onHold: description: Guarantee Code. type: boolean translationTextType2000: type: object description: Contains Multiple translated texts and language codes. properties: defaultText: description: Default text with Character length from 0 to 2000. type: string minLength: 0 maxLength: 2000 translatedTexts: description: List of translated text and language codes. $ref: '#/components/schemas/translationsTextType' resCompAccountingType: type: object description: Information regarding comp accounting on the reservation. properties: compType: description: Code used to identify the casino comp type and ranking of a guest. type: string minLength: 0 maxLength: 20 authorizer: description: ID of the employee who will act as the host for this guest. type: string minLength: 0 maxLength: 40 compPostings: description: Indicates if the Comp Billing/posting Exist type: string minLength: 0 maxLength: 5 phoneNumberType: type: string description: Phone number minLength: 0 maxLength: 40 hotelInterfaceStatusType: type: string description: Status of the Hotel Interface either STOPPED or RUNNING. enum: - Stopped - Running - Waiting - StopInitiated - StartInitiated - RebootInitiated - Other givenNameType: type: string description: Given name, first name or names minLength: 0 maxLength: 40 advanceCheckInType: type: object description: Information relating to Reservation's Advance Checked In state and Expected Time of Return properties: advanceCheckedIn: description: Indicates if the reservation is marked as Advance Checked In type: boolean expectedReturnTime: description: Expected Return Time type: string format: date-time eTRComments: description: ETR Comments type: string minLength: 0 maxLength: 2000 attendantType: type: object properties: attendantId: type: string minLength: 0 maxLength: 20 hotelId: type: string minLength: 0 maxLength: 20 resRevenueBalanceType: type: object description: Revenue and Balance Amount summary for the reservation. properties: totalFixedCharge: description: Total Fixed Charges on the reservation. $ref: '#/components/schemas/currencyAmountType' totalPayment: description: Total of all payments on the guest ledger for the reservation. $ref: '#/components/schemas/currencyAmountType' roomRevenue: description: Room Revenue generated by the reservation. $ref: '#/components/schemas/currencyAmountType' foodAndBevRevenue: description: Food and Beverage Revenue generated by the reservation. $ref: '#/components/schemas/currencyAmountType' otherRevenue: description: Other Revenue generated by the reservation. $ref: '#/components/schemas/currencyAmountType' nonRevenue: description: Total Non Revenue posted on the reservation. $ref: '#/components/schemas/currencyAmountType' totalRevenue: description: Total Revenue generated by the reservation. $ref: '#/components/schemas/currencyAmountType' balance: description: Balance amount on the reservation. $ref: '#/components/schemas/currencyAmountType' compBalance: description: Comp Balance amount $ref: '#/components/schemas/currencyAmountType' totalDepositPaid: description: Total of all deposit payment posted to the reservation. $ref: '#/components/schemas/currencyAmountType' facilityCodeType: type: object description: Facility Housekeeping Code, its description and quantity. properties: description: description: Facility Code. type: string minLength: 0 maxLength: 80 quantity: description: Signifies the quantity. type: integer code: description: Facility code value. type: string minLength: 0 maxLength: 20 anonymizationType: type: object description: Provides information about guest's anonymization status. properties: anonymizationStatus: description: Status of anonymization such as Requested or Anonymized. $ref: '#/components/schemas/anonymizationStatusType' anonymizationDate: description: Date and Time when the guest was anonymized. type: string format: date-time resAttachedProfileType: type: object properties: name: description: Attached profile name type: string profileIdList: description: Collection of unique profile identifiers $ref: '#/components/schemas/profileIdList' reservationProfileType: $ref: '#/components/schemas/resProfileTypeType' parametersType: type: array description: Collection of generic Name-Value-Pair parameters. maxItems: 4000 items: $ref: '#/components/schemas/parameterType' roomDiscrepancyType: type: string description: Simple type for discrepant room status instructions to be used in requests for fetching housekeeping and front office room discrepancy. Valid values are Sleep, Skip, Person Discrepancy, Due Out Only. enum: - Sleep - Skip - PersonDiscrepancy emailType: type: object description: Information on an email for the customer. properties: emailAddress: description: Defines the e-mail address. type: string minLength: 0 maxLength: 2000 type: description: Defines the purpose of the e-mail address (e.g. personal, business, listserve). type: string minLength: 0 maxLength: 20 typeDescription: description: Describes the Type code type: string minLength: 0 maxLength: 2000 emailFormat: description: Supported Email format. type: string enum: - Html - Text primaryInd: description: When true, indicates a primary information. type: boolean orderSequence: description: Display Order sequence. type: number createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 hSKStatReportCodeType: type: string description: Supported Housekeeping report codes. enum: - HouseSummary - HouseSummaryMonthToDate - HouseSummaryYearToDate - ReservationActivity - ReservationActivityDaily - ReservationActivityMonthToDate - ReservationActivityYearToDate - ComplimentaryOrHouseUse - DailyProjection - RoomStatus - LastHourStatus - Turndown - InHouse - CheckIns - CheckOuts - AvailableRooms - RoomMaintenance - ReservationStatistics - VIPGuests - AdvanceCheckIn - BlockArrivals - ReservationsCancellationsToday - AIRoomAssignment - CompRouting - RoomMoveStatistics operaVersionNumberType: type: string description: Current Opera Version Number minLength: 0 maxLength: 40 hSKTaskSheetStatisticsInfoType: type: object description: Holds the task sheet statistics information. properties: taskSheetStatisticsInfo: type: array maxItems: 4000 items: $ref: '#/components/schemas/hSKTaskSheetInfoType' masterInfoList: description: Refer to Generic common types document type: array maxItems: 4000 items: $ref: '#/components/schemas/masterInfoType' hSKStatType: type: object description: Since the statistical value can be represented in different measure of units, this element will provide a flexible definition for the supported Opera9 statistical units. properties: value: description: Statistical value. type: number category: description: Statistical unit category. $ref: '#/components/schemas/statUnitCategoryType' code: $ref: '#/components/schemas/hSKStatCodeType' addressType: type: object description: Provides address information. properties: isValidated: description: Indicator to define if the Address is validated by the Address Validation System. type: boolean addressLine: description: When the address is unformatted (FormattedInd="false") these lines will contain free form address details. When the address is formatted and street number and street name must be sent independently, the street number will be sent using StreetNmbr, and the street name will be sent in the first AddressLine occurrence. type: array maxItems: 4 items: type: string minLength: 0 maxLength: 80 cityName: description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). type: string minLength: 0 maxLength: 40 postalCode: description: Post Office Code number. type: string minLength: 0 maxLength: 15 cityExtension: description: Post Office City Extension Code number. City Extension mainly used for UK addresses. type: string minLength: 0 maxLength: 20 county: description: County or District Name (e.g., Fairfax). This is read only. type: string minLength: 0 maxLength: 20 state: description: State or Province name (e.g., Texas). type: string minLength: 0 maxLength: 20 country: description: Country name (e.g., Ireland). $ref: '#/components/schemas/countryNameType' language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' type: description: Defines the type of address (e.g. home, business, other). type: string minLength: 0 maxLength: 20 typeDescription: description: Describes the type code type: string primaryInd: description: When true, indicates a primary information. type: boolean updateReservations: description: Indicates whether to update the reservations or not. If true and the address is primary, then all associated active reservations will be updated with the new primary address. type: boolean barCode: description: The postal barcode for the address. type: string minLength: 0 maxLength: 100 createDateTime: description: Time stamp of the creation. type: string format: date-time creatorId: description: ID of creator. The creator could be a software system identifier or an identifier of an employee responsible for the creation. type: string minLength: 0 maxLength: 200 lastModifyDateTime: description: Time stamp of last modification. type: string format: date-time lastModifierId: description: Identifies the last software system or person to modify a record. type: string minLength: 0 maxLength: 200 purgeDate: description: Date an item will be purged from a database (e.g., from a live database to an archive). type: string format: date maxLength: 8 taxTypeType: type: object description: Provides information about the Tax Type. properties: hotelId: description: Code of the Hotel. type: string minLength: 0 maxLength: 20 code: description: Code of the Tax Type. type: string minLength: 0 maxLength: 20 description: description: Description of the Tax Type. type: string minLength: 0 maxLength: 2000 collectingAgentTax: description: A boolean flag for Collecting Agent Tax type: boolean printAutoAdjust: description: Print auto adjust information for this tax type on the tax exempt report. type: boolean reportExemptDays: description: Number of days after which the guest will be tax exempt. Only used for tax exempt report. type: integer reportTaxPercentage: description: Tax percentage. Only used for tax exempt report. type: number minimum: 0 maximum: 100 minimumLengthOfStay: description: Minimun Length of Stay. type: integer codeInfoType: type: object description: '' properties: description: type: string minLength: 0 maxLength: 80 addtionalCodeInfo: $ref: '#/components/schemas/addtionalCodeInfoType' hotelId: type: string minLength: 0 maxLength: 20 code: type: string minLength: 0 maxLength: 20 roomStatusStatisticsListType: type: object properties: roomStatusStatistics: type: array items: $ref: '#/components/schemas/roomStatusStatisticsType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' childAgesType: type: array description: Age of a child in years. maxItems: 4000 items: $ref: '#/components/schemas/childAgeType' roomStatusType: type: object properties: reservationStatusList: description: List of status of the reservation to which this Room is assigned.. type: array maxItems: 4000 items: $ref: '#/components/schemas/housekeepingRoomReservationStatusType' roomStatus: description: Status of the room (Dirty/Clean/Inspected/Pickup). $ref: '#/components/schemas/housekeepingRoomStatusType' frontOfficeStatus: description: Front office status ( Occupied/Vacant ). $ref: '#/components/schemas/frontOfficeRoomStatusType' housekeepingStatus: description: Housekeeping status ( Occupied/Vacant ). $ref: '#/components/schemas/frontOfficeRoomStatusType' roomOutOfOrderType: type: object description: Out Of Order and Out Of Service Room information. properties: repairRemarks: description: Notes or Remarks on the OO/OS room type: string minLength: 0 maxLength: 2000 returnStatus: description: Room Status which will be used on completion of OO/OS. $ref: '#/components/schemas/housekeepingRoomStatusType' reasonCode: description: Reason Code why the room is OO/OS. type: string minLength: 0 maxLength: 20 reasonDesc: description: Reason Description why the room is OO/OS. type: string minLength: 0 maxLength: 80 newDateRange: description: The new start date and end date, if the dates were changed as part of an update. This would be blank for new OO/OS rooms. $ref: '#/components/schemas/dateRangeType' roomStatus: description: The out of order or out of service room status OO/OS. $ref: '#/components/schemas/housekeepingRoomStatusType' start: description: The starting value of the date range. type: string format: date maxLength: 8 end: description: The ending value of the date range. type: string format: date maxLength: 8 translationsTextType: type: array description: Language code for the translation. maxItems: 4000 items: type: object properties: value: type: string description: Used for Character Strings, length 0 to 2000. minLength: 0 maxLength: 2000 language: description: Language identification. type: string minLength: 0 maxLength: 20 description: Language code for the translation. roomTypeStatisticsType: description: Reservation Statistics for a Room Type type: object properties: roomType: description: Room Type name. Available room types can be retrieved via /listOfValues/hotels/{hotelId}/roomTypes type: string maxLength: 20 total: description: Number of reservations. type: integer minimum: 0 maximum: 4000 bedTaxReportingType: type: object description: This stores the information for Bed Tax Reporting. Mainly used in Maldives. properties: taxRegistrationNo: description: Tax Registration Number for Maldives Bed Tax Reporting. type: number visaNumber: description: Visa number used for Maldives Bed Tax Reporting type: string minLength: 0 maxLength: 40 visaIssueDate: description: Visa Issue Date used for Maldives Bed Tax Reporting. type: string format: date maxLength: 8 visaExpiryDate: description: Visa Expiration Date used for Maldives Bed Tax Reporting type: string format: date maxLength: 8 taxableDays: description: Number of days for which the Maldives tax is applicable. type: integer reservationAllowedActionsType: type: array description: Allowed action. maxItems: 11 items: $ref: '#/components/schemas/reservationAllowedActionType' roomClassStatisticsType: description: Reservation Statistics for a Room Class type: object properties: roomClass: description: Room Class name. Available room classes can be retrieved via /listOfValues/hotels/{hotelId}/roomClasses type: string maxLength: 20 total: description: Number of reservations. type: integer minimum: 0 maximum: 4000 roomTypes: type: array description: Reservation Statistics for each Room Type maxItems: 4000 items: $ref: '#/components/schemas/roomTypeStatisticsType' roomHoldType: type: object properties: holdUntil: description: The date and time when hold will expire. Uses the hotel's time zone. type: string format: date-time holdUser: description: User who placed room on hold. type: string minLength: 0 maxLength: 80 comments: description: Comments of the room hold. type: string minLength: 0 maxLength: 2000 vIPType: type: object description: The supplier's ranking of the customer. properties: vipCode: description: VIP Code. type: string minLength: 0 maxLength: 20 vipDescription: description: VIP Description. type: string minLength: 0 maxLength: 80 searchMatchesType: type: array description: List of Generic Name-Value-Pair Parameters used for super search matches. maxItems: 4000 items: $ref: '#/components/schemas/searchMatchType' externalReferencesType: type: array description: This type contains unique information of external reference. maxItems: 4000 items: $ref: '#/components/schemas/externalReferenceType' countryNameType: type: object description: Code for a country or a nationality. properties: value: type: string description: Used for Character Strings, length 0 to 200 - It indicates country/nationality description. minLength: 0 maxLength: 200 code: description: Code for a country or a nationality. type: string minLength: 0 maxLength: 20 displayCountryFlag: description: Setting this to true will display the guest profile's country flag in the OPERA Cloud user interface, if it is configured. type: boolean isoCode: description: ISO standard code for country. type: string minLength: 0 maxLength: 20 errorInstance: title: Error Instance Details description: Complex type that contains error instance details for a REST call. type: object properties: type: type: string description: Absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide a human-readable summary of the problem (for example, using HTML). title: type: string description: Short, human-readable summary of the problem. The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization. status: type: integer description: HTTP status code for this occurrence of the problem, set by the origin server. detail: type: string description: Human-readable description specific to this occurrence of the problem. instance: type: string description: Absolute URI that identifies the specific occurrence of the problem. It may or may not provide additional information if dereferenced. o:errorCode: type: string description: Application error code, which is different from HTTP error code. o:errorPath: type: string description: Path to the problem at the resource or property level. required: - type - title roomFeatureType: type: object description: Room Feature Information. properties: code: description: A code representing a room feature. type: string minLength: 0 maxLength: 20 description: description: A code representing a room feature. type: string minLength: 0 maxLength: 2000 orderSequence: description: Display Order sequence. type: number quantity: description: Indicates quantity. type: integer resExpectedTimesType: type: object description: Holds the Arrival and Departure Time Information properties: reservationExpectedArrivalTime: description: Arrival Time. Uses the hotel's time zone. type: string format: date-time reservationExpectedDepartureTime: description: Departure Time. Uses the hotel's time zone. type: string format: date-time pMS_ResStatusType: type: string description: 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. enum: - Reserved - Requested - NoShow - Cancelled - InHouse - CheckedOut - Waitlisted - DueIn - DueOut - Walkin - PendingCheckout resPreConfiguredRoutingInstrType: type: object description: Instruction to attach Pre-Configured Routing Instructions to a Reservation. properties: authorizerInfo: description: The authorizer information for Promotion Code with attached Complimentary Routing $ref: '#/components/schemas/authorizerInfoType' ratePlanCode: description: Rate Code with attached Routing Instruction. type: string minLength: 0 maxLength: 20 profileType: description: Profile Type with attached Routing Instruction. $ref: '#/components/schemas/resProfileTypeType' promotionCode: description: Promotion Code with attached Complimentary Routing. type: string minLength: 0 maxLength: 20 dateRangeType: type: object description: Date Range with Start and End dates. properties: start: description: The starting value of the date range. type: string format: date maxLength: 8 end: description: The ending value of the date range. type: string format: date maxLength: 8 interfaceRightsStatusType: type: object properties: right: description: Internal code for each allowed right of a Hotel Interface record. type: integer statusCode: description: User defined code for an Interface Right. type: string minLength: 0 maxLength: 5 description: description: User defined description for an Interface Right. type: string minLength: 0 maxLength: 80 category: description: Category code of this interface right. type: string minLength: 0 maxLength: 1 roomRoomsType: type: array description: Collection of rooms. maxItems: 4000 items: $ref: '#/components/schemas/roomRoomType' aRAccountStatusType: type: object description: Type for the Account Status. Status can be restricted and a message/description added to the Account. properties: restriction: description: The Restriction Code added on the Account. This is available when the functionality for adding restriction codes is ON. type: string minLength: 0 maxLength: 20 description: description: User defined status message on the Account. type: string minLength: 0 maxLength: 2000 restricted: description: Flag to indicate if the Account is restricted. type: boolean currentServicingAttendantType: type: object description: The Attendant Name and ID of the attendant servicing the room. properties: section: description: Section Code the attendant has been assigned. $ref: '#/components/schemas/housekeepingSectionType' floor: description: The Floor which is assigned to the attendant. type: string minLength: 0 maxLength: 20 attendantId: description: Attendant's unique identifier. type: string minLength: 0 maxLength: 20 attendantName: description: Attendant's name. type: string minLength: 0 maxLength: 80 hotelId: description: Property where the attendant belongs. type: string minLength: 0 maxLength: 20 activeFlag: description: Indicates if the Attendant is active. type: string minLength: 0 maxLength: 1 sunday: type: boolean monday: type: boolean tuesday: type: boolean wednesday: type: boolean thursday: type: boolean friday: type: boolean saturday: type: boolean appUser: description: The App User Name and ID of the user who started the service. $ref: '#/components/schemas/applicationUserType' startTime: description: The start time of the service. type: string format: date-time status: description: Status of the respective Housekeeping Attendant. $ref: '#/components/schemas/servicingAttendantStatusType' resGuestInfoType: type: object description: Specifies Company or Travel Agent profile using IATA or Corp. No. properties: membership: description: The Membership object identifying the frequent customer reward program. $ref: '#/components/schemas/membershipInfoType' namePrefix: description: Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.) $ref: '#/components/schemas/namePrefixType' givenName: description: Given name, first name or names $ref: '#/components/schemas/givenNameType' alternateGivenName: description: Alternate given name, first name or names type: string minLength: 0 maxLength: 40 middleName: description: The middle name of the person name type: string minLength: 0 maxLength: 40 surnamePrefix: description: e.g "van der", "von", "de" type: string minLength: 0 maxLength: 20 surname: description: Family name, last name. $ref: '#/components/schemas/surnameType' alternateSurname: description: Alternate family name, last name. type: string minLength: 0 maxLength: 40 nameSuffix: description: Hold various name suffixes and letters (e.g. Jr., Sr., III, Ret., Esq.). type: string minLength: 0 maxLength: 20 nameTitle: description: Degree or honors (e.g., Ph.D., M.D.) type: string minLength: 0 maxLength: 20 fullName: description: Full display name type: string alternateFullName: description: Altername full display name type: string phoneNumber: description: Phone number $ref: '#/components/schemas/phoneNumberType' email: description: Email address $ref: '#/components/schemas/basicEmailType' birthDate: description: Date of birth type: string format: date maxLength: 8 language: description: Language identification. type: string pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*' nationality: description: Affiliation or ethnicity to a particular country. $ref: '#/components/schemas/countryNameType' vip: description: The supplier's ranking of the customer (e.g., VIP, numerical ranking). $ref: '#/components/schemas/vIPType' address: description: Address information that is attached to the reservation guest $ref: '#/components/schemas/addressSearchType' anonymization: description: Provides information about the guest's anonymization status $ref: '#/components/schemas/anonymizationType' accompanyGuests: description: List of guest names that are accompanying the reservation guest $ref: '#/components/schemas/resAccompanyGuestListType' externalInfo: description: External information about the guest associated with the reservation. $ref: '#/components/schemas/resGuestExternalInfoType' guestLastStayInfo: description: Contains information regarding the last stay of this guest. $ref: '#/components/schemas/guestLastStayInfoType' guestRestrictedCode: description: Guest profile restricted reason code type: string guestRestrictedReasonDesc: description: Guest profile restricted reason description type: string guestRestricted: description: True indicates there are restrictions associated with the current profile. type: boolean registrationCardNo: description: Unique identifier of the police registration card number. type: string minLength: 0 maxLength: 40 nameType: $ref: '#/components/schemas/nameTypeType' id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 40 billingPrivilegesType: type: object description: This stores the information for Bed Tax Reporting. Mainly used in Maldives. properties: postingRestriction: description: Flag used by interface program during check in. type: boolean preStayCharging: description: Indicates if the reservation has charging privileges before arrival. type: boolean postStayCharging: description: Indicates if the reservation has charging privileges after checkout. type: boolean folioCloseDate: description: Date when folio was closed. This works with PostStayCharging flag. type: string format: date maxLength: 8 scheduledCheckout: description: Indicates if the guest is scheduled for automatic check out. type: boolean scheduledCheckoutTime: description: Time of automatic check out if guest is schedule for automatic check out. type: string format: date maxLength: 8 directBillAuthorized: description: If Direct bill is authorized this will hold User ID who authorized it. type: boolean videoCheckout: description: Indicates if the guest can do video checkout type: boolean allowAutoCheckin: description: Indicated if a new reservation should be created and automatically checked in whenever the room is checked out. Available for pseudo room types only. type: boolean autoSettlement: description: Indicates if the is a candidate for auto folio settlement. type: boolean autoSettlementType: description: The folio settlement type for auto folio settlement. type: string minLength: 0 maxLength: 40 autoSettlementFreq: description: The interval of days between each auto folio settlement. type: integer creditLimitAutoPay: description: Indicates if the reservation will be included in the Automatic Credit Limit Overages process and also be listed in the Credit Limit Overages screen results. type: boolean reservationFolioWindowType: type: object description: Folio window view which holds the set of folios for a reservation. properties: payeeInfo: description: The window's configured payee information. $ref: '#/components/schemas/payeeInfoType' balance: description: Running balance of the window. $ref: '#/components/schemas/currencyAmountType' paymentMethod: description: Payment Method Type type: string minLength: 0 maxLength: 20 folioWindowNo: type: integer reservationBlockType: type: object description: Key information about the block for a reservation. properties: blockIdList: description: Collection of unique block identifiers for the reservation. $ref: '#/components/schemas/blockIdList' blockName: description: The Name of the block that is attached to the reservation. type: string minLength: 0 maxLength: 40 hotelId: description: This is the HotelCode of the Block. type: string minLength: 0 maxLength: 20 reservationTaxTypeInfo: type: object description: Provides information about the Tax Type. properties: hotelId: description: Code of the Hotel. type: string minLength: 0 maxLength: 20 code: description: Code of the Tax Type. type: string minLength: 0 maxLength: 20 description: description: Description of the Tax Type. type: string minLength: 0 maxLength: 2000 collectingAgentTax: description: A boolean flag for Collecting Agent Tax type: boolean printAutoAdjust: description: Print auto adjust information for this tax type on the tax exempt report. type: boolean reportExemptDays: description: Number of days after which the guest will be tax exempt. Only used for tax exempt report. type: integer reportTaxPercentage: description: Tax percentage. Only used for tax exempt report. type: number minimum: 0 maximum: 100 minimumLengthOfStay: description: Minimun Length of Stay. type: integer taxExemptNo: description: Tax exempt number on the profile. type: string minLength: 0 maxLength: 20 employeeInfoType: type: object properties: personName: $ref: '#/components/schemas/personNameType' profileId: $ref: '#/components/schemas/uniqueID_Type' addressInfo: $ref: '#/components/schemas/addressInfoType' emailInfo: $ref: '#/components/schemas/emailInfoType' phoneInfo: $ref: '#/components/schemas/telephoneInfoType' department: $ref: '#/components/schemas/codeDescriptionType' gender: description: Identifies the profile gender code selected from Gender types List of values. Gender types LOV provides the values configured at gender configuration. type: string minLength: 0 maxLength: 20 birthDate: description: Indicates the date of birth as indicated in the document, in ISO 8601 prescribed format. type: string format: date maxLength: 8 birthDateMasked: description: Indicates the date of birth as masked. type: string profileId: type: object description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). properties: url: description: URL that identifies the location associated with the record identified by the UniqueID. type: string type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 20 instance: description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated. type: string minLength: 0 maxLength: 80 idContext: description: Used to identify the source of the identifier (e.g., IATA, ABTA). type: string minLength: 0 maxLength: 80 id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 idExtension: description: Additional identifying value assigned by the creating system. type: integer reservationId: type: object description: An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number, or a reference to a previous availability quote). properties: url: description: URL that identifies the location associated with the record identified by the UniqueID. type: string type: description: A reference to the type of object defined by the UniqueID element. type: string minLength: 0 maxLength: 20 instance: description: The identification of a record as it exists at a point in time. An instance is used in update messages where the sender must assure the server that the update sent refers to the most recent modification level of the object being updated. type: string minLength: 0 maxLength: 80 idContext: description: Used to identify the source of the identifier (e.g., IATA, ABTA). type: string minLength: 0 maxLength: 80 id: description: A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation. type: string minLength: 0 maxLength: 80 idExtension: description: Additional identifying value assigned by the creating system. type: integer anonymizationStatusType: type: string description: Guest has been anonymized. enum: - Requested - Anonymized profileIdList: type: array description: Unique Id that references an object uniquely in the system. maxItems: 4000 items: $ref: '#/components/schemas/uniqueID_Type' childAgeType: type: object description: Defines Child's Age. properties: age: description: Age of a child in years. type: integer servicingAttendantStatusType: type: string description: Possible values for the Status of a Servicing Attendant. enum: - Standby - Break - Working - Completed statUnitCategoryType: type: string description: Supported statistical units. enum: - Numeric - Amount stayDateInfoType: type: object description: Room attached with stay detail information properties: timeSpan: $ref: '#/components/schemas/timeSpanType' expectedTimes: $ref: '#/components/schemas/resExpectedTimesType' parameterType: type: object description: 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. properties: parameterName: description: Name of the parameter. type: string parameterValue: description: Value of the parameter. type: string reservationInterfaceStatusType: type: object description: Hotel Interface Type for a reservation and status of the various services properties: roomExtension: description: Identifier for the room extension type: string minLength: 0 maxLength: 20 hotelInterface: description: Hotel interface information for the reservation $ref: '#/components/schemas/hotelInterfaceType' interfaceRights: description: Contains a list of status/rights for the various services under this interface type: array maxItems: 4000 items: $ref: '#/components/schemas/interfaceRightsStatusType' reservationAllowedActionType: type: string description: Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation. enum: - Cancel - Move - PreCharge - PostCharge - FacilitySchedule - Upsell - PreCheckIn - PostToNoShowCancel - NoShow - NameChange - Discount - HouseKeeping - EnrollToPrimaryMembership - EnrollInProgress externalReferenceType: type: object description: This type contains unique information of external reference. properties: id: description: Unique ID of external reference. type: string minLength: 0 maxLength: 80 idExtension: description: ID extension for external reference. type: integer idContext: description: ID context for external reference. type: string minLength: 0 maxLength: 80 links: type: array items: $ref: '#/components/schemas/instanceLink' operaVersion: type: object description: Response for Ping operation. properties: operaVersion: description: Opera version number. $ref: '#/components/schemas/operaVersionNumberType' links: $ref: '#/components/schemas/links' warnings: $ref: '#/components/schemas/warningsType' addressSearchType: type: object description: Address Details such as city, state, country, postal code etc. properties: cityName: description: City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address). type: string minLength: 0 maxLength: 40 postalCode: description: Post Office Code number. type: string minLength: 0 maxLength: 15 state: description: State or Province name (e.g., Texas). type: string minLength: 0 maxLength: 20 country: description: Country name (e.g., Ireland). $ref: '#/components/schemas/countryNameType' streetAddress: description: First Line of Street Address. For profile search it matches the first Address line. type: string minLength: 0 maxLength: 80 excludeNoCity: description: When true indicates that only profiles with city will be fetched. type: boolean authorizationRuleType: type: object description: Configured rule for computing the amount to authorize. properties: code: description: The authorization rule code. type: integer pattern: '[0-9]{1,9}' amount: description: The amount applicable to the authorization rule. $ref: '#/components/schemas/currencyAmountType' percent: description: A percentage value if the authorization rule is percentage based. type: number commissionPayoutToType: type: string enum: - TravelAgent - Source - TravelAgentSource - None hotelInterfaceTypeType: type: string enum: - Bms - Cas - Ccw - Dls - Eft - Exp - Mak - Mbs - Msc - Pbx - Pos - Svs - Tik - Vid - Vms - Www - Xml description: XML Posting Interface housekeepingType: type: object description: Identifies the Housekeeping information. properties: roomStatus: description: The Room status information per the reservation and housekeeping. $ref: '#/components/schemas/roomStatusType' roomPersons: description: The Room person information per the reservation and housekeeping. $ref: '#/components/schemas/roomPersonsType' guestServiceRequest: $ref: '#/components/schemas/guestHousekeepingServiceRequestType' cleaningPriority: description: Cleaning priority for the room, if a priority was set. $ref: '#/components/schemas/roomCleaningPriorityType' roomCondition: description: Condition of the room, if a condition was set. $ref: '#/components/schemas/roomConditionType' linenChange: description: Indicates if a linen change is necessary. type: boolean facilityTaskCode: description: Facility task Code/ Task Code assigned to the room for the day. $ref: '#/components/schemas/codeListType' turndownStatusType: type: string description: Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Completed. enum: - Required - NotRequired - Compeleted responses: '406': description: Not acceptable. '414': description: Request URI Too Large '503': description: Service Unavailable '413': description: Request Entity Too Large '500': description: System Error content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '502': description: Bad Gateway '403': description: Forbidden '405': description: Method not allowed '415': description: Unsupported Media Type '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/exceptionDetailType' '401': description: Unauthorized parameters: x-hotelid: name: x-hotelid description: Mandatory parameter to identify the hotel code where the end user is logged in in: header required: true schema: type: string authKey: name: authorization description: Bearer token that needs to be passed which is generated post user authentication in: header required: true schema: type: string externalData: name: externalData description: Pass this header as true, if payload needs DVM in: header schema: type: string Accept-Language: name: Accept-Language description: Language code in: header schema: type: string x-app-key: name: x-app-key description: Client or Partner's Application Key in: header required: true schema: type: string pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}$ x-externalsystem: name: x-externalsystem description: External system code. in: header x-example: EXTERNALSYSTEMCODE schema: type: string maxLength: 40 x-originating-application: name: x-originating-application description: Customer's Integration Application Id in: header schema: type: string x-request-id: name: x-request-id description: Request Id of an incoming request in: header schema: type: string pattern: ~*[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} externalDocs: description: Find out more about Oracle Hospitality url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html