Skip to content

blkasync: OPERA Cloud Block Reservation Asynchronous API

23 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.

This API returns information about the set allocation ranges process.

GET /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/allocationRanges/{requestId} · hotel-scoped · asynchronous

Task<ProcessDetails?> ctx.Ohip.Api.Blkasync.GetAllocationRangesProcessInfoAsync(string blockId, string requestId, string? hotelId = null, CancellationToken ct = default)

This API returns the status of asynchronous process scheduled for given id.

HEAD /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/allocationRanges/{requestId} · hotel-scoped · asynchronous

Task ctx.Ohip.Api.Blkasync.GetAllocationRangesProcessStatusAsync(string blockId, string requestId, string? hotelId = null, CancellationToken ct = default)

This API returns information about the set allocation process.

GET /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/allocation/{requestId} · hotel-scoped · asynchronous

Task<ProcessDetails?> ctx.Ohip.Api.Blkasync.GetBlockAllocationProcessInfoAsync(string blockId, string requestId, string? hotelId = null, CancellationToken ct = default)

This API returns the status of asynchronous process scheduled for given id.

HEAD /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/allocation/{requestId} · hotel-scoped · asynchronous

Task ctx.Ohip.Api.Blkasync.GetBlockAllocationProcessStatusAsync(string blockId, string requestId, string? hotelId = null, CancellationToken ct = default)

This API returns a hotel’s block allocation summary for a scheduled process.

GET /blk/async/v1/externalSystems/{extSystemCode}/hotels/{hotelId}/blocks/allocationSummary/{requestId} · hotel-scoped · asynchronous

Task<List<BlockAllocationSummaryType>?> ctx.Ohip.Api.Blkasync.GetBlockAllocationSummaryAsync(string extSystemCode, string requestId, string? hotelId = null, CancellationToken ct = default)

This API returns the status of asynchronous process scheduled for given id.

HEAD /blk/async/v1/externalSystems/{extSystemCode}/hotels/{hotelId}/blocks/allocationSummary/{requestId} · hotel-scoped · asynchronous

Task ctx.Ohip.Api.Blkasync.GetBlockAllocationSummaryProcessStatusAsync(string extSystemCode, string requestId, string? hotelId = null, CancellationToken ct = default)

This API returns results of the asynchronous Apply Changes To process.

GET /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/applyChangesTo/{requestId} · hotel-scoped · asynchronous

Task<ChangedBlockReservations?> ctx.Ohip.Api.Blkasync.GetBlockApplyChangesToProcessResultsAsync(string blockId, string requestId, string? hotelId = null, CancellationToken ct = default)

The API returns information about the block retrieval request.

GET /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/async/{requestId} · hotel-scoped · asynchronous

Task<Block?> ctx.Ohip.Api.Blkasync.GetFetchBlockProcessAsync(string blockId, string requestId, string? hotelId = null, CancellationToken ct = default)

This API returns information about the recalculate room forecast rates process.

GET /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/recalculateRoomForecast/{requestId} · hotel-scoped · asynchronous

Task<ProcessDetails?> ctx.Ohip.Api.Blkasync.GetRecalculateRoomForecastProcessInfoAsync(string blockId, string requestId, string? hotelId = null, CancellationToken ct = default)

This API returns the status of asynchronous process scheduled for given id.

HEAD /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/recalculateRoomForecast/{requestId} · hotel-scoped · asynchronous

Task ctx.Ohip.Api.Blkasync.GetRecalculateRoomForecastProcessStatusAsync(string blockId, string requestId, string? hotelId = null, CancellationToken ct = default)

This API returns information about the Business Block projected revenues refresh process.

GET /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/refreshProjectedRevenues/{requestId} · hotel-scoped · asynchronous

Task<ProcessDetails?> ctx.Ohip.Api.Blkasync.GetRefreshProjectedRevenuesProcessInfoAsync(string blockId, string requestId, string? hotelId = null, CancellationToken ct = default)

This API returns the status of asynchronous process scheduled for given id.

HEAD /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/refreshProjectedRevenues/{requestId} · hotel-scoped · asynchronous

Task ctx.Ohip.Api.Blkasync.GetRefreshProjectedRevenuesProcessStatusAsync(string blockId, string requestId, string? hotelId = null, CancellationToken ct = default)

This API returns information about the shift block process.

GET /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/shift/{requestId} · hotel-scoped · asynchronous

Task<ProcessDetails?> ctx.Ohip.Api.Blkasync.GetShiftBlockProcessInfoAsync(string blockId, string requestId, string? hotelId = null, CancellationToken ct = default)

This API returns the status of asynchronous process scheduled for given id.

HEAD /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/shift/{requestId} · hotel-scoped · asynchronous

Task ctx.Ohip.Api.Blkasync.GetShiftBlockProcessStatusAsync(string blockId, string requestId, string? hotelId = null, CancellationToken ct = default)

This API returns the status of asynchronous process scheduled for given id.

HEAD /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/async/{requestId} · hotel-scoped · asynchronous

Task ctx.Ohip.Api.Blkasync.HeadFetchBlockProcessStatusAsync(string blockId, string requestId, string? hotelId = null, CancellationToken ct = default)

Use this API to retrieve a Block by ID using an asynchronous process.

POST /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/async · hotel-scoped · asynchronous

Task<Block?> ctx.Ohip.Api.Blkasync.PostStartFetchBlockProcessAsync(string blockId, string? hotelId = null, bool? fetchAllocatedRoomTypes = null, PostFetchInstructionsQueryParameterType[]? fetchInstructions = null, bool? fetchRoomTypesWithInventory = null, bool? markAsRecentlyAccessed = null, double? numberOfDays = null, PostRoomAllocationCriteriaQueryParameterType[]? roomAllocationCriteria = null, string[]? roomTypes = null, Date? startDate = null, CancellationToken ct = default)

This API facilitates setting Block Allocation Ranges for a Hotel.

POST /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/allocationRanges · hotel-scoped · asynchronous

Task<ProcessDetails?> ctx.Ohip.Api.Blkasync.StartAllocationRangesProcessAsync(string blockId, AllocationRanges body, string? hotelId = null, CancellationToken ct = default)

This API facilitates setting Block Allocations for a Hotel.

POST /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/allocation · hotel-scoped · asynchronous

Task<ProcessDetails?> ctx.Ohip.Api.Blkasync.StartBlockAllocationProcessAsync(string blockId, Allocation body, string? hotelId = null, CancellationToken ct = default)

This API facilitates fetching block allocation summary for a Hotel.

POST /blk/async/v1/externalSystems/{extSystemCode}/hotels/{hotelId}/blocks/allocationSummary · hotel-scoped · asynchronous

Task<UntypedNode?> ctx.Ohip.Api.Blkasync.StartBlockAllocationSummaryProcessAsync(string extSystemCode, Criteria body, string? hotelId = null, CancellationToken ct = default)

This API facilitates the Apply Changes To process for block reservations asynchronously.

POST /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/applyChangesTo · hotel-scoped · asynchronous

Task<ChangedBlockReservations?> ctx.Ohip.Api.Blkasync.StartBlockApplyChangesToProcessAsync(string blockId, BlockReservationsToChange body, string? hotelId = null, CancellationToken ct = default)

This API facilitates setting recalculation for forecast room rates in a business block.

POST /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/recalculateRoomForecast · hotel-scoped · asynchronous

Task<ProcessDetails?> ctx.Ohip.Api.Blkasync.StartRecalculateRoomForecastProcessAsync(string blockId, BlockId body, string? hotelId = null, CancellationToken ct = default)

This API facilitates refreshing projected revenues for a business block.

POST /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/refreshProjectedRevenues · hotel-scoped · asynchronous

Task<ProcessDetails?> ctx.Ohip.Api.Blkasync.StartRefreshProjectedRevenuesProcessAsync(string blockId, BlockId body, string? hotelId = null, CancellationToken ct = default)

Shifts the Block start date.

POST /blk/async/v1/hotels/{hotelId}/blocks/{blockId}/shift · hotel-scoped · asynchronous

Task<ProcessDetails?> ctx.Ohip.Api.Blkasync.StartShiftBlockProcessAsync(string blockId, BlockToShift body, string? hotelId = null, CancellationToken ct = default)