Oracle Hospitality Block API
These APIs will allow you to completely create and manage your block in OPERA Cloud - including all related functionalities of a block such as manage Room allocation, Status update, block reservations.You can search for a block, get a Block, update and create new Blocks.
Oracle Hospitality Block 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 Block. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 90 operations across 70 paths, and defines 698 schemas. It is described by OpenAPI 3.2.0, at version 26.2.0.0.
Requests are made against a single base URL, /blk/v1.
90 operations
70 paths
698 schemas
8 DELETE32 GET17 POST33 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 90
Across 70 paths, the API surfaces 90 operations — 8 DELETE, 32 GET, 17 POST, 33 PUT. Each is listed below with its method, path, parameters, and response codes.
Block 90
These APIs will allow you to completely create and manage your block in OPERA Cloud - including all related functionalities of a block such as manage Room allocation, Status updat…
POST
/allocation
Create Sub allocation
GET
/blockActivityLog
Get the Block activity log
PUT
/blockWash
Update Block Allocation Wash
GET
/blockWash
Get Block Wash Information
GET
/blocksdeprecated
Get Blocks
POST
/blocks/actions/validate
Validate Block
GET
/blocks/dailyStatistics
Get Block Daily Statistics
POST
/blocks/searches
Search Blocks
GET
/blocks/status
Get Next Block Status
PUT
/blocks/{blockCode}/actions/validate
Validate Block Code
POST
/blocks/{blockId}/alternateDatesdeprecated
Create alternate dates for a Block
PUT
/blocks/{blockId}/alternateDatesdeprecated
Change alternate dates for a Block
DELETE
/blocks/{blockId}/alternateDatesdeprecated
Delete alternate dates for a Block
GET
/blocks/{blockId}/attachments
Get Block Attachments
DELETE
/blocks/{blockId}/attachments/{attachId}
Delete Block Attachment
PUT
/blocks/{blockId}/blockAccessExclusion
Set Block Exclusion information
DELETE
/blocks/{blockId}/blockAccessExclusion
Delete Block access exclusion
PUT
/blocks/{blockId}/blockCutOff
Block Cut Off
GET
/blocks/{blockId}/owners
Get Block owners
POST
/blocks/{blockId}/ownersdeprecated
Assign a Block owner
DELETE
/blocks/{blockId}/ownersdeprecated
Delete a Block owner
PUT
/blocks/{blockId}/ownersdeprecated
Change Block owners
PUT
/blocks/{blockId}/rates
Refreshes Block rates
PUT
/blocks/{blockId}/reservations
Change Block reservations
GET
/blocks/{blockId}/reservations
Retrieves all reservations created for the Block
GET
/blocks/{blockId}/restrictions
Get Block restrictions
POST
/blocks/{blockId}/restrictions
Create Block Restriction
DELETE
/blocks/{blockId}/restrictions
Delete Block Restriction
PUT
/blocks/{blockId}/restrictions
Clear-All Block Restrictions
GET
/blocks/{blockId}/revenueActivityLog
Fetch Block Revenue Changes
PUT
/blocks/{blockId}/roomTypeOrder
Set room type order for a Block
GET
/blocks/{blockId}/roomTypes
Get Bock Room Types
POST
/blocks/{blockId}/roomingList
Create Block Rooming List Reservations
GET
/blocks/{blockId}/roomsStatus
Get room status for a Block
GET
/blocks/{blockId}/statistics
Get Block Statistics
GET
/blocks/{blockId}/statusActivityLog
Get Block Status Activity Log
POST
/blocks/{blockId}/tourSeries
Create a Block tour series
PUT
/blocks/{blockId}/tourSeries/validate
Validate Block tour series
GET
/blocks/{blockId}/washSchedules
Get Block Wash Schedule
POST
/blocks/{blockId}/washSchedules
Create Block Wash Schedules
PUT
/blocks/{blockId}/washSchedules
Change Block Wash Schedules
DELETE
/blocks/{blockId}/washSchedulesdeprecated
Remove Block Wash Schedules
POST
/blocks/{sourceBlockId}/copy
Copy a Block
PUT
/caterings/{eventId}/cateringStatus
Change Catering Status
GET
/centralSalesHotels
Get Central Sales Hotels
PUT
/contractDefaultsdeprecated
Set Contract Defaults
GET
/defaultBlockCode
Get default Block Code
POST
/defaultBlockCode
Create default Block Code for Multiple blocks
POST
/hotels/{hotelId}/block
Create a Block
GET
/hotels/{hotelId}/blockDailyRevenue
Get Block Revenue for a given date.
GET
/hotels/{hotelId}/blocks/changesByDateTime
Get modified blocks from a specific time period in OPERA.
GET
/hotels/{hotelId}/blocks/{blockId}
Get a Block By ID
PUT
/hotels/{hotelId}/blocks/{blockId}
Change a Block
DELETE
/hotels/{hotelId}/blocks/{blockId}
Delete a Block
PUT
/hotels/{hotelId}/blocks/{blockId}/allocation
Set Block Allocation
PUT
/hotels/{hotelId}/blocks/{blockId}/allocationRange
Set Block Allocation Range
GET
/hotels/{hotelId}/blocks/{blockId}/allocationRange
Get Block Range Information
GET
/hotels/{hotelId}/blocks/{blockId}/availability
Get Block AvailaBility
POST
/hotels/{hotelId}/blocks/{blockId}/cancellationsdeprecated
Cancel the Block
PUT
/hotels/{hotelId}/blocks/{blockId}/cateringRevenue
Recalculate Catering Revenue
GET
/hotels/{hotelId}/blocks/{blockId}/exchangeInterfaces
Get exchange interfaces from business block
PUT
/hotels/{hotelId}/blocks/{blockId}/exchangeInterfaces
Set exchange interfaces for business block
PUT
/hotels/{hotelId}/blocks/{blockId}/openStatus
Change Block status to Open
POST
/hotels/{hotelId}/blocks/{blockId}/postingMaster
Create Block posting master
GET
/hotels/{hotelId}/blocks/{blockId}/postingMaster/reservations
Get Posting Master Reservations for a Block
PUT
/hotels/{hotelId}/blocks/{blockId}/rate/override
Change rate override
PUT
/hotels/{hotelId}/blocks/{blockId}/regularToMasterBlock/{masterBlockCode}
Use this API to convert a regular block to a master block
PUT
/hotels/{hotelId}/blocks/{blockId}/regularToSubAllocation/{masterAllocationId}
Convert a regular business block to a sub allocation under a master allocation in the same property.
PUT
/hotels/{hotelId}/blocks/{blockId}/regularToSubTour/tourHotels/{masterTourHotelId}/tours/{masterTourId}
Convert a regular block to a sub tour or sub itinerary under a master tour or master itinerary.
GET
/hotels/{hotelId}/blocks/{blockId}/roomRateGrid
Operation to get room rate grid for a Block and supports pagination.
PUT
/hotels/{hotelId}/blocks/{blockId}/shifts
Shifts the Block start date
PUT
/hotels/{hotelId}/blocks/{blockId}/status
Change the Status of a Block
PUT
/hotels/{hotelId}/blocks/{blockId}/subBlockToRegular
Use this API to convert a sub block to a regular block
POST
/hotels/{hotelId}/blocks/{blockId}/subBlocks
Create a sub-Block
DELETE
/hotels/{hotelId}/blocks/{blockId}/washSchedules
Remove Block Wash Schedule
GET
/hotels/{hotelId}/externalSystems/{externalSystemCode}/blocks/{blockExternalId}
Get a Block By ID
PUT
/hotels/{hotelId}/externalSystems/{externalSystemCode}/blocks/{blockExternalId}
Change a Block
PUT
/hotels/{hotelId}/externalSystems/{externalSystemCode}/blocks/{blockExternalId}/allocation/roomTypes/{roomType}
Set Block Allocation
PUT
/hotels/{hotelId}/externalSystems/{externalSystemCode}/blocks/{blockExternalId}/allocationRange
Set Block Allocation Range
GET
/hotels/{hotelId}/externalSystems/{externalSystemCode}/blocks/{blockExternalId}/postingMaster/reservations
Get Posting Master Reservations for a Block
PUT
/hotels/{hotelId}/externalSystems/{externalSystemCode}/blocks/{blockExternalId}/status
Change the Status of a Block
POST
/hotels/{hotelId}/externalSystems/{externalSystemCode}/blocks/{blockExternalId}/subBlocks
Create a sub-Block
POST
/hotels/{hotelId}/leads/{leadId}/propertyLeads
Use this API to create Property Leads
GET
/hotels/{hotelId}/tracesByDateRange
Get Traces By Date Range
PUT
/inventory
Borrow Inventory
PUT
/inventoryReleased
Return Borrowed Inventory
GET
/inventoryToBorrow
Get inventory to Borrow
GET
/recentlyAccessedBlocks
Get recently accessed Blocks
GET
/salesAllowances
Get Sales allowances
GET
/services/block/status
This API retrieves the Block service version
Schemas 698
The contract defines 698 schemas that model the data the API accepts and returns. The most detailed are hotelReservationType (93 properties), searchBlocksRequest (69 properties), blockDetailsType (56 properties), reservationInfoType (52 properties). Each schema is shown below with its type and property counts.
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
prepaidCardsType
array
Holds fixed charge detail.
cardReIssueType
string
Request to re issue a new card.
resAccompanyGuestInfoType
object
5 properties
stayInfoType
object
Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaini…
36 properties
roomingListSharesType
array
Contains a set of rooming list reservations that need to be shared.
setBlockOwnersType
object
Criteria to update block owners.
4 properties
allocationGridByDateRangeType
object
Indicates the block allocations for a date range. This can be rooms or rate amounts.
11 properties
entityType
string
Indicates the rule is based on Minutes associated with the charge.
reservationECertificatesType
array
Collection of ECertificateType object.
configPackageUsageDetailType
object
A Config Package Usage Detail type.
4 properties
policyBasisTypeType
string
Full Amount.
statisticsType
string
Type of statistic for which its statistics information by date and room type will be populated.
blockAvailabilityRoomTypeInfo
object
Room type information including packages and basic room type details.
4 properties
blockStatisticsInfoType
object
Information about availability, rate and allotment statistics.
5 properties
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
roomingListShareReservationType
object
Contains the rooming list reservation that is to be shared and the information about the share type of this reservation.
4 properties
bookingChannelMappingType
object
4 properties
pkgInventoryItemType
object
4 properties
borrowableInventoryType
object
This provides a collection of all borrowable room types by date.
6 properties
changeBlockReservationType
object
Information about the block reservation being changed.
3 properties
characterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
alertType
object
25 properties
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
cateringStatusToChange
object
Request object for changing the catering status of the business block.
4 properties
fixedChargesType
array
Holds fixed charge detail.
blockRateProtectionType
object
Block Rate Protection code information.
2 properties
createSubBlockBaseInfoType
object
5 properties
blockOwners
object
Response object that returns all sales manager owners associated with a business block.
3 properties
imageStyleType
string
An enumeration of image styles.
addressInfoType
object
Provides address information.
5 properties
blockChangesByDateTimeSummary
object
1 property
warningsType
array
Used in conjunction with the Success element to define a business error.
blockRoomStatisticsListType
array
Collection of room type level statistics.
blockStatistics
object
The response object that returns Block Statistics information.
4 properties
transactionDiversionDailyDetailType
object
List of daily details for Transaction Diversion rule.
3 properties
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
changedBlockReservations
object
The response object that contains the reservations that were changed for a block along with the status of each change.
3 properties
eCertificateInfoType
object
E-Certificates details.
14 properties
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
subBlock
object
Request object to create new sub block.
3 properties
nextBlockStatus
object
Response object for FetchNextBlockStatus operation.
4 properties
customerType
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
18 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
callType
object
Holds call information.
11 properties
housekeepingRoomStatusType
string
Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOf…
excludedDateType
object
Specifies all the enabled dates.
2 properties
blockStatisticsSummaryType
object
Type to store summary detail like rooms sold, average room rate and revenue for a statistic type.
4 properties
blockWashSchedulesInfoType
object
The criteria based on which the block wash schedules will be created/ changed.
3 properties
blockReservationsToChange
object
The request object to implement batch changes to block reservations based upon changes made to a reference reservation.
3 properties
allocation
object
A Request message that sets the room allocations as a collection of room types and dates.
3 properties
changeCateringStatusType
object
This holds the information required to change the catering status of the business block.
8 properties
blockGridType
object
7 properties
blockAccessExclusionType
object
Access Exclusion information indicating the actions allowed under a HUB or Hotel for which the access exclusion is set.
7 properties
profileDeliveryModuleType
string
Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..
cateringEventsProcessedInfoType
object
Status/Info of the processed events.
10 properties
discountType
object
Identifies and provides details about the discount. This allows for both percentages and flat amounts. If one field is used, the other should be zero/not speci…
5 properties
blockToShift
object
Request object to shift business block starting date.
3 properties
blockStatisticsDatesType
array
Collection of statistics detail for every allotment date.
hotelInterfaceType
object
8 properties
reservationPaymentMethodsType
array
Defines reservation payment methods.
cardProcessingType
string
reservationHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
tourSeriesBlocksType
array
Contains tour series blocks information.
borrowInventoryType
object
This holds the number of rooms for each date that will be borrowed from the candidate room type provided.
3 properties
packageConsumptionType
object
Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.
4 properties
errorType
object
Standard way to indicate that an error occurred during the processing of an message. If the message successfully processes, but there are business errors, thos…
10 properties
prepaidCardType
object
Holds fixed charge information.
17 properties
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
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
resAccompanyGuestListType
array
Collection of accompany guests
resSharedGuestListType
array
Collection of shared guest reservations.
shareDistributionInstructionType
string
The type of Rate Amount Change to be done on the Sharer reservation. This can be FULL - Full Rate for each Sharer. SPLIT- Split the Rate amount between Sharer…
benefitsType
array
Basic information about membership benefit.
userSessionInfoType
object
11 properties
blockPostingMaster
object
Request object for creating a new Posting Master Reservation.
3 properties
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
blockRevenueChangesDetailType
object
7 properties
reservationPoliciesType
object
A collection of reservation deposit and cancellation policies.
4 properties
downgradeType
string
Do not downgrade membership when the next downgrade process runs. When the downgrade process runs, the membership will be automatically set to Grace.
codeDescriptionType
object
This contains a generic code and description information.
2 properties
productSourceType
string
Sources of Products
tracesByDateRange
object
Fetch traces response.
3 properties
blockSummaryType
object
41 properties
resAwardsType
object
Membership Awards code applied on the reservation.
4 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.
surnameType
string
Family name, last name.
sourceCodeInfoType
object
4 properties
changeBlockReservationsType
object
Criteria used to perform batch changes to reservations that belong to a block.
6 properties
blockValidate
object
Request object for validating creation of blocks only. Block is not created. This object contains block details with unique identifiers for each block. The sta…
4 properties
blockPackageType
object
This contains the full information and schedule of the block package.
8 properties
ownerType
object
Generic type for information about an owner.
11 properties
bookingStatusDetailType
object
Booking Status details of the business block.
10 properties
allocationGridByRoomTypeType
object
A collection of Allocation objects for a block defined by room type.
3 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
tourSeriesBlockType
object
Information about a tour series block.
9 properties
reservationECertificateType
object
Reservation ECertificate Type Information.
3 properties
confDeliveryMethod
string
inventoryToBorrowInfo
object
Response object that returns the candidate room types on which inventory is available to borrow. The standard optional Opera Context element is also included.
3 properties
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
returnRoomType
object
Specifies the number of rooms to be returned to a room type or House.
3 properties
attendantType
object
2 properties
hotelReservationsType
object
A collection of Reservation objects and Unique IDs of Reservation.
4 properties
prepaidCardTrxTypeType
string
Reload transaction.
blockStatus
object
Request object to transition the block status to Open for Pickup. This object contains unique identifier ( Block unique id ) to identify the block to be transi…
4 properties
profileDeliveryMethod
object
Delivery Information type to the profile.
7 properties
changedBlockStatus
object
Response object for the request to change block status. Response contains information on the block whose status was successfully changed.
9 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
blockReservationId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
7 properties
reservationLocatorsType
array
Holds the Locator Information.
blockStatusChangeHistoryType
array
Collection of block status history.
traceType
object
16 properties
commissionPaymentMethods
string
Check
operaVersionNumberType
string
Current Opera Version Number
compRoutingStatusType
string
Status which indicates that the Request of Comp Routing was declined
errorsType
array
An error that occurred during the processing of a message.
confirmationsType
array
List of confirmation letters.
addressType
object
Provides address information.
17 properties
bookingStatusHistoryType
object
4 properties
blockBasicInfo
object
Common Type used to store basic information of a block
5 properties
createBlockRestrictionType
object
Information for creating restrictions for a block.
13 properties
blockPMReservations
object
The response object that contains the PM reservations belonging to a block.
3 properties
nameValueDetailType
object
Detailed information returned during name value search.
1 property
serviceRequests
array
Service request.
blockAlternateDateType
object
Information for Alternate date types
4 properties
taxesType
object
A collection of taxes.
3 properties
totalType
object
The total amount charged for the service including additional amounts and fees.
10 properties
overrideInstructionsType
array
List of override actions done.
rateByAgeBucketType
object
Rate amount by age bucket.
3 properties
allocationType
string
Simple type for block allocation used in room rate grid.
blockCodeToValidate
object
Request object for validating blocks in a train. Block is not created. The standard optional Opera Context element is also included.
6 properties
sentConfirmationStatus
string
eventAttendeesType
object
Event attendees information.
2 properties
stayFutureListType
object
A collection of reservation history details attached to Profiles.
4 properties
countryNameType
object
Code for a country or a nationality.
2 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
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
relationshipAddressType
object
Provides address information for a Relationship.
5 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
salesAllowanceIDType
object
Unique identifier of a single sales allowance.
1 property
additionalGuestAmountType
object
2 properties
messageDeliveryType
object
Holds the Delivery Information of the Message
8 properties
dateRangeType
object
Date Range with Start and End dates.
2 properties
blockStatisticsType
object
4 properties
externalIdType
object
2 properties
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
serviceRequestStatusType
string
blocksDailyStatisticsType
array
A collection of Blocks.
benefitType
object
Basic information about membership benefit.
3 properties
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
13 properties
reservationTaxTypeInfo
object
Provides information about the Tax Type.
9 properties
trackItLogType
object
Individual activity log related to the Track It ticket.
9 properties
porterageType
object
Information about porterage charges.
2 properties
blockProfilesType
object
A collection of Profile objects or Unique IDs of Profiles.
5 properties
privacyInfoType
object
Defines Privacy related information for the profile.
14 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
blockWashSchedulesInfo
object
Request object to change multiple Block Wash Schedules under the selected block.
3 properties
resCancellationPolicyType
object
A cancellation policy attached with the reservation.
5 properties
hotelCodeListType
array
Hotel code.
profileCashieringType
object
Contains cashiering related details for the profile
14 properties
operaVersion
object
Response for Ping operation.
3 properties
relationshipInfoType
object
Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.
4 properties
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
depositCancelRevenueType
string
The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.
cancelPenaltyType
object
The CancelPenalty class defines the cancellation policy of the hotel facility.
10 properties
transactionDiversionRuleTypeType
string
The rule type on which the Transaction Diversion Rule is based. If a reservation has any of the following code, Transaction Diversion rule gets active for that…
turndownStatusType
string
Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Complet…
blockOwnersToAssign
object
Request object to assign block owners.
3 properties
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
nameValueType
object
Contains name value pair.
6 properties
blockAlternateDates
object
Request object to create block alternate dates.
5 properties
alertAreaType
string
blockApplyChangesToType
string
Valid values are All, Same Arrival Date, Checked In, Selected, In House.
roomStatisticsType
object
3 properties
setBlockGridInvType
object
Indicates the inventory values ( occupancy or availability ) per person occupancy.
7 properties
blocksType
object
A collection of Block objects or Unique IDs of Blocks.
4 properties
blockRangeModeType
string
Enumerates range operation modes.
blockNonCompeteType
object
Block Non Compete code information.
4 properties
cateringRevenueType
object
Information about Catering Revenue.
4 properties
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
52 properties
blockAvailabilityRoomInfoType
object
Captures occupancy and rate information for a room type.
13 properties
salesAllowances
object
Response returned by fetch corrected sales allowances.
3 properties
tourSeries
object
Request for creating a tour series based on an existing block.
4 properties
membershipEarningPreferenceType
string
The earning preference of a membership, it depends on the type of property. eg. when the property is a airline it should be Miles, other than Points.
fetchActivityBookingsType
object
Used in the request message to describe the "filtering Criteria" when executing an activity lookup.
5 properties
statisticsRoomTypeInfoType
object
Extended room type to store room category.
19 properties
reservationTransactionDiversionsType
array
List of Transaction Diversion rules.
reservationPackageScheduleType
object
A HotelPackageSchedule type.
8 properties
rateProgramType
object
Rate Programs for the Block.
2 properties
foreignExchangeType
object
Foreign Exchange info.
2 properties
eCertificateType
object
E-Certificates details.
23 properties
resCashieringType
object
Cashiering Information for the reservation.
14 properties
blockAvailabilityType
object
Holds block availability information.
5 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
hotelReservationType
object
The Reservation class contains the current reservation being created or altered.
93 properties
blockRestriction
object
Request for CreateBlockRestriction operation.
3 properties
salesAllowanceType
object
A single sales allowances.
8 properties
routingInstructionType
object
Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit
8 properties
profileMembershipType
object
Detailed information of the memberships.
41 properties
reservationPaymentMethodType
object
7 properties
mealPlansType
array
Meal plan codes associated with the rate codes.
blockStatusChangesDetailsType
array
Block Status Changes Details
blockToCancel
object
Request object for block cancelation. This object contains unique identifiers (Block unique id, Block Code and Block Start Date ) to identify the block to be C…
3 properties
blockRevenueChangesDetailsType
array
Block Revenue Changes Details
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
statusColorType
string
Status code color configuration type.
telephoneInfoType
object
Information on a telephone number for the customer.
5 properties
currencyExchangeRateType
object
Currency code configuration.
5 properties
newBlockDetailsType
object
This is used when creating a copy of a block.
14 properties
rateProtectionType
string
Simple type for specifying the block protection type.
effectiveRatesType
array
Collection of effective rate amount per guest on specific dates.
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
trackItActionType
object
Identifies the response expected from staff or other parties relative to a Track It ticket.
2 properties
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
activityLogListType
object
7 properties
borrowCandidateType
object
This contains a collection of all dates and required rooms. It also contains the borrow candidates which could be room types or house.
6 properties
awardType
object
Detailed information of the awards.
34 properties
eventId
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
roomingList
object
Request object for creating rooming list reservations. The standard optional Opera Context element is also included.
5 properties
rateProgramRoomType
array
Room type for which Rate Program Rate Applies.
breakfastType
object
Information about breakfast charges.
3 properties
nameValueOriginType
object
Contains origin details.
6 properties
identificationInfoType
object
Information on the identification of the customer.
5 properties
validateTourRS
object
3 properties
masterInfoCodeDetailType
string
status
object
Response Body.
2 properties
profileRestrictions
object
3 properties
roomingListReservationType
object
This is used when changing block reservations in bulk.
5 properties
promotionType
object
Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.
3 properties
accessRestrictionsType
array
Block access exclusion/restriction type.
blockHeaderInfoType
object
Holds block header details.
17 properties
restrictionStatusesType
string
blockDailyStatistics
object
Response Object of Fetch Block Daily Statistics.
9 properties
changeBlockStatusType
object
This holds the information required to change the booking status of the business block.
12 properties
fixedChargeScheduleType
object
Holds schedule of fixed charge.
5 properties
customChargeQuantityType
object
Contains quantity of custom charge exemptions.
2 properties
blockSourceOfSaleType
object
Point of Sale of Block. Identifies the entity/channel who made the block reservation.
3 properties
blockTraceType
object
Extended Trace object to hold information for a block.
13 properties
configPackageTransactionType
object
A HotelPackageTransaction type.
5 properties
linkedReservationType
string
Enumeration of the different Linked Reservation Types.
cateringNextStatusListType
array
Next catering status of the business block.
blockStatisticsAllotedRoomsType
object
List of all room types with alloted rooms.
1 property
blockStatisticsDetailType
object
Statistics Detail for a statistic type.
2 properties
trxInfoType
object
Transaction codes info.
10 properties
roomingListDetails
object
Response object for creation of block rooming list. This object contains the details with unique identifiers for the created block reservations. Also Success,W…
4 properties
blockWashSchedulesType
array
Wash Schedule attached to the block, which allows to release inventory based on selected wash schedule type.
relationshipInfoSummaryType
object
RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact p…
7 properties
salesAllowancesType
array
Collection of Sales Allowances.
callHistoryType
array
Holds call information.
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
resAttachedProfileListType
array
eCertificateConsumptionType
object
E-Certificates details.
13 properties
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
relationshipProfileSummaryType
object
11 properties
setBlockExchangeInterfacesRequest
object
1 property
roomingListReservationsType
object
If anyone or more reservations failed, then it specifies the associated error messages.
4 properties
blockAttachments
object
Return object to the request for information regarding block attachments.
3 properties
awardsType
array
List of awards.
ownerResTypeType
string
givenNameType
string
Given name, first name or names
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
eCouponType
object
Reservation eCoupon Type Information.
9 properties
transactionActionEnumType
string
companyInfoType
object
Company Information of the Profile.
3 properties
borrowedInventoryToReturn
object
The standard optional Opera Context element is also included.
8 properties
blockNextStatusListType
array
Next booking status of the business block.
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
9 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
customChargeExemptionDateType
object
Contains Custom Charge Exemption information for a day.
2 properties
linkedReservationsInfoType
object
Linked Reservations.
7 properties
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
parametersType
array
Collection of generic Name-Value-Pair parameters.
traceFrequencyPatternType
string
Defines the Trace Frequency for the created trace. Traces created with a defined trace frequency will have the trace dates automatically updated when a reserva…
exclusionReasonType
string
Custom Charge has already been Processed for this date within the reservation stay.
messageType
object
Holds the Message Information
5 properties
rESTPaginationGroup
object
Provides Pagination Information for the REST API.
5 properties
eCertificateUsageCriteriaType
object
E-Certificates details.
8 properties
revenueDetailType
object
Since the statistical value can be represented in different measure of units, this element will provide a flexible definition for the supported Opera9 statisti…
2 properties
blockAllocationRangeType
object
Container for information related to block allocation range update operation
16 properties
currentRoomInfoType
object
Room information of the reservation for the current day.
7 properties
eCouponsType
array
Collection of ECouponType object.
typeOfMessageType
string
The type of Message for Guest Messages.
compAuthorizerInfoType
object
Authorizer Information
3 properties
rateRangeType
object
Rate Range details like maximum rate amount and minimum rate amount in each available rate category.
2 properties
blockStatusToChange
object
Request object for changing the booking status of the business block.
6 properties
blockInstructionType
object
Extended Block object to hold additional instructions along with the block. This should be used during create/update operations on a block.
37 properties
confirmationStyle
object
7 properties
tourSeriesType
object
This contains information as the block code, block name, block status regarding the blocks to be created as tour series.
7 properties
amountType
object
Base charge and additional charges related to a room that includes such things as additional guest amounts, cancel fees, etc. Also includes Discount percentage…
10 properties
blockRestrictionType
object
Restriction details for a block.
4 properties
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
categoryEnum
string
eCertificateIssueSourceType
string
Indicates that OPERA E-Certificate is issued by external system.
certainNightsOfTheWeek
object
Supports the 'Certain Nights Of The Week' trace frequency option by indicating on which days traces should be generated.
7 properties
defaultBlockCodeDetails
object
Response object that returns a default block code based on template.
3 properties
cancellationDetailsType
object
This type holds information regarding booking status change to Cancel/ Lost.
6 properties
bookingStatusType
object
Booking status code, description and configured color of the status. This will be used for block and event statuses.
3 properties
guestMessageType
object
Holds the Message information for a Reservation
13 properties
blockInventoryControlType
string
Simple type for block inventory control values. This determines if it is a Non Elastic, Elastic or Sell Limits block.
compRoutingRequestType
object
Type for the details of a Comp Routing Request
4 properties
excludedDatesType
array
Contains list of dates which are valid for custom charge exemptions.
interfaceRightsStatusType
object
4 properties
profileNameType
object
This provides name information for a person.
8 properties
traceTimeInfoType
object
4 properties
stayReservationInfoType
object
The Reservation class contains the current reservation being created or altered.
6 properties
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
32 properties
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
ratePlanCommissionType
object
3 properties
applyEventAttendeesChangesToEventsType
string
Non-Pkg Events on the same date.
searchBlocksRequest
object
69 properties
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
hotelReservationTracesType
array
List of Reservation Traces.
blockDailyRoomStatisticsType
object
Statistics information for the room type.
2 properties
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
leadInfoType
object
9 properties
profileStatusType
string
blockDailyRevenueStatistics
object
3 properties
visaInfoType
object
3 properties
parameterType
object
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.
2 properties
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
billingInstructionsType
array
Set of Billing Instruction codes.
blockAccessRestrictionType
string
Simple type for block access exclusion/restriction types.
blockTracesType
array
List of Block traces.
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
depositPolicyType
object
Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.
12 properties
commissionPayoutToType
string
masterBlockInfoType
object
Basic information pertaining to the master block.
15 properties
childAgesType
array
Age of a child in years.
ticketType
object
Reservation Ticket Type Information.
13 properties
rateByAgeBucketsType
array
Rate amount by age bucket.
roomAllocationTypeType
object
A collection of Allocation objects for a block, such as Current Rooms, Original Rooms, Rate Amounts, etc.
2 properties
hotelConfigDetails
object
Response object for fetching lists of Property summary information.
9 properties
blockRateCodeValidationType
object
Information for validation of block rate code.
4 properties
lastStayInfoType
object
Contains last stay related details for the profile
4 properties
rewardCertificateType
string
Point Saver reward.
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
cateringStatusChangeHistoryType
array
Collection of catering status history.
blockReservationsCriteriaType
object
Indicates the filter criteria to identify the block reservations that should implement the same changes as the reference reservation.
3 properties
reservationFolioWindowsType
array
Collection of reservation folio windows.
blockBasicInfos
object
Collection of basic block informatioin
1 property
allRestrictions
object
Request for clearAllRestrictions operation.
5 properties
blockOwnerType
object
Generic type for information about an owner.
12 properties
prepaidCardTransactionType
object
Prepaid Card transaction.
9 properties
activityList
array
A collection of Activity objects.
packageCodeHeaderType
object
4 properties
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
commentInfoType
object
Comment related to the profile/reservation.
9 properties
nameValuesType
array
List of name value pairs.
reservationIdList
array
Unique Id that references an object uniquely in the system.
datesType
array
Specifies a single date.
blockAllocationWashType
object
Holds criteria for performing a wash operation on a block.
11 properties
routingInfoType
object
A routing info object can either be of type Folio OR of type Room with its corresponding object.
5 properties
directBillingType
object
This is the preconfigured routing instruction type.
2 properties
eCertificateStatusType
string
Indicates that OPERA E-Certificate is reserved.
alertsType
array
List of alerts.
eCertificateScopeType
string
Indicates that OPERA E-Certificate is available for a specific list of hotels.
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
actionStatusType
string
Action status of the Track It item(Open, Closed).
thresholdDetailsType
object
Type for the threshold elements.
5 properties
billingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
4 properties
eCertificateGenerationType
object
E-Certificates details.
3 properties
resInventoryItemSourceType
object
Defines whether the item is setup due to a Rate Plan, Package or a Block.
5 properties
eCertificatesType
array
List of e-certificates for the profile.
childBucketsType
object
Defines children counts with Age Qualifying Group(Child Bucket) classification.
5 properties
profileTaxInfoType
object
Profile information related to tax.
7 properties
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
reservationTransactionDiversionType
object
A Transaction Diversion Rule Type
16 properties
resInventoryItemsType
object
Defines a collection of inventory items attached to a reservation.
2 properties
blockSummaries
object
It also contains Success,Warnings and Errors related to this operation.
4 properties
profileRoutingInstructionsType
object
The type contains routing instructions for the profile.
3 properties
roomRateType
object
43 properties
vIPStatusType
object
VIP status of the customer.
2 properties
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
blockStatusChangesDetailType
object
6 properties
resProfileTypeType
string
blockAccessExclusionMessageType
object
Access exclusion message.
1 property
codeListType
array
blockStatisticsDateType
object
Holds the room type level statistics and total statistics for an allotment date.
3 properties
futureListType
object
A collection of reservation history details attached to Profiles.
4 properties
customChargeExemptionsType
array
List of Custom Charge Exemptions.
customChargeExemptionType
object
Contains custom charges exemption information.
6 properties
blockAllocationRange
object
Request for updating block allocation for a range of dates.
3 properties
trackItGroup
string
Group to which the Track It items belong.
reservationSnapshotsType
object
A collection of Reservation snapshot objects.
4 properties
activityLookUpList
array
Criteria for fetching Activity Bookings.
blockTotalAvailabilityInfoType
object
Captures total room availability information for the block by room type for the entire stay.
4 properties
reservationStayHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
packagePostingRhythmType
object
Package Posting rhythm type.
5 properties
associatedResType
object
Information regarding associated reservations to the reservation.
2 properties
subAllocationsType
object
A collection of Sub Allocations or Unique IDs of Sub Allocation.
4 properties
blockCopy
object
Request for creating a copy of an existing block.
4 properties
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
functionArgumentType
object
This type provided details of a function argument and the value it holds.
5 properties
blockWashSchedules
object
Response object to fetch all the Block Wash Schedules. Each Block Wash Schedule will contain all the information like Wash Date, Room Type, Occupancy detail, S…
3 properties
translationTextType80
object
Contains Multiple translated texts and language codes.
2 properties
articlePostItType
object
Post it information of an article.
2 properties
resDepositPolicyType
object
A deposit policy attached with the reservation.
6 properties
nameTypeType
string
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
rateProgramRateType
object
Room Pool Rate Program.
10 properties
payeeInfoType
object
Payee information.
7 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
blockStatisticsDetailsType
object
Collection of statistics details for every statistic type.
3 properties
resGuestAdditionalInfoType
object
8 properties
nameValueDataTypeType
string
recentlyAccessedBlockType
object
A recently used block record.
7 properties
userSessionDefaultsType
object
9 properties
hotelSummaryType
object
A brief summary of information about a hotel.
7 properties
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
guaranteeRequirementsType
object
Specifies various requirement for the guarantee code.
7 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
hotelReservationTraceType
object
Extended Trace object to hold information for a reservation.
16 properties
linkedReservationInfoType
object
20 properties
membershipType
object
Detailed information of the memberships.
41 properties
attachmentType
object
Attached files.
10 properties
historyListType
object
A collection of reservation history details attached to Profiles.
4 properties
callerType
object
Holds caller information.
11 properties
trackItId
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
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…
welcomeOfferType
object
2 properties
traceFrequencyType
object
Defines the trace frequency settings and associated parameters for creating reservation traces. Fields are conditionally required depending on the selected tra…
5 properties
blockDailyRevenueType
object
Base abstraction defining all details needed to create a statistical report.
11 properties
roomStayType
object
24 properties
cancelBlockType
object
ID information of the cancelled Block.
5 properties
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
profileCashieringDetailType
object
The type contains routing instructions for the profile.
6 properties
trackItLogListType
array
cateringEventsProcessedInfoList
array
Status/Info of the processed events.
trackItReservationInfoType
object
Reservation info associated with a Track It item.
9 properties
emailInfoType
object
Information on an email for the customer.
5 properties
resGuestType
object
A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which room is determined by each RoomStays ResGu…
6 properties
ratesType
object
Individual rate amount.
2 properties
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
cateringResInfoType
object
Information regarding catering event and catering revenue type associated to the reservation.
2 properties
facilityCodesType
array
List of the facility codes.
personNameTypeType
string
Person's name in an external system.
reservationTypeInfoType
object
3 properties
welcomeOfferOptionsType
string
None of the Welcome Offer option is selected.
blockRoomTypes
object
Response Object for FetchBlockRoomTypes operation.
3 properties
dateUDFsType
array
Used to hold collection of user defined fields of Date Type.
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
allocationRoomTypeInfoType
object
The information about the room types contained in the block room allocation.
19 properties
feeType
object
Applicable service charges or fees.
5 properties
dateUDFType
object
Used to hold user defined field of Date Type.
3 properties
roomingListShareType
object
Specifies a group of two or more rooming list reservations that need to be created as shared reservations.
3 properties
logUserInfoType
object
2 properties
uRLInfoType
object
Web site address.
5 properties
awardId
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
blockAvailabilityRatePlanInfo
object
Rate plan information including package details.
1 property
guestMessagesType
array
Holds the Message Information
validateToursRS
object
A response collection of tour series after validation.
1 property
resAttachedProfileType
object
3 properties
customCharUDFsType
array
Used to hold collection of custom user defined fields of Character/String Type.
paymentTypesType
array
Payment card code like AX,VI etc.
blockStatusTypeType
string
Simple type for specifying the block status type.
transactionDiversionDailyDetailsType
array
List of daily details for Transaction Diversion rule.
blockRangeInfoType
object
Block Information needed to perform a range operation.
2 properties
reservationLocatorType
object
Holds the information for a Reservation Guest Locator
6 properties
borrowRoomType
object
Specifies the number of rooms to be borrowed from the room type or House.
3 properties
taxTypeType
object
Provides information about the Tax Type.
8 properties
customNumericUDFsType
array
Used to hold collection of custom user defined fields of Numeric Type.
feesType
object
A collection of fees or service charges.
3 properties
traceBlockInfoType
object
Block information related to the trace.
4 properties
translationsTextType
array
Language code for the translation.
eCertificateIssueType
string
Indicates that guest purchased OPERA E-Certificate.
configPackagePrimaryDetailsType
object
A Config Package Info type.
6 properties
reservationSnapshotType
object
This is used when changing block reservations in bulk.
2 properties
externalReferencesType
array
This type contains unique information of external reference.
fixedChargeDetailType
object
Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.
7 properties
roomFeatureType
object
Room Feature Information.
4 properties
reservationPackageType
object
A ReservationPackageType class.
13 properties
sellMessageConfigsType
object
The SellMessageConfigsType is the list of sell messages, each comprising of all the sell message attributes and other details.
4 properties
blockAccessExclusionsType
object
Access Exclusion information indicating the actions allowed under a HUB or hotel for which the access exclusion is set.
7 properties
pMS_ResStatusType
string
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.
responseInstructionType
string
Response types used in the Apply Final Postings request. Based on the request the folio summary , folio details or no details will be returned in the response.
copySubBlockDetail
object
Details of sub blocks that will be copied along with the Source Master Block.
4 properties
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…
inventoryToReturnType
object
This holds the number of rooms for each date that will be returned to the room destination type provided.
3 properties
employeeInfoType
object
9 properties
accessRestrictionEnum
string
profileTypeType
string
The types of Profile handled by the web service.
cateringType
object
Contains catering related information for the block.
25 properties
changeBlockResvInstructionType
string
Sending this instruction would skip applying credit card payment types to other block reservations.
allocationGridByDateRangesType
object
A collection of Allocation objects for a block, such as Current Rooms, Original Rooms, Rate Amounts, etc.
2 properties
fetchInstructionsEnum
string
profileIdList
array
Unique Id that references an object uniquely in the system.
blockWashInfo
object
Block information required for performing a wash operation on a block.
3 properties
roomAllocationMasterInfoType
object
2 properties
recentlyAccessedBlocks
object
3 properties
primaryShareTypeType
string
routingInfoListType
array
A routing info object can either be of type Folio OR of type Room with its corresponding instructions.
fBAInfoType
object
FBA ( Flexible Benefits Awards ) related fields.
22 properties
prepaidCardDetailsType
object
Prepaid Card Details.
10 properties
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
links
array
blockRestrictionsType
object
List of restrictions belonging to a block.
3 properties
roomGridDetailsType
object
Indicates the values of room inventory or rate amount per room type.
4 properties
blockActivityLog
object
Response object for fetching block activity log. This object contains collection of user activity log for the block, Success, Warnings and Errors related to th…
3 properties
trackItType
object
Identifies the kind of Parcel, Baggage, or Lost items or Valet-managed vehicles or services.
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
awardStatusType
string
Indicates that certificate is in use.
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
eCertificateClassficationType
string
Enumeration of the different type of Ecertificate.
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
customFieldsType
object
A common type used to hold custom user defined fields(UDFs). This type should be used to handle custom UDFs on RReservation, Profiles, tc.
3 properties
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
personNameType
object
This provides name information for a person.
12 properties
getBlockExchangeInterfacesResponse
object
1 property
fBAStatusType
string
Flexible benefit award has been reimbursed.
scopeType
string
Minimum required and complimentary values are applicable Per Stay.
blockRevenueChanges
object
Response Object of details fetched of revenue log changes of selected block
9 properties
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
amountDeterminationType
string
Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.
blockDailyStatisticsDatesType
array
Collection of statistics detail for every allotment date.
statisticsSummaryType
string
Type of statistic for which summary information is populated.
blockDailyStatisticsInfoType
object
Information about Block daily statistics.
3 properties
resPaymentCardType
object
Information on a credit card for the customer.
19 properties
blockGridInvType
object
Indicates the inventory values ( occupancy or availability ) per person occupancy.
6 properties
blockCancellationTypeType
string
Simple type for cancellation reasons which helps to decide type of cancellation.
effectiveRateType
object
Effective rate amount per guest on specific dates.
22 properties
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
indicatorsType
array
Collection of lamp indicators.
trackItItemType
object
Detailed information of a Track It item.
14 properties
timeWindowType
object
Defines a Time period with start time and an end time.
2 properties
addtionalCodeInfoType
array
Holds name of additional code information
blockToBeChanged
object
Request object for change/modification of block details. This object contains modified block details with unique identifiers for each block. The standard optio…
3 properties
roomOwnershipType
object
Define the search criteria for retrieving room ownership records
9 properties
messageStatusType
string
Status of the Message.
uniqueID_Type
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
4 properties
telephoneType
object
Information on a telephone number for the customer.
11 properties
transactionDiversionRuleLevelType
string
Reservation level.
shiftedBlock
object
Response object for shift block operation.
3 properties
sellMessageConfigType
object
Only one of the following can hold a value: HotelCode, CROCode or ChainCode
17 properties
roomOrderType
object
4 properties
blockRoomsStatus
object
It also contains Success,Warnings and Errors related to this operation.
3 properties
nameValueModuleType
string
confDeliveryInfoTypes
array
List of confirmation letter delivery methods and their status
preferenceType
object
Guest Preference details for the profile.
8 properties
tierAdministrationType
string
Do not upgrade membership. The membership may be downgraded.
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
alertGuestInfoType
object
13 properties
roomRateAvailReasonType
string
Indicates the Room Rate is not available due to unavailability of enough items for the rate code.
guaranteeType
object
Specifies Guarantee Code attributes.
9 properties
blockRangeInfo
object
Response type for fetch block information for range operation.
3 properties
blockStatusChanges
object
Response object to fetch Status Logs for blocks.
9 properties
configPostingAttributesType
object
A config Package posting attributes type.
18 properties
blockType
object
35 properties
traceResolveType
object
2 properties
propertyLeadsType
object
Request object to create Property Leads.
1 property
authorizerInfoType
object
Authorizer Information
5 properties
subBlockIdList
array
Unique Id that references an object uniquely in the system.
tracesType
array
List of the traces
resCommunicationType
object
Communication details for a reservation.
2 properties
blockDetailInstructionType
string
Type for block instructions that can be used in requests for partial operations.
resourceDiscountTypeType
string
Indicates the option to select resources that will be discounted with the Resource Discount Percentage.
blockReservations
object
Response type for holding block reservations as part of the response to FetchBlockReservations operation.
3 properties
masterInfoType
object
2 properties
transportInfoType
object
7 properties
inventoryToBorrow
object
The standard optional Opera Context element is also included.
9 properties
hotelUseType
object
3 properties
packageTransactionCodeType
object
3 properties
blockAvailabilityInfoType
object
Captures room availability information for the block.
3 properties
resDepositPoliciesType
array
A list of deposit policies attached with the reservation.
reservationProfileType
object
3 properties
houseType
object
Returning an empty element of this type indicates the this is a House type. This is used in conjunction with the Borrow operations for Blocks where rooms are t…
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
reservationMembershipType
object
Detailed information of the memberships.
43 properties
overrideInstructionType
object
Type for Overrides. Contains information for the override action performed while booking a reservation.
4 properties
eventOrderType
object
Event order distribution information.
3 properties
applicationUserType
object
18 properties
blockDailyRoomStatisticsListType
array
Collection of room type level statistics.
itemInfoType
object
Basic information regarding an Item.
15 properties
blockOwnersType
object
Contains a list of block owners.
4 properties
basicEmailType
string
Email address
awardVouchersType
array
This stores the Membership Awards code applied on the reservation.
blockAllocationWash
object
Request object for block wash operation.
3 properties
blockOwnersToChange
object
Request object to change block owners.
3 properties
rateOverrideStatus
object
Response Body.
2 properties
createBlockPostingMasterCriteria
object
Criteria to create a new posting master reservation.
3 properties
profileCommissionType
object
This is the preconfigured routing instruction type.
7 properties
rateOverride
object
Request object of change block rate override operation.
6 properties
serviceRequest
object
Service request.
19 properties
identificationType
object
Identification information of the customer.
10 properties
articleInfoType
object
Information regarding an article.
9 properties
relationshipProfileType
object
12 properties
shiftBlockCriteriaType
object
9 properties
policyAmountPercentType
object
Defines the percentage basis for calculating the fee amount or the amount.
5 properties
resInventoryItemType
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
roomingListBlockInfoType
object
Block Information for create rooming list operation.
2 properties
customDateUDFsType
array
Used to hold collection of custom user defined fields of Date Type.
masterAccountInfoType
object
2 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.
blockChangesByDateTimeSummaryType
object
Block information for changed blocks by date time
11 properties
activityLogType
object
12 properties
blockAlternateDatesType
array
Contains a list of Block Alternate Dates.
masterType
string
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
recentlyAccessedBlocksType
array
A single recently accessed block.
phoneNumberType
string
Phone number
membershipTypeLevelType
object
2 properties
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
eCertificateConsumeSourceType
string
Indicates that OPERA E-Certificate is consumed by hotelPMS.
subAllocation
object
Request object for creation of Sub Allocation. This object contains sub allocation details with unique identifiers for each sub allocation along with Master Al…
4 properties
blockRestrictions
object
Response for FetchBlockRestrictions operation.
3 properties
eventTypeType
string
Contract type.
confRecipientInfoType
object
7 properties
upsellInfoType
object
Information regarding upsell for a reservation.
2 properties
roomTypeAttributesType
object
Attributes of property room type.
6 properties
roomAllocationCriteriaEnum
string
reservationCertificateType
string
Certificate is incentive.
awardKindType
string
Indicates that this is electronic certificate.
subAllocationType
object
Extended Block Type object to hold information for a Sub Allocation along with master allocation identification.
36 properties
preferenceTypeType
object
Preference details for the profile.
13 properties
attachmentsType
array
Attachment List.
miscTraceType
object
A collection of retrieved blocks and reservations traces.
3 properties
guestCountsType
object
A collection of GuestCount by age group.
4 properties
emailType
object
Information on an email for the customer.
10 properties
blockReservationDetailsType
object
Contains reservation related information for the block.
26 properties
ticketsType
array
Collection of TicketType objects.
orderTypeEnum
string
fixedChargeType
object
Holds fixed charge information.
8 properties
codeType
string
Used for codes in the OPERA Code tables. Possible values of this pattern are 1, 101, 101.EQP, or 101.EQP.X.
confDeliveryInfoType
object
4 properties
uRLType
object
Web site address, in IETF(The Internet Engineering Task Force) specified format.
5 properties
customChargeExemptionDatesType
array
Contains List of Custom Charge Exemption information for a day.
resStatClassificationType
object
Statistical Classification information for the reservation.
2 properties
companyType
object
10 properties
traceResvInfoType
object
Reservation information related to the trace.
8 properties
trxCodesInfoType
array
List of Transaction codes info.
sellLimitGridByDateRangeType
object
Indicates the sell limits for a date range. This will be rooms.
10 properties
roomTypeOrder
object
Request object for SetRoomTypeOrder operation.
3 properties
roomsStatusSummaryType
object
Contains Block's room status summary info.
7 properties
stayHistoryListType
object
A collection of reservation history details attached to Profiles.
4 properties
codeInfoType
object
4 properties
ratePlanChannelInfoType
object
3 properties
cateringRevenueToChange
object
Request object for changing the catering revenue for a business block.
7 properties
blockAvailability
object
Response for FetchBlockAvailability operation.
3 properties
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
reservationAllowedActionsType
array
Allowed action.
blockChanged
object
Response object for change/modification of block details. This object contains the block details with unique identifiers for each block. Also Success,Warnings…
4 properties
blockProfileTypeType
string
Simple type for block profile types.
vIPType
object
The supplier's ranking of the customer.
2 properties
searchMatchesType
array
List of Generic Name-Value-Pair Parameters used for super search matches.
copyBlockType
object
The source block will be used as a template to create the new copied block.
5 properties
blockRoomStatisticsType
object
Statistics information for the room type.
2 properties
blockWashScheduleType
object
Allows to select type of wash schedule: by number of rooms or by percentage.
4 properties
blockDailyStatisticsDateType
object
Holds the room type or generic room type(Room Pool) level statistics for an allotment date.
3 properties
languageType
string
taxType
object
Applicable tax element. This element allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, taxes should…
5 properties
blockAvailabilityMasterInfoType
object
Holds master information for block availability.
4 properties
marketCodeInfoType
object
4 properties
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
4 properties
userInfoType
object
Opera User Information
2 properties
gridRoomAllocations
object
4 properties
trackItItemsType
array
requestActionType
string
blockInventoryItemsType
array
Inventory item attached to a block.
confirmationType
object
11 properties
functionArgumentsType
array
Collection of function arguments and their corresponding values.
blockDetailsType
object
Information about the Block Details
56 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
fixedChargeFrequencyType
string
Yearly.
blockReservationsType
object
Collection of block reservations.
2 properties
blockSummariesType
object
Summary information returned during block search.
7 properties
resCancellationPoliciesType
array
A list of reservation cancellation policies.
blockWashInfoType
object
Block information and allocated room types information for performing a wash operation.
2 properties
anonymizationStatusType
string
Guest has been anonymized.
characterUDFType
object
Used to hold user defined field of Character/String Type.
3 properties
policyDeadlineType
object
Cancellation deadline, absolute or relative.
4 properties
packageElementType
object
15 properties
childAgeType
object
Defines Child's Age.
1 property
roomTypeInfoType
object
18 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
externalReferenceType
object
This type contains unique information of external reference.
3 properties
profileType
object
Type provides the detailed information about the profile and its children.
36 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
3 properties
changedCateringStatus
object
Response object for the request to change catering status. Response contains information on the block whose status was successfully changed.
7 properties
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
hotelInterfaceTypeType
string
XML Posting Interface
blockAccessExclusion
object
Request object for creating access exclusion permissions for a block.
3 properties
blockInventoryItemSourceType
object
Defines whether the item is setup due to a Rate Plan, Package or a Block.
3 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
#Block
Where this information came from
This is an independent, third-party profile of Oracle Hospitality Block 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.