Oracle Hospitality Block Async API
The Block Async Service Web Service provides capability to implement block related asynchronous operations in OPERA Cloud.
Oracle Hospitality Block Async API is one of 154 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include BlockAsync. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 21 operations across 14 paths, and defines 200 schemas. It is described by OpenAPI 3.2.0, at version 26.2.0.0.
Requests are made against a single base URL, /blk/async/v1.
21 operations
14 paths
200 schemas
7 GET7 HEAD7 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 21
Across 14 paths, the API surfaces 21 operations — 7 GET, 7 HEAD, 7 POST. Each is listed below with its method, path, parameters, and response codes.
BlockAsync 21
The Block Async Service Web Service provides capability to implement block related asynchronous operations in OPERA Cloud.
POST
/externalSystems/{extSystemCode}/hotels/{hotelId}/blocks/allocationSummary
This API facilitates fetching block allocation summary for a Hotel.
HEAD
/externalSystems/{extSystemCode}/hotels/{hotelId}/blocks/allocationSummary/{requestId}
This API returns the status of asynchronous process scheduled for given id.
GET
/externalSystems/{extSystemCode}/hotels/{hotelId}/blocks/allocationSummary/{requestId}
This API returns a hotel's block allocation summary for a scheduled process.
POST
/hotels/{hotelId}/blocks/{blockId}/allocation
This API facilitates setting Block Allocations for a Hotel.
HEAD
/hotels/{hotelId}/blocks/{blockId}/allocation/{requestId}
This API returns the status of asynchronous process scheduled for given id.
GET
/hotels/{hotelId}/blocks/{blockId}/allocation/{requestId}
This API returns information about the set allocation process.
POST
/hotels/{hotelId}/blocks/{blockId}/allocationRanges
This API facilitates setting Block Allocation Ranges for a Hotel.
HEAD
/hotels/{hotelId}/blocks/{blockId}/allocationRanges/{requestId}
This API returns the status of asynchronous process scheduled for given id.
GET
/hotels/{hotelId}/blocks/{blockId}/allocationRanges/{requestId}
This API returns information about the set allocation ranges process.
POST
/hotels/{hotelId}/blocks/{blockId}/shift
Shifts the Block start date.
HEAD
/hotels/{hotelId}/blocks/{blockId}/shift/{requestId}
This API returns the status of asynchronous process scheduled for given id.
GET
/hotels/{hotelId}/blocks/{blockId}/shift/{requestId}
This API returns information about the shift block process.
POST
/hotels/{hotelId}/blocks/{blockId}/recalculateRoomForecast
This API facilitates setting recalculation for forecast room rates in a business block.
HEAD
/hotels/{hotelId}/blocks/{blockId}/recalculateRoomForecast/{requestId}
This API returns the status of asynchronous process scheduled for given id.
GET
/hotels/{hotelId}/blocks/{blockId}/recalculateRoomForecast/{requestId}
This API returns information about the recalculate room forecast rates process.
POST
/hotels/{hotelId}/blocks/{blockId}/refreshProjectedRevenues
This API facilitates refreshing projected revenues for a business block.
HEAD
/hotels/{hotelId}/blocks/{blockId}/refreshProjectedRevenues/{requestId}
This API returns the status of asynchronous process scheduled for given id.
GET
/hotels/{hotelId}/blocks/{blockId}/refreshProjectedRevenues/{requestId}
This API returns information about the Business Block projected revenues refresh process.
POST
/hotels/{hotelId}/blocks/{blockId}/async
Use this API to retrieve a Block by ID using an asynchronous process.
HEAD
/hotels/{hotelId}/blocks/{blockId}/async/{requestId}
This API returns the status of asynchronous process scheduled for given id.
GET
/hotels/{hotelId}/blocks/{blockId}/async/{requestId}
The API returns information about the block retrieval request.
Schemas 200
The contract defines 200 schemas that model the data the API accepts and returns. The most detailed are blockDetailsType (56 properties), blockType (35 properties), blockAllocationSummaryType (33 properties), blockReservationDetailsType (26 properties). Each schema is shown below with its type and property counts.
roomAllocationTypeType
object
A collection of Allocation objects for a block, such as Current Rooms, Original Rooms, Rate Amounts, etc.
2 properties
packagePostingRulesType
object
5 properties
revenueSummaryType
object
Summary information pertaining to revenue like Room, Food and Beverage, Catering, Other, Catering Other and Total Revenue.
7 properties
masterSubBlockBaseInfoType
object
13 properties
roomStatisticsType
object
3 properties
cateringStatusChangeHistoryType
array
Collection of catering status history.
allocationGridByDateRangeType
object
Indicates the block allocations for a date range. This can be rooms or rate amounts.
11 properties
setBlockGridInvType
object
Indicates the inventory values (occupancy or availability) per person occupancy.
7 properties
configPackageUsageDetailType
object
A Config Package Usage Detail type.
4 properties
policyBasisTypeType
string
Full Amount.
blocksType
object
A collection of Block objects or Unique IDs of Blocks.
4 properties
blockRangeModeType
string
Enumerates range operation modes.
numericUDFType
object
Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Rese…
3 properties
blockAllocationSummaryType
object
33 properties
blockNonCompeteType
object
Block Non Compete code information.
4 properties
cateringRevenueType
object
Information about Catering Revenue.
4 properties
personNameType
object
This provides name information for a person.
2 properties
blockOwnerType
object
Generic type for information about an owner.
12 properties
packageCodeHeaderType
object
4 properties
commentInfoType
object
Comment related to the profile/reservation.
9 properties
datesType
array
Specifies a single date.
rateProgramType
object
Rate Programs for the Block.
2 properties
amountDeterminationType
string
Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.
bookingChannelMappingType
object
4 properties
statisticsSummaryType
string
Type of statistic for which summary information is populated.
blockGridInvType
object
Indicates the inventory values ( occupancy or availability ) per person occupancy.
6 properties
pkgInventoryItemType
object
4 properties
blockCancellationTypeType
string
Simple type for cancellation reasons which helps to decide type of cancellation.
roomAllocationDateType
object
2 properties
processDetails
object
Response object to hold the details of process.
4 properties
characterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
indicatorsType
array
Collection of lamp indicators.
timeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to…
3 properties
blockAliasesType
array
List of Block Aliases.
indicatorType
object
Lamp indicator Type.
2 properties
mealPlansType
array
Meal plan codes associated with the rate codes.
blockRateProtectionType
object
Block Rate Protection code information.
2 properties
timeWindowType
object
Defines a Time period with start time and an end time.
2 properties
imageStyleType
string
An enumeration of image styles.
warningsType
array
Used in conjunction with the Success element to define a business error.
statusColorType
string
Status code color configuration type.
blockInventoryItemType
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
10 properties
uniqueID_Type
object
An identifier used to uniquely reference an object in a system.
2 properties
telephoneType
object
Information on a telephone number for the customer.
11 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
customerType
object
Contains basic data on the customer's identity.
1 property
telephoneInfoType
object
Information on a telephone number for the customer.
5 properties
sellMessageConfigType
object
Only one of the following can hold a value: HotelCode, CROCode or ChainCode
17 properties
rateProtectionType
string
Simple type for specifying the block protection type.
dateTimeStampGroupType
object
5 properties
blockOwnershipType
string
Specifies the type of the owner associated with the business block(Block/Rooms/Catering).
timeSpanDaysOfWeekType
object
Container for Time span with days of week.
8 properties
blockStatisticsSummaryType
object
Type to store summary detail like rooms sold, average room rate and revenue for a statistic type.
4 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
guaranteeType
object
Specifies Guarantee Code attributes.
9 properties
allocation
object
A Request message that sets the room allocations as a collection of room types and dates.
3 properties
blockAccessExclusionType
object
Access Exclusion information indicating the actions allowed under a HUB or Hotel for which the access exclusion is set.
7 properties
blockActualRevenueType
object
Indicates the sum of revenue breakup per room type per block per allocation date for the reservations. Applicable for past dates, business date or future dates.
11 properties
rateProgramRoomType
array
Room type for which Rate Program Rate Applies.
breakfastType
object
Information about breakfast charges.
3 properties
cateringEventsProcessedInfoType
object
Status/Info of the processed events.
10 properties
blockToShift
object
Request object to shift business block starting date.
3 properties
configPostingAttributesType
object
A config Package posting attributes type.
18 properties
allocationRanges
object
Request for setting block allocation for ranges of dates for a list of room types.
4 properties
blockType
object
35 properties
traceResolveType
object
2 properties
packagePostingRhythmType
object
Package Posting rhythm type.
5 properties
subBlockIdList
array
Unique Id that references an object uniquely in the system.
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
18 properties
blockRatePlanInfoType
object
Rate Plan info type extension for block.
19 properties
resourceDiscountTypeType
string
Indicates the option to select resources that will be discounted with the Resource Discount Percentage.
functionArgumentType
object
This type provided details of a function argument and the value it holds.
5 properties
translationTextType80
object
Contains Multiple translated texts and language codes.
2 properties
hotelUseType
object
3 properties
packageTransactionCodeType
object
3 properties
resDepositPoliciesType
array
A list of deposit policies attached with the reservation.
accessRestrictionsType
array
Block access exclusion/restriction type.
packageConsumptionType
object
Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.
4 properties
resDepositPolicyType
object
A deposit policy attached with the reservation.
6 properties
restrictionStatusesType
string
blockId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
rateProgramRateType
object
Room Pool Rate Program.
10 properties
dateTimeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to…
2 properties
eventOrderType
object
Event order distribution information.
3 properties
itemInfoType
object
Basic information regarding an Item.
15 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
blockOwnersType
object
Contains a list of block owners.
4 properties
guaranteeRequirementsType
object
Specifies various requirement for the guarantee code.
7 properties
depositPolicyType
object
Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.
12 properties
reservationPoliciesType
object
A collection of reservation deposit and cancellation policies.
4 properties
codeDescriptionType
object
This contains a generic code and description information.
2 properties
attachmentType
object
Attached files.
10 properties
productSourceType
string
Sources of Products
blockSourceOfSaleType
object
Point of Sale of Block. Identifies the entity/channel who made the block reservation.
3 properties
roomFeaturesType
array
A recurring element that identifies the room features.
usedInModuleType
string
Simple type for indicating the module for which user wants to create the SellMessage. Valid module types are Look To Book Sales,Reservations,Blocks,Function Di…
blockTraceType
object
Extended Trace object to hold information for a block.
13 properties
configPackageTransactionType
object
A HotelPackageTransaction type.
5 properties
roomAllocationDetailsType
object
9 properties
roomAllocationInfoType
object
A collection of Allocation objects for a block that indicate room inventory or rate amounts.
5 properties
postingRhythmType
string
Simple type for posting Rhythm types.
shiftBlockCriteriaType
object
7 properties
sourceCodeInfoType
object
4 properties
cateringNextStatusListType
array
Next catering status of the business block.
policyAmountPercentType
object
Defines the percentage basis for calculating the fee amount or the amount.
5 properties
blockPackageType
object
This contains the full information and schedule of the block package.
8 properties
cateringEventsProcessedInfoList
array
Status/Info of the processed events.
emailInfoType
object
Information on an email for the customer.
5 properties
bookingStatusDetailType
object
Booking Status details of the business block.
10 properties
blockWashSchedulesType
array
Wash Schedule attached to the block, which allows to release inventory based on selected wash schedule type.
allocationGridByRoomTypeType
object
A collection of Allocation objects for a block defined by room type.
3 properties
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
numericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
packageCalculationRuleType
string
Simple type for package caluculation rules.
offsetUnitType
string
Indicates deadline offset unit type.
reservationTypeInfoType
object
3 properties
blockPotenitalRevenueType
object
Indicates the sum of revenue breakup per room type per block per allocation date for the reservations. Applicable for business date or future dates.
11 properties
dateUDFsType
array
Used to hold collection of user defined fields of Date Type.
allocationRoomTypeInfoType
object
The information about the room types contained in the block room allocation.
19 properties
dateUDFType
object
Used to hold user defined field of Date Type.
3 properties
eventTypeType
string
Contract type.
blockNextStatusListType
array
Next booking status of the business block.
roomTypeAttributesType
object
Attributes of property room type.
6 properties
restrictionStatusType
object
The RestrictionStatusType is used to indicate the type of restriction applied. An enumerated restriction type is defined in the attribute group.
9 properties
imageSetType
object
Represents on image set record.
11 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
attachmentsType
array
Attachment List.
paymentTypesType
array
Payment card code like AX,VI etc.
emailType
object
Information on an email for the customer.
10 properties
blockReservationDetailsType
object
Contains reservation related information for the block.
26 properties
blockStatusTypeType
string
Simple type for specifying the block status type.
blockStatusChangeHistoryType
array
Collection of block status history.
blockInventoryItemSourceType
object
Defines whether the item is setup due to a Rate Plan, Package or a Block.
3 properties
blockAllocationRangeType
object
Container for information related to block allocation range update operation
16 properties
bookingStatusHistoryType
object
4 properties
companyType
object
1 property
sellLimitGridByDateRangeType
object
Indicates the sell limits for a date range. This will be rooms.
10 properties
translationsTextType
array
Language code for the translation.
resCancelPenaltyType
object
The CancelPenalty class defines the cancellation policy of the hotel facility.
9 properties
centralSalesLeadsType
object
Basic information about the Central Lead and its linked Property Leads.
2 properties
blockAlternateDateType
object
Information for Alternate date types
4 properties
blockRestrictionType
object
Restriction details for a block.
4 properties
configPackagePrimaryDetailsType
object
A Config Package Info type.
6 properties
allocationType
string
Simple type for block allocation used in room rate grid.
blockProfileTypeType
string
Simple type for block profile types.
eventAttendeesType
object
Event attendees information.
2 properties
blockAllocationRanges
object
Collection of block allocation ranges.
1 property
externalReferencesType
array
This type contains unique information of external reference.
criteria
object
Request object for fetching block allocation summary asynchronously.
6 properties
blockWashScheduleType
object
Allows to select type of wash schedule: by number of rooms or by percentage.
4 properties
cancellationDetailsType
object
This type holds information regarding booking status change to Cancel/ Lost.
6 properties
roomFeatureType
object
Room Feature Information.
4 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
userDefinedFieldsType
object
A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.
3 properties
sellMessageConfigsType
object
The SellMessageConfigsType is the list of sell messages, each comprising of all the sell message attributes and other details.
4 properties
bookingStatusType
object
Booking status code, description and configured color of the status. This will be used for block and event statuses.
2 properties
blockAccessExclusionsType
object
Access Exclusion information indicating the actions allowed under a HUB or hotel for which the access exclusion is set.
7 properties
statusType
string
Status of the process.
blockInventoryControlType
string
Simple type for block inventory control values. This determines if it is a Non Elastic, Elastic or Sell Limits block.
marketCodeInfoType
object
4 properties
blockInventoryItemsType
array
Inventory item attached to a block.
dateRangeType
object
Date Range with Start and End dates.
2 properties
traceTimeInfoType
object
4 properties
blockStatisticsType
object
4 properties
blockAllocationSummary
array
Response object for fetched block allocation summary.
cancelPenaltyType
object
The CancelPenalty class defines the cancellation policy of the hotel facility.
10 properties
functionArgumentsType
array
Collection of function arguments and their corresponding values.
blockGridRatesType
object
Indicates the rate amount values per person occupancy.
5 properties
blockClassificationType
string
Simple type for block instructions to be used in requests for fetching blocks. Valid status values are MASTERBLOCK, MASTERTOUR, FITMASTER, MASTERALLOCATION, MA…
blockDetailsType
object
Information about the Block Details
56 properties
applyEventAttendeesChangesToEventsType
string
Non-Pkg Events on the same date.
profileId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
resCancellationPoliciesType
array
A list of reservation cancellation policies.
profileTypeType
string
The types of Profile handled by the web service.
reservationId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
6 properties
cateringType
object
Contains catering related information for the block.
25 properties
leadInfoType
object
9 properties
allocationGridByDateRangesType
object
A collection of Allocation objects for a block, such as Current Rooms, Original Rooms, Rate Amounts, etc.
2 properties
characterUDFType
object
Used to hold user defined field of Character/String Type.
3 properties
policyDeadlineType
object
Cancellation deadline, absolute or relative.
4 properties
roomAllocationMasterInfoType
object
2 properties
porterageType
object
Information about porterage charges.
2 properties
blockProfilesType
object
A collection of Profile objects or Unique IDs of Profiles.
3 properties
allocationGridByRoomTypesType
object
A collection of Allocation objects for a block defined by room type.
4 properties
block
object
Request object for creation of blocks. This object contains block details with unique identifiers for each block. The standard optional Opera Context element i…
3 properties
mealPlanCodeType
object
Meal plan codes associated with the rate codes.
5 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
resCancellationPolicyType
object
A cancellation policy attached with the reservation.
5 properties
hotelCodeListType
array
Hotel code.
links
array
blockRestrictionsType
object
List of restrictions belonging to a block.
3 properties
blockTracesType
array
List of Block traces.
blockAccessRestrictionType
string
Simple type for block access exclusion/restriction types.
profileType
object
Type provides the detailed information about the profile and its children.
3 properties
externalReferenceType
object
This type contains unique information of external reference.
3 properties
blockAccessExclusionMessageType
object
Access exclusion message.
1 property
depositCancelRevenueType
string
The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.
roomGridDetailsType
object
Indicates the values of room inventory or rate amount per room type.
4 properties
masterBlockInfoType
object
Basic information pertaining to the master block.
15 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle Hospitality 12
Other APIs Oracle Hospitality publishes across the network.
OPERA Cloud RnA Activities GraphQL API
OPERA Cloud RnA ARAccountsReceivable GraphQL API
OPERA Cloud RnA ARAgingReport GraphQL API
OPERA Cloud RnA ARLedger GraphQL API
OPERA Cloud RnA BookingReservationExtended GraphQL API
OPERA Cloud RnA BookingsBlockProductionChanges GraphQL API
OPERA Cloud RnA BookingsBlockStatusChanges GraphQL API
OPERA Cloud RnA BookingsBlock GraphQL API
OPERA Cloud RnA BookingsReservation GraphQL API
OPERA Cloud RnA CateringEventForecast GraphQL API
OPERA Cloud RnA CateringEventPostings GraphQL API
OPERA Cloud RnA CateringEventStatusChanges GraphQL API
#BlockAsync
Where this information came from
This is an independent, third-party profile of Oracle Hospitality Block Async API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.