fof: OPERA Cloud Front Desk Operations Service
91 operations from Oracle’s published OHIP specifications (26.3.0.0). Each shows its HTTP method and path and the typed call on ctx.Ohip.Api. hotelId defaults to the invocation’s hotel.
addReservationToQueue
Section titled “addReservationToQueue”Add reservation to queue
PUT /fof/v1/hotels/{hotelId}/queuedReservations/{reservationId} · hotel-scoped
Task<ReservationQueuePriority?> ctx.Ohip.Api.Fof.AddReservationToQueueAsync(string reservationId, QueueReservation body, string? hotelId = null, CancellationToken ct = default)assignRoomsAI
Section titled “assignRoomsAI”AI Assign Rooms
POST /fof/v1/hotels/{hotelId}/reservations/ai/rooms · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.AssignRoomsAIAsync(RoomsAI body, string? hotelId = null, CancellationToken ct = default)associateCommissionAgentToReservations
Section titled “associateCommissionAgentToReservations”Operation to associate commission agent to reservations.
PUT /fof/v1/hotels/{hotelId}/commissionAgent/{commissionAgentId}/commissions · hotel-scoped
Task<AssociateCommissionAgentToReservationsStatus?> ctx.Ohip.Api.Fof.AssociateCommissionAgentToReservationsAsync(string commissionAgentId, AssociateCommissionAgentToReservations body, string? hotelId = null, CancellationToken ct = default)autoAssignRoom
Section titled “autoAssignRoom”Assign the room automatically
POST /fof/v1/hotels/{hotelId}/reservations/autoRoomAssignments · hotel-scoped
Task<List<AutoRoomAssignType>?> ctx.Ohip.Api.Fof.AutoAssignRoomAsync(AutoAssignRoom body, string? hotelId = null, CancellationToken ct = default)autoUnAssignRoom
Section titled “autoUnAssignRoom”Auto unassign room
DELETE /fof/v1/hotels/{hotelId}/reservations/autoRoomAssignments · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.AutoUnAssignRoomAsync(string? hotelId = null, Action<AutoRoomAssignmentsRequestBuilderDeleteQueryParameters>? query = null, CancellationToken ct = default)calculateCommissions
Section titled “calculateCommissions”Operation to calculate commissions.
PUT /fof/v1/hotels/{hotelId}/commissions · hotel-scoped
Task<CalculateCommissionsStatus?> ctx.Ohip.Api.Fof.CalculateCommissionsAsync(CalculateCommissions body, string? hotelId = null, CancellationToken ct = default)changeCommission
Section titled “changeCommission”Operation to change commission.
PUT /fof/v1/hotels/{hotelId}/commissions/{commissionId} · hotel-scoped
Task<CommissionStatus?> ctx.Ohip.Api.Fof.ChangeCommissionAsync(string commissionId, CommissionToBeChanged body, string? hotelId = null, CancellationToken ct = default)changeCommissionCheck
Section titled “changeCommissionCheck”Operation to change commission check.
PUT /fof/v1/hotels/{hotelId}/bankAccounts/{bankAccountId}/commissionChecks · hotel-scoped
Task<CommissionCheckStatus?> ctx.Ohip.Api.Fof.ChangeCommissionCheckAsync(string bankAccountId, CommissionCheckToBeChanged body, string? hotelId = null, CancellationToken ct = default)changeCommissionPaymentActivityByRange
Section titled “changeCommissionPaymentActivityByRange”Operation to change commission payment activity by range.
PUT /fof/v1/hotels/{hotelId}/bankAccounts/{bankAccountId}/commissionPayments · hotel-scoped
Task<CommissionPaymentActivityByRangeStatus?> ctx.Ohip.Api.Fof.ChangeCommissionPaymentActivityByRangeAsync(string bankAccountId, CommissionPaymentActivityByRangeToBeChanged body, string? hotelId = null, CancellationToken ct = default)deleteAdvanceCheckIn
Section titled “deleteAdvanceCheckIn”Reverse Advance Checkin
DELETE /fof/v1/hotels/{hotelId}/reservations/{reservationId}/advanceCheckIns · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.DeleteAdvanceCheckInAsync(string reservationId, string? hotelId = null, CancellationToken ct = default)deleteAssignRoom
Section titled “deleteAssignRoom”Remove an assigned room
PUT /fof/v1/hotels/{hotelId}/reservations/{reservationId}/rooms · hotel-scoped
Task<UnAssignedRoom?> ctx.Ohip.Api.Fof.DeleteAssignRoomAsync(string reservationId, UnAssignRoomCriteria body, string? hotelId = null, CancellationToken ct = default)deleteCheckin
Section titled “deleteCheckin”Revert a checked-in Reservation
DELETE /fof/v1/hotels/{hotelId}/reservations/{reservationId}/checkIns · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.DeleteCheckinAsync(string reservationId, string? hotelId = null, string[]? backToBackResvList = null, DeleteRoomStatusQueryParameterType? roomStatus = null, string[]? sharersList = null, bool? unassignRoom = null, CancellationToken ct = default)deleteDailyDocket
Section titled “deleteDailyDocket”Delete Daily Docket
DELETE /fof/v1/hotels/{hotelId}/dailyDocket/{docketId} · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.DeleteDailyDocketAsync(string docketId, string? hotelId = null, CancellationToken ct = default)deleteReservationFromQueue
Section titled “deleteReservationFromQueue”Delete reservation from queue
DELETE /fof/v1/hotels/{hotelId}/queuedReservations/{reservationId} · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.DeleteReservationFromQueueAsync(string reservationId, string? hotelId = null, CancellationToken ct = default)deleteRoomKey
Section titled “deleteRoomKey”Delete room key
DELETE /fof/v1/hotels/{hotelId}/reservations/{reservationId}/roomKeys · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.DeleteRoomKeyAsync(string reservationId, string? hotelId = null, CancellationToken ct = default)deleteServiceRequests
Section titled “deleteServiceRequests”Delete Service Requests
DELETE /fof/v1/hotels/{hotelId}/serviceRequests/{serviceRequestId} · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.DeleteServiceRequestsAsync(string serviceRequestId, string? hotelId = null, CancellationToken ct = default)deleteWakeUpCall
Section titled “deleteWakeUpCall”Delete Wake Up Call
DELETE /fof/v1/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.DeleteWakeUpCallAsync(string reservationId, string? hotelId = null, DateTimeOffset?[]? callTime = null, DateTimeOffset?[]? followUpCallTime = null, DateTimeOffset?[]? newCallTime = null, DateTimeOffset?[]? newFollowUpCallTime = null, Date? startDate = null, CancellationToken ct = default)deliverQueueRoomsTextMessage
Section titled “deliverQueueRoomsTextMessage”Deliver Queue rooms text message
PUT /fof/v1/hotels/{hotelId}/reservations/{reservationId}/textMessages/{messageType} · hotel-scoped
Task<QueueRoomsTextMessage?> ctx.Ohip.Api.Fof.DeliverQueueRoomsTextMessageAsync(string reservationId, string messageType, DeliverQueueRoomsTextMessage body, string? hotelId = null, CancellationToken ct = default)discardCommissionChecks
Section titled “discardCommissionChecks”Operation to discard commission checks.
DELETE /fof/v1/hotels/{hotelId}/commissionChecks · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.DiscardCommissionChecksAsync(string? hotelId = null, Action<CommissionChecksRequestBuilderDeleteQueryParameters>? query = null, CancellationToken ct = default)getAiraLastRunStatus
Section titled “getAiraLastRunStatus”Automated Intelligence Room Assignment last run status
GET /fof/v1/hotels/{hotelId}/reservations/ai/rooms · hotel-scoped
Task<AiraLastRunStatusInfo?> ctx.Ohip.Api.Fof.GetAiraLastRunStatusAsync(string? hotelId = null, CancellationToken ct = default)getBankAccounts
Section titled “getBankAccounts”Operation to fetch bank accounts.
GET /fof/v1/hotels/{hotelId}/bankAccounts · hotel-scoped · deprecated
Task<BankAccountsDetails?> ctx.Ohip.Api.Fof.GetBankAccountsAsync(string? hotelId = null, string? bankAccountNo = null, string? bankName = null, string? currency = null, CancellationToken ct = default)getCommission
Section titled “getCommission”Operation to fetch commission.
GET /fof/v1/hotels/{hotelId}/commissions/{commissionId} · hotel-scoped
Task<CommissionDetails?> ctx.Ohip.Api.Fof.GetCommissionAsync(string commissionId, string? hotelId = null, string? idContext = null, int? idExtension = null, string? type = null, CancellationToken ct = default)getCommissionNotes
Section titled “getCommissionNotes”Operation to fetch commission notes.
GET /fof/v1/hotels/{hotelId}/reservations/{reservationId}/commissionNotes · hotel-scoped
Task<CommissionNotesDetails?> ctx.Ohip.Api.Fof.GetCommissionNotesAsync(string reservationId, string? hotelId = null, string? idContext = null, int? idExtension = null, string? type = null, CancellationToken ct = default)getCommissionPaymentDetails
Section titled “getCommissionPaymentDetails”Fetch Commission Payment Details
GET /fof/v1/hotels/{hotelId}/reservations/{reservationId}/commissionPaymentDetails · hotel-scoped
Task<CommissionPaymentDetails?> ctx.Ohip.Api.Fof.GetCommissionPaymentDetailsAsync(string reservationId, string? hotelId = null, CancellationToken ct = default)getCommissionPaymentsActivity
Section titled “getCommissionPaymentsActivity”Operation to fetch commission payments activity.
GET /fof/v1/hotels/{hotelId}/bankAccounts/{bankAccountId}/commissionPayments · hotel-scoped
Task<CommissionPaymentsActivityDetails?> ctx.Ohip.Api.Fof.GetCommissionPaymentsActivityAsync(string bankAccountId, string? hotelId = null, Action<CommissionPaymentsRequestBuilderGetQueryParameters>? query = null, CancellationToken ct = default)getCommissions
Section titled “getCommissions”Operation to fetch commissions. The search results are filtered based on the provided criteria, with a specific hierarchy applied when multiple parameters are specified. The filtering parameters ar…
GET /fof/v1/hotels/{hotelId}/commissions · hotel-scoped
Task<CommissionsDetails?> ctx.Ohip.Api.Fof.GetCommissionsAsync(string? hotelId = null, Action<CommissionsRequestBuilderGetQueryParameters>? query = null, CancellationToken ct = default)getDailyDocket
Section titled “getDailyDocket”Get Daily Docket
GET /fof/v1/hotels/{hotelId}/dailyDocket · hotel-scoped
Task<DailyDocket?> ctx.Ohip.Api.Fof.GetDailyDocketAsync(string? hotelId = null, string? department = null, Date? docketDate = null, CancellationToken ct = default)getFloorPlans
Section titled “getFloorPlans”Get floor plans
GET /fof/v1/hotels/{hotelId}/floorPlans · hotel-scoped
Task<FloorPlans?> ctx.Ohip.Api.Fof.GetFloorPlansAsync(string? hotelId = null, string? room = null, CancellationToken ct = default)getFrontOfficeStatistics
Section titled “getFrontOfficeStatistics”Get front office Statistics
GET /fof/v1/hotels/{hotelId}/frontOfficeStatistics/{statisticsCode} · hotel-scoped
Task<Statistics?> ctx.Ohip.Api.Fof.GetFrontOfficeStatisticsAsync(string statisticsCode, string? hotelId = null, Date? date = null, GetMetricQueryParameterType[]? metric = null, string[]? parameterNames = null, string[]? parameterValues = null, string[]? roomClasses = null, CancellationToken ct = default)getFrontOfficeStatisticsWithDateRange
Section titled “getFrontOfficeStatisticsWithDateRange”Get front office Statistics
GET /fof/v1/hotels/{hotelId}/frontOfficeStatisticsRange/{statisticsCode} · hotel-scoped
Task<Statistics?> ctx.Ohip.Api.Fof.GetFrontOfficeStatisticsWithDateRangeAsync(string statisticsCode, string? hotelId = null, Date? date = null, Date? endDate = null, GetMetricQueryParameterType[]? metric = null, string[]? parameterNames = null, string[]? parameterValues = null, string[]? roomClasses = null, CancellationToken ct = default)getFulfillmentActivityLog
Section titled “getFulfillmentActivityLog”Get the fullfillment activity log
GET /fof/v1/hotels/{hotelId}/fulfillmentActivityLogs · hotel-scoped
Task<ActivityLog?> ctx.Ohip.Api.Fof.GetFulfillmentActivityLogAsync(string? hotelId = null, Action<FulfillmentActivityLogsRequestBuilderGetQueryParameters>? query = null, CancellationToken ct = default)getHotelRooms
Section titled “getHotelRooms”Get hotel rooms
GET /fof/v1/hotels/{hotelId}/rooms · hotel-scoped
Task<HotelRooms?> ctx.Ohip.Api.Fof.GetHotelRoomsAsync(string? hotelId = null, Action<RoomsRequestBuilderGetQueryParameters>? query = null, CancellationToken ct = default)getKeyOptions
Section titled “getKeyOptions”Fetch the keysOptions
GET /fof/v1/hotels/{hotelId}/reservations/{reservationId}/keyOptions · hotel-scoped
Task<KeyOptionsInfo?> ctx.Ohip.Api.Fof.GetKeyOptionsAsync(string reservationId, string? hotelId = null, CancellationToken ct = default)getLinkedReservations
Section titled “getLinkedReservations”Get linked reservations
GET /fof/v1/hotels/{hotelId}/reservations/{reservationId}/linked · hotel-scoped
Task<LinkedReservations?> ctx.Ohip.Api.Fof.GetLinkedReservationsAsync(string reservationId, string? hotelId = null, string[]? additionalReservationId = null, string[]? additionalReservationIdContext = null, string[]? additionalReservationIdType = null, CancellationToken ct = default)getQueueRoomsTextMessage
Section titled “getQueueRoomsTextMessage”Get Queue room text message
GET /fof/v1/hotels/{hotelId}/textMessages/{messageType} · hotel-scoped
Task<QueuedRoomsTextMessage?> ctx.Ohip.Api.Fof.GetQueueRoomsTextMessageAsync(string messageType, string? hotelId = null, string? mobileNumber = null, string? reservationId = null, string? reservationIdContext = null, string? reservationIdType = null, CancellationToken ct = default)getReservationQueueStatistics
Section titled “getReservationQueueStatistics”Get reservation queue statistics
GET /fof/v1/hotels/{hotelId}/queueReservationsStatistics · hotel-scoped
Task<ReservationQueueStatistics?> ctx.Ohip.Api.Fof.GetReservationQueueStatisticsAsync(string? hotelId = null, CancellationToken ct = default)getReservationsForBilling
Section titled “getReservationsForBilling”Get Reservations for billing
GET /fof/v1/hotels/{hotelId}/billingReservations · hotel-scoped
Task<ReservationsInfo?> ctx.Ohip.Api.Fof.GetReservationsForBillingAsync(string? hotelId = null, Action<BillingReservationsRequestBuilderGetQueryParameters>? query = null, CancellationToken ct = default)getReservationsForCommissions
Section titled “getReservationsForCommissions”Operation to fetch Reservations for Commissions associated to a Travel Agent
GET /fof/v1/hotels/{hotelId}/bankAccounts/{bankAccountId}/agents/{agentId}/reservationsForCommissions · hotel-scoped · deprecated
Task<CommissionsDetails?> ctx.Ohip.Api.Fof.GetReservationsForCommissionsAsync(string bankAccountId, string agentId, string? hotelId = null, Action<ReservationsForCommissionsRequestBuilderGetQueryParameters>? query = null, CancellationToken ct = default)getReservationsInQueue
Section titled “getReservationsInQueue”Get the reservation in queue
GET /fof/v1/hotels/{hotelId}/queuedReservations · hotel-scoped
Task<ReservationsInQueue?> ctx.Ohip.Api.Fof.GetReservationsInQueueAsync(string? hotelId = null, string? guestNameWildCard = null, string[]? roomClassCodes = null, string? roomNumberWildCard = null, string[]? roomTypeCodes = null, CancellationToken ct = default)getReservationsKeyOptions
Section titled “getReservationsKeyOptions”Fetch keysOptions for the reservation and the guest profile
GET /fof/v1/hotels/{hotelId}/reservationsKeyOptions · hotel-scoped
Task<KeyOptionsInfoListType?> ctx.Ohip.Api.Fof.GetReservationsKeyOptionsAsync(string? hotelId = null, int? limit = null, int? offset = null, string[]? reservationIdList = null, CancellationToken ct = default)getReservationStatusStatistics
Section titled “getReservationStatusStatistics”Get Reservation Status Statistics
GET /fof/v1/hotels/{hotelId}/reservationStatusStatistics · hotel-scoped
Task<ReservationStatusStatisticsResponseType?> ctx.Ohip.Api.Fof.GetReservationStatusStatisticsAsync(string? hotelId = null, GetReservationStatusQueryParameterType[]? reservationStatus = null, CancellationToken ct = default)getReservationSummaries
Section titled “getReservationSummaries”Get reservation summaries
GET /fof/v1/hotels/{hotelId}/reservationSummaries · hotel-scoped
Task<ShortReservation?> ctx.Ohip.Api.Fof.GetReservationSummariesAsync(string? hotelId = null, Action<ReservationSummariesRequestBuilderGetQueryParameters>? query = null, CancellationToken ct = default)getResvForBatchCCAuth
Section titled “getResvForBatchCCAuth”Get resrvation for batch CCAuth
GET /fof/v1/hotels/{hotelId}/authorizationReservations · hotel-scoped
Task<ResvForBatchCCAut?> ctx.Ohip.Api.Fof.GetResvForBatchCCAuthAsync(string? hotelId = null, Date? arrivalEndDate = null, Date? arrivalStartDate = null, GetCardTypeQueryParameterType[]? cardType = null, string? guestName = null, GetReservationStatusQueryParameterType[]? reservationStatus = null, string? room = null, string[]? userDefinedCardType = null, CancellationToken ct = default)getRoomInterfaceStatus
Section titled “getRoomInterfaceStatus”Get room interface status
GET /fof/v1/hotels/{hotelId}/interfaces/{interfaceId}/roomStatuses · hotel-scoped
Task<RoomInterfaceStatus?> ctx.Ohip.Api.Fof.GetRoomInterfaceStatusAsync(string interfaceId, string? hotelId = null, Action<RoomStatusesRequestBuilderGetQueryParameters>? query = null, CancellationToken ct = default)getRoomKeyInterfaceDetails
Section titled “getRoomKeyInterfaceDetails”Get key encoder interface configuration details
GET /fof/v1/hotels/{hotelId}/keyInterfaces · hotel-scoped
Task<RoomKeyInterfaceDetails?> ctx.Ohip.Api.Fof.GetRoomKeyInterfaceDetailsAsync(string? hotelId = null, string? interfaceId = null, GetOrderByQueryParameterType[]? orderBy = null, string[]? roomNumbersCode = null, GetSortOrderQueryParameterType[]? sortOrder = null, CancellationToken ct = default)getRoomKeys
Section titled “getRoomKeys”Fetch the room keys
GET /fof/v1/hotels/{hotelId}/reservations/{reservationId}/roomKeys · hotel-scoped
Task<RoomKeyInfo?> ctx.Ohip.Api.Fof.GetRoomKeysAsync(string reservationId, string? hotelId = null, bool? includeInactiveRoomKeys = null, string? interfaceId = null, CancellationToken ct = default)getRoomMoveHistory
Section titled “getRoomMoveHistory”Get room move history of a reservation
GET /fof/v1/hotels/{hotelId}/reservations/{reservationId}/roomMoveHistory · hotel-scoped
Task<RoomMoveHistory?> ctx.Ohip.Api.Fof.GetRoomMoveHistoryAsync(string reservationId, string? hotelId = null, string? reservationIdContext = null, string? reservationIdType = null, CancellationToken ct = default)getRoomsByRoomStatus
Section titled “getRoomsByRoomStatus”Get counts of rooms by housekeeping status and front office status.
GET /fof/v1/hotels/{hotelId}/roomStatusStatistics · hotel-scoped
Task<RoomStatusStatisticsListType?> ctx.Ohip.Api.Fof.GetRoomsByRoomStatusAsync(string? hotelId = null, GetFrontOfficeStatusQueryParameterType? frontOfficeStatus = null, CancellationToken ct = default)getServiceRequests
Section titled “getServiceRequests”Get Service Requests
GET /fof/v1/hotels/{hotelId}/serviceRequests · hotel-scoped
Task<ServiceRequestsInfo?> ctx.Ohip.Api.Fof.GetServiceRequestsAsync(string? hotelId = null, Action<ServiceRequestsRequestBuilderGetQueryParameters>? query = null, CancellationToken ct = default)getSuggestedRooms
Section titled “getSuggestedRooms”Get Suggested Rooms
GET /fof/v1/hotels/{hotelId}/reservations/{reservationId}/suggestedRooms · hotel-scoped
Task<SuggestedRooms?> ctx.Ohip.Api.Fof.GetSuggestedRoomsAsync(string reservationId, string? hotelId = null, int? nights = null, string[]? roomFeatureCode = null, string? roomType = null, Date? startDate = null, GetSuggestedRoomsInstructionsQueryParameterType[]? suggestedRoomsInstructions = null, CancellationToken ct = default)getTaskSheetStatistics
Section titled “getTaskSheetStatistics”Get housekeeping statistics
GET /fof/v1/hotels/{hotelId}/houseKeepingStatistics · hotel-scoped
Task<TaskSheetStatistics?> ctx.Ohip.Api.Fof.GetTaskSheetStatisticsAsync(string? hotelId = null, bool? includeAllAssignedTasks = null, bool? includeTaskSheetsDetails = null, string? taskCode = null, CancellationToken ct = default)getTravelAgentsForCommissions
Section titled “getTravelAgentsForCommissions”Operation to fetch Travel Agents associated with commissions for the given bank Account.
GET /fof/v1/hotels/{hotelId}/bankAccounts/{bankAccountId}/travelAgentsForCommissions · hotel-scoped
Task<CommissionsDetails?> ctx.Ohip.Api.Fof.GetTravelAgentsForCommissionsAsync(string bankAccountId, string? hotelId = null, CancellationToken ct = default)getWakeUpCall
Section titled “getWakeUpCall”Get Wake Up Call
GET /fof/v1/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls · hotel-scoped
Task<WakeUpCalls?> ctx.Ohip.Api.Fof.GetWakeUpCallAsync(string reservationId, string? hotelId = null, Action<WakeUpCallsRequestBuilderGetQueryParameters>? query = null, CancellationToken ct = default)getWakeUpCalls
Section titled “getWakeUpCalls”Get Wake Up Calls
GET /fof/v1/hotels/{hotelId}/wakeUpCalls · hotel-scoped · deprecated
Task<WakeUpCalls?> ctx.Ohip.Api.Fof.GetWakeUpCallsAsync(string? hotelId = null, Action<WakeUpCallsRequestBuilderGetQueryParameters>? query = null, CancellationToken ct = default)moveInHouseGuest
Section titled “moveInHouseGuest”Move in-house guest
PUT /fof/v1/hotels/{hotelId}/reservations/{reservationId}/rooms/{roomId}/roomMoves · hotel-scoped
Task<MovedInHouseGuest?> ctx.Ohip.Api.Fof.MoveInHouseGuestAsync(string reservationId, string roomId, MoveInHouseGuest body, string? hotelId = null, CancellationToken ct = default)pingCommissionsService
Section titled “pingCommissionsService”Ping Commissions
GET /fof/v1/services/commissions/status · chain-level
Task<OperaVersion?> ctx.Ohip.Api.Fof.PingCommissionsServiceAsync(CancellationToken ct = default)pingFOFStatsService
Section titled “pingFOFStatsService”Ping FOF
GET /fof/v1/services/fofStats/status · chain-level
Task<OperaVersion?> ctx.Ohip.Api.Fof.PingFOFStatsServiceAsync(CancellationToken ct = default)pingFrontDeskOperationsService
Section titled “pingFrontDeskOperationsService”Ping Front Desk Service
GET /fof/v1/services/frontDeskOperations/status · chain-level
Task<OperaVersion?> ctx.Ohip.Api.Fof.PingFrontDeskOperationsServiceAsync(CancellationToken ct = default)placeRoomsOnHold
Section titled “placeRoomsOnHold”Place Rooms On Hold
POST /fof/v1/hotels/{hotelId}/rooms/onHold · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.PlaceRoomsOnHoldAsync(HoldRooms body, string? hotelId = null, CancellationToken ct = default)postAdvanceCheckIn
Section titled “postAdvanceCheckIn”Advance checkin a reservation
POST /fof/v1/hotels/{hotelId}/reservations/{reservationId}/advanceCheckIns · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.PostAdvanceCheckInAsync(string reservationId, AdvanceCheckInReservation body, string? hotelId = null, CancellationToken ct = default)postCheckIn
Section titled “postCheckIn”Checks in a guest
POST /fof/v1/hotels/{hotelId}/reservations/{reservationId}/checkIns · hotel-scoped
Task<CheckedinReservation?> ctx.Ohip.Api.Fof.PostCheckInAsync(string reservationId, Reservation body, string? hotelId = null, CancellationToken ct = default)postDailyDocket
Section titled “postDailyDocket”Create Daily Docket
POST /fof/v1/hotels/{hotelId}/dailyDocket · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.PostDailyDocketAsync(DailyDocket body, string? hotelId = null, CancellationToken ct = default)postExternalRoomKeys
Section titled “postExternalRoomKeys”Requests room key(s)
POST /fof/v1/hotels/{hotelId}/externalRoomKeys · hotel-scoped · deprecated
Task<RoomKeyExternalDetails?> ctx.Ohip.Api.Fof.PostExternalRoomKeysAsync(RoomKeyExternal body, string? hotelId = null, CancellationToken ct = default)postMassAdvanceCheckIn
Section titled “postMassAdvanceCheckIn”Mass Advance Check in Reservations
POST /fof/v1/hotels/{hotelId}/reservations/massAdvanceCheckIns · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.PostMassAdvanceCheckInAsync(MassAdvanceCheckInReservations body, string? hotelId = null, CancellationToken ct = default)postMassCheckIn
Section titled “postMassCheckIn”Mass checkin reservations
POST /fof/v1/hotels/{hotelId}/reservations/massCheckIns · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.PostMassCheckInAsync(MassCheckInReservations body, string? hotelId = null, CancellationToken ct = default)postRoomAssignment
Section titled “postRoomAssignment”Assign a Room to a Reservation
POST /fof/v1/hotels/{hotelId}/reservations/{reservationId}/roomAssignments · hotel-scoped
Task<AssignedRoom?> ctx.Ohip.Api.Fof.PostRoomAssignmentAsync(string reservationId, Room body, string? hotelId = null, CancellationToken ct = default)postRoomKey
Section titled “postRoomKey”Requests room key(s)
POST /fof/v1/hotels/{hotelId}/reservations/{reservationId}/roomKeys · hotel-scoped
Task<RoomKeyDetails?> ctx.Ohip.Api.Fof.PostRoomKeyAsync(string reservationId, RoomKey body, string? hotelId = null, CancellationToken ct = default)postRoomKeysExternal
Section titled “postRoomKeysExternal”Requests room key(s)
POST /fof/v1/hotels/{hotelId}/roomKeysExternal · hotel-scoped
Task<RoomKeysExternalDetails?> ctx.Ohip.Api.Fof.PostRoomKeysExternalAsync(RoomKeysExternal body, string? hotelId = null, CancellationToken ct = default)postServiceRequests
Section titled “postServiceRequests”Create Service Requests
POST /fof/v1/hotels/{hotelId}/serviceRequests · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.PostServiceRequestsAsync(ServiceRequestsInfo body, string? hotelId = null, CancellationToken ct = default)postWakeUpCall
Section titled “postWakeUpCall”Create Wake Up Call
POST /fof/v1/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.PostWakeUpCallAsync(string reservationId, WakeUpCalls body, string? hotelId = null, CancellationToken ct = default)processBatchCCAuth
Section titled “processBatchCCAuth”Process batch CC Auth
PUT /fof/v1/hotels/{hotelId}/batchReservationAuthorizations · hotel-scoped
Task<BatchCCAuthToProcess?> ctx.Ohip.Api.Fof.ProcessBatchCCAuthAsync(BatchCCAuth body, string? hotelId = null, CancellationToken ct = default)processCommissionPayments
Section titled “processCommissionPayments”Operation to process commission payments.
PUT /fof/v1/hotels/{hotelId}/commissionPayments · hotel-scoped
Task<ProcessCommissionPaymentsStatus?> ctx.Ohip.Api.Fof.ProcessCommissionPaymentsAsync(ProcessCommissionPayments body, string? hotelId = null, CancellationToken ct = default)putDailyDocket
Section titled “putDailyDocket”Change Daily Docket
PUT /fof/v1/hotels/{hotelId}/dailyDocket · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.PutDailyDocketAsync(DailyDocket body, string? hotelId = null, CancellationToken ct = default)putReservationQueuePriority
Section titled “putReservationQueuePriority”Change the reservation queue priority
PUT /fof/v1/hotels/{hotelId}/reservations/{reservationId}/priority · hotel-scoped
Task<ReservationQueuePriority?> ctx.Ohip.Api.Fof.PutReservationQueuePriorityAsync(string reservationId, ReservationQueuePriorityNumber body, string? hotelId = null, CancellationToken ct = default)putRoomInterfaceStatus
Section titled “putRoomInterfaceStatus”Change room interface status
PUT /fof/v1/hotels/{hotelId}/interfaces/{interfaceId}/roomStatuses · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.PutRoomInterfaceStatusAsync(string interfaceId, ReservationInterface body, string? hotelId = null, CancellationToken ct = default)putRoomKeys
Section titled “putRoomKeys”Update room keys.
PUT /fof/v1/hotels/{hotelId}/reservations/{reservationId}/roomKeys · hotel-scoped
Task<UpdateRoomKeys?> ctx.Ohip.Api.Fof.PutRoomKeysAsync(string reservationId, RoomKeyMultipleGuests body, string? hotelId = null, CancellationToken ct = default)putServiceRequests
Section titled “putServiceRequests”Change Service Requests
PUT /fof/v1/hotels/{hotelId}/serviceRequests · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.PutServiceRequestsAsync(ServiceRequestsInfo body, string? hotelId = null, CancellationToken ct = default)putWakeUpCall
Section titled “putWakeUpCall”Change Wake Up Call
PUT /fof/v1/hotels/{hotelId}/reservations/{reservationId}/wakeUpCalls · hotel-scoped
Task<ChangedWakeUpCalls?> ctx.Ohip.Api.Fof.PutWakeUpCallAsync(string reservationId, WakeUpCalls body, string? hotelId = null, CancellationToken ct = default)readRoomKey
Section titled “readRoomKey”Read room key
GET /fof/v1/hotels/{hotelId}/roomKeysDetails · hotel-scoped
Task<RoomKeyStatus?> ctx.Ohip.Api.Fof.ReadRoomKeyAsync(string? hotelId = null, string? encoderId = null, string? encoderIdContext = null, string? encoderIdType = null, string? encoderTerminal = null, string? interfaceId = null, CancellationToken ct = default)recalculateCommissionOnCodeChange
Section titled “recalculateCommissionOnCodeChange”Operation to recalculate commission on code change.
PUT /fof/v1/hotels/{hotelId}/commissions/{commissionId}/commissionCodes/{commissionCode}/recalculate · hotel-scoped
Task<RecalculateCommissionOnCodeChangeStatus?> ctx.Ohip.Api.Fof.RecalculateCommissionOnCodeChangeAsync(string commissionId, string commissionCode, RecalculateCommissionOnCodeChange body, string? hotelId = null, CancellationToken ct = default)releaseRoomsOnHold
Section titled “releaseRoomsOnHold”Release Rooms On Hold
POST /fof/v1/hotels/{hotelId}/rooms/onHold/release · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.ReleaseRoomsOnHoldAsync(HoldRooms body, string? hotelId = null, CancellationToken ct = default)removeCommission
Section titled “removeCommission”Operation to remove commission.
DELETE /fof/v1/hotels/{hotelId}/commissions/{commissionId} · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.RemoveCommissionAsync(string commissionId, string? hotelId = null, string? detachDescription = null, string? idContext = null, int? idExtension = null, string? type = null, CancellationToken ct = default)removeCommissionAgentFromReservations
Section titled “removeCommissionAgentFromReservations”Operation to remove commission agent from reservations.
DELETE /fof/v1/hotels/{hotelId}/commissionAgent/{commissionAgentId}/commissions · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.RemoveCommissionAgentFromReservationsAsync(string commissionAgentId, string? hotelId = null, DeleteCommissionAgentTypeQueryParameterType? commissionAgentType = null, string? idContext = null, int? idExtension = null, string[]? reservationId = null, string[]? reservationIdIdContext = null, int?[]? reservationIdIdExtension = null, string[]? reservationIdType = null, string? type = null, CancellationToken ct = default)reprintCommissionCheckByRange
Section titled “reprintCommissionCheckByRange”Operation to reprint commission check by range.
PUT /fof/v1/hotels/{hotelId}/bankAccounts/{bankAccountId}/reprintCommission · hotel-scoped
Task<ReprintCommissionCheckByRangeStatus?> ctx.Ohip.Api.Fof.ReprintCommissionCheckByRangeAsync(string bankAccountId, ReprintCommissionCheckByRange body, string? hotelId = null, CancellationToken ct = default)searchBankAccounts
Section titled “searchBankAccounts”Operation to fetch bank accounts.
POST /fof/v1/hotels/{hotelId}/bankAccounts/searches · hotel-scoped
Task<BankAccountsDetails?> ctx.Ohip.Api.Fof.SearchBankAccountsAsync(SearchBankAccountsRequest body, string? hotelId = null, CancellationToken ct = default)searchReservationsForCommissions
Section titled “searchReservationsForCommissions”Operation to fetch Reservations for Commissions associated to a Travel Agent
POST /fof/v1/hotels/{hotelId}/bankAccounts/{bankAccountId}/agents/{agentId}/reservationsForCommissions/searches · hotel-scoped
Task<CommissionsDetails?> ctx.Ohip.Api.Fof.SearchReservationsForCommissionsAsync(string bankAccountId, string agentId, SearchReservationsForCommissionsRequest body, string? hotelId = null, CancellationToken ct = default)searchWakeUpCalls
Section titled “searchWakeUpCalls”Get Wake Up Calls
POST /fof/v1/hotels/{hotelId}/wakeUpCalls/searches · hotel-scoped
Task<WakeUpCalls?> ctx.Ohip.Api.Fof.SearchWakeUpCallsAsync(SearchWakeUpCallsRequest body, string? hotelId = null, CancellationToken ct = default)setProcessingInstructions
Section titled “setProcessingInstructions”Operation to set processing instructions.
POST /fof/v1/hotels/{hotelId}/commissions/instructions · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.SetProcessingInstructionsAsync(SetProcessingInstructions body, string? hotelId = null, CancellationToken ct = default)shiftRooms
Section titled “shiftRooms”Operation for Shift Rooms between two reservations
PUT /fof/v1/hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/shiftRooms · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.ShiftRoomsAsync(string sourceReservationId, string targetReservationId, ShiftRooms body, string? hotelId = null, bool? overrideBackToBackRoomSkip = null, CancellationToken ct = default)swapRooms
Section titled “swapRooms”Operation for Swap/Shift Rooms between two reservations
PUT /fof/v1/hotels/{hotelId}/sourceReservations/{sourceReservationId}/targetReservations/{targetReservationId}/swapRooms · hotel-scoped
Task<Status?> ctx.Ohip.Api.Fof.SwapRoomsAsync(string sourceReservationId, string targetReservationId, SwapRooms body, string? hotelId = null, bool? overrideBackToBackRoomSkip = null, CancellationToken ct = default)verifyCheckinReservation
Section titled “verifyCheckinReservation”Verify checkin reservation
GET /fof/v1/hotels/{hotelId}/reservations/{reservationId}/verifyCheckIns · hotel-scoped
Task<VerifiedCheckinReservation?> ctx.Ohip.Api.Fof.VerifyCheckinReservationAsync(string reservationId, string? hotelId = null, GetVerifyCheckinInstructionsQueryParameterType[]? verifyCheckinInstructions = null, CancellationToken ct = default)