OPERA Cloud Block Reservation Asynchronous API
APIs to cater Block Reservation related asynchronous functionality in OPERA. Compatible with OPERA Cloud release 26.2.0.0. 14 operation(s) documented; base path /blk/async/v1. Harvested verbatim from Oracle's public hospitality-api-docs repository (Swagger 2.0, release 26.2.0.0).
OPERA Cloud Block Reservation Asynchronous API is one of 135 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include BlockAsync, Property Management, and OPERA Cloud. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 21 operations across 14 paths, and defines 720 schemas. It is described by OpenAPI 2.0, at version 26.2.0.0.
21 operations
14 paths
720 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 720
The contract defines 720 schemas that model the data the API accepts and returns. The most detailed are hotelReservationType (93 properties), blockDetailsType (56 properties), reservationInfoType (52 properties), roomRateType (43 properties). Each schema is shown below with its type and property counts.
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
links
array
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
blockAllocationSummaryType
object
33 properties
blockProfilesType
object
A collection of Profile objects or Unique IDs of Profiles.
3 properties
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
uniqueID_Type
object
An identifier used to uniquely reference an object in a system.
2 properties
profileType
object
Type provides the detailed information about the profile and its children.
3 properties
customerType
object
Contains basic data on the customer's identity.
1 property
profileTypeType
string
The types of Profile handled by the web service.
personNameType
object
This provides name information for a person.
2 properties
companyType
object
1 property
blockProfileTypeType
string
Simple type for block profile types.
roomAllocationDateType
object
2 properties
roomAllocationDetailsType
object
9 properties
blockGridInvType
object
Indicates the inventory values ( occupancy or availability ) per person occupancy.
6 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
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
blockGridRatesType
object
Indicates the rate amount values per person occupancy.
5 properties
criteria
object
Request object for fetching block allocation summary asynchronously.
6 properties
blockAllocationSummary
array
Response object for fetched block allocation summary.
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
setBlockGridInvType
object
Indicates the inventory values (occupancy or availability) per person occupancy.
7 properties
allocationGridByDateRangeType
object
Indicates the block allocations for a date range. This can be rooms or rate amounts.
11 properties
allocationGridByDateRangesType
object
A collection of Allocation objects for a block, such as Current Rooms, Original Rooms, Rate Amounts, etc.
2 properties
sellLimitGridByDateRangeType
object
Indicates the sell limits for a date range. This will be rooms.
10 properties
allocationGridByRoomTypeType
object
A collection of Allocation objects for a block defined by room type.
3 properties
allocationGridByRoomTypesType
object
A collection of Allocation objects for a block defined by room type.
4 properties
allocation
object
A Request message that sets the room allocations as a collection of room types and dates.
3 properties
statusType
string
Status of the process.
codeDescriptionType
object
This contains a generic code and description information.
2 properties
cateringEventsProcessedInfoType
object
Status/Info of the processed events.
10 properties
cateringEventsProcessedInfoList
array
Status/Info of the processed events.
processDetails
object
Response object to hold the details of process.
4 properties
allocationType
string
Simple type for block allocation used in room rate grid.
blockRangeModeType
string
Enumerates range operation modes.
blockAllocationRangeType
object
Container for information related to block allocation range update operation
16 properties
blockAllocationRanges
object
Collection of block allocation ranges.
1 property
allocationRanges
object
Request for setting block allocation for ranges of dates for a list of room types.
4 properties
shiftBlockCriteriaType
object
7 properties
blockToShift
object
Request object to shift business block starting date.
3 properties
serviceRegistrationDetails
object
Response object for Service Permission registration.
5 properties
status
object
Response Body.
2 properties
operaVersionNumberType
string
Current Opera Version Number
downloadBlockMessageType
object
Holds the collection of error messages for downloaded blocks
5 properties
messageTypeType
string
Warning Type
errorsType
array
An error that occurred during the processing of a message.
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
blockSummariesType
object
Summary information returned during block search.
7 properties
blockSummaryType
object
41 properties
blockBasicInfo
object
Common Type used to store basic information of a block
5 properties
blockBasicInfos
object
Collection of basic block informatioin
1 property
blockInventoryControlType
string
Simple type for block inventory control values. This determines if it is a Non Elastic, Elastic or Sell Limits block.
bookingStatusType
object
Booking status code, description and configured color of the status. This will be used for block and event statuses.
2 properties
statusColorType
string
Status code color configuration type.
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
customCharUDFsType
array
Used to hold collection of custom user defined fields of Character/String Type.
characterUDFType
object
Used to hold user defined field of Character/String Type.
3 properties
customDateUDFsType
array
Used to hold collection of custom user defined fields of Date Type.
dateUDFType
object
Used to hold user defined field of Date Type.
3 properties
customNumericUDFsType
array
Used to hold collection of custom user defined fields of Numeric Type.
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
hotelUseType
object
3 properties
accessRestrictionsType
array
Block access exclusion/restriction type.
blockAccessRestrictionType
string
Simple type for block access exclusion/restriction types.
blockOwnersType
object
Contains a list of block owners.
4 properties
blockOwnerType
object
Generic type for information about an owner.
12 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
blockOwnershipType
string
Specifies the type of the owner associated with the business block(Block/Rooms/Catering).
personNameTypeType
string
Person's name in an external system.
telephoneInfoType
object
Information on a telephone number for the customer.
5 properties
telephoneType
object
Information on a telephone number for the customer.
11 properties
emailInfoType
object
Information on an email for the customer.
5 properties
emailType
object
Information on an email for the customer.
10 properties
indicatorsType
array
Collection of lamp indicators.
indicatorType
object
Lamp indicator Type.
2 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…
searchMatchesType
array
List of Generic Name-Value-Pair Parameters used for super search matches.
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
masterInfoType
object
2 properties
codeInfoType
object
4 properties
addtionalCodeInfoType
array
Holds name of additional code information
masterInfoCodeDetailType
string
masterType
string
gridRoomAllocations
object
4 properties
blocksType
object
A collection of Block objects or Unique IDs of Blocks.
4 properties
blockType
object
35 properties
blockInventoryItemsType
array
Inventory item attached to a block.
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
blockInventoryItemSourceType
object
Defines whether the item is setup due to a Rate Plan, Package or a Block.
3 properties
itemInfoType
object
Basic information regarding an Item.
15 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
timeWindowType
object
Defines a Time period with start time and an end time.
2 properties
dateRangeType
object
Date Range with Start and End dates.
2 properties
commentInfoType
object
Comment related to the profile/reservation.
9 properties
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
18 properties
formattedTextTextType
object
Provides text and indicates whether it is formatted or not.
2 properties
attachmentsType
array
Attachment List.
attachmentType
object
Attached files.
10 properties
dateTimeStampGroupType
object
5 properties
reservationPoliciesType
object
A collection of reservation deposit and cancellation policies.
4 properties
resCancellationPoliciesType
array
A list of reservation cancellation policies.
resCancellationPolicyType
object
A cancellation policy attached with the reservation.
5 properties
resCancelPenaltyType
object
The CancelPenalty class defines the cancellation policy of the hotel facility.
9 properties
policyDeadlineType
object
Cancellation deadline, absolute or relative.
4 properties
offsetUnitType
string
Indicates deadline offset unit type.
policyAmountPercentType
object
Defines the percentage basis for calculating the fee amount or the amount.
5 properties
policyBasisTypeType
string
Full Amount.
depositCancelRevenueType
string
The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.
resDepositPoliciesType
array
A list of deposit policies attached with the reservation.
resDepositPolicyType
object
A deposit policy attached with the reservation.
6 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
depositPolicyType
object
Used to define the deposit policy, guarantees policy, and/or accepted forms of payment.
12 properties
roomAllocationMasterInfoType
object
2 properties
allocationRoomTypeInfoType
object
The information about the room types contained in the block room allocation.
19 properties
roomFeaturesType
array
A recurring element that identifies the room features.
roomFeatureType
object
Room Feature Information.
4 properties
bookingChannelMappingType
object
4 properties
roomTypeAttributesType
object
Attributes of property room type.
6 properties
blockReservationDetailsType
object
Contains reservation related information for the block.
26 properties
breakfastType
object
Information about breakfast charges.
3 properties
blockRatePlanInfoType
object
Rate Plan info type extension for block.
19 properties
cancelPenaltyType
object
The CancelPenalty class defines the cancellation policy of the hotel facility.
10 properties
ratePlanChannelInfoType
object
3 properties
guaranteeType
object
Specifies Guarantee Code attributes.
9 properties
paymentTypesType
array
Payment card code like AX,VI etc.
translationTextType80
object
Contains Multiple translated texts and language codes.
2 properties
translationsTextType
array
Language code for the translation.
guaranteeRequirementsType
object
Specifies various requirement for the guarantee code.
7 properties
mealPlansType
array
Meal plan codes associated with the rate codes.
mealPlanCodeType
object
Meal plan codes associated with the rate codes.
5 properties
porterageType
object
Information about porterage charges.
2 properties
rateProgramType
object
Rate Programs for the Block.
2 properties
rateProgramRateType
object
Room Pool Rate Program.
10 properties
rateProgramRoomType
array
Room type for which Rate Program Rate Applies.
sellMessageConfigsType
object
The SellMessageConfigsType is the list of sell messages, each comprising of all the sell message attributes and other details.
4 properties
sellMessageConfigType
object
Only one of the following can hold a value: HotelCode, CROCode or ChainCode
17 properties
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…
blockTracesType
array
List of Block traces.
blockTraceType
object
Extended Trace object to hold information for a block.
13 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
traceResolveType
object
2 properties
traceTimeInfoType
object
4 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
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
anonymizationStatusType
string
Guest has been anonymized.
identificationInfoType
object
Information on the identification of the customer.
5 properties
identificationType
object
Identification information of the customer.
10 properties
companyInfoType
object
Company Information of the Profile.
3 properties
countryNameType
object
Code for a country or a nationality.
2 properties
profileMembershipType
object
Detailed information of the memberships.
41 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
3 properties
tierAdministrationType
string
Do not upgrade membership. The membership may be downgraded.
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.
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.
cardReIssueType
string
Request to re issue a new card.
benefitsType
array
Basic information about membership benefit.
benefitType
object
Basic information about membership benefit.
3 properties
profileRestrictions
object
3 properties
profileStatusType
string
reservationHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
historyListType
object
A collection of reservation history details attached to Profiles.
4 properties
reservationInfoType
object
The Reservation class contains the current reservation being created or altered.
52 properties
reservationIdList
array
Unique Id that references an object uniquely in the system.
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…
taxTypeType
object
Provides information about the Tax Type.
8 properties
resAttachedProfileListType
array
resAttachedProfileType
object
3 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
resProfileTypeType
string
resCommunicationType
object
Communication details for a reservation.
2 properties
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
resCashieringType
object
Cashiering Information for the reservation.
14 properties
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
4 properties
authorizerInfoType
object
Authorizer Information
5 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
9 properties
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
resCompAccountingType
object
Information regarding comp accounting on the reservation.
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
reservationDepositType
object
Reservation Deposit Type.
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.
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
interfaceRightsStatusType
object
4 properties
hotelInterfaceType
object
8 properties
hotelInterfaceTypeType
string
XML Posting Interface
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
reservationPaymentMethodType
object
7 properties
resPaymentCardType
object
Information on a credit card for the customer.
19 properties
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
cardProcessingType
string
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 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
reservationBlockType
object
Key information about the block for a reservation.
3 properties
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 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
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
reservationAllowedActionsType
array
Allowed action.
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
facilityCodesType
array
List of the facility codes.
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
reservationFolioWindowsType
array
Collection of reservation folio windows.
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
payeeInfoType
object
Payee information.
7 properties
addressInfoType
object
Provides address information.
5 properties
addressType
object
Provides address information.
17 properties
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
commissionPayoutToType
string
externalReferencesType
array
This type contains unique information of external reference.
externalReferenceType
object
This type contains unique information of external reference.
3 properties
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
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…
resSharedGuestListType
array
Collection of shared guest reservations.
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
32 properties
resAccompanyGuestListType
array
Collection of accompany guests
resAccompanyGuestInfoType
object
5 properties
givenNameType
string
Given name, first name or names
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
nameTypeType
string
surnameType
string
Family name, last name.
languageType
string
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
phoneNumberType
string
Phone number
basicEmailType
string
Email address
vIPType
object
The supplier's ranking of the customer.
2 properties
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
futureListType
object
A collection of reservation history details attached to Profiles.
4 properties
relationshipInfoType
object
Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.
4 properties
masterAccountInfoType
object
2 properties
relationshipProfileType
object
12 properties
uRLInfoType
object
Web site address.
5 properties
uRLType
object
Web site address, in IETF(The Internet Engineering Task Force) specified format.
5 properties
ownerType
object
Generic type for information about an owner.
11 properties
imageSetType
object
Represents on image set record.
11 properties
imageStyleType
string
An enumeration of image styles.
profileCashieringType
object
Contains cashiering related details for the profile
14 properties
directBillingType
object
This is the preconfigured routing instruction type.
2 properties
lastStayInfoType
object
Contains last stay related details for the profile
4 properties
roomOwnershipType
object
Define the search criteria for retrieving room ownership records
9 properties
eCertificatesType
array
List of e-certificates for the profile.
eCertificateType
object
E-Certificates details.
23 properties
eCertificateConsumptionType
object
E-Certificates details.
13 properties
eCertificateConsumeSourceType
string
Indicates that OPERA E-Certificate is consumed by hotelPMS.
eCertificateIssueSourceType
string
Indicates that OPERA E-Certificate is issued by external system.
eCertificateInfoType
object
E-Certificates details.
14 properties
eCertificateScopeType
string
Indicates that OPERA E-Certificate is available for a specific list of hotels.
eCertificateUsageCriteriaType
object
E-Certificates details.
8 properties
eCertificateGenerationType
object
E-Certificates details.
3 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
eCertificateStatusType
string
Indicates that OPERA E-Certificate is reserved.
eCertificateIssueType
string
Indicates that guest purchased OPERA E-Certificate.
privacyInfoType
object
Defines Privacy related information for the profile.
14 properties
profileTaxInfoType
object
Profile information related to tax.
7 properties
reservationStayHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
stayHistoryListType
object
A collection of reservation history details attached to Profiles.
4 properties
stayReservationInfoType
object
The Reservation class contains the current reservation being created or altered.
6 properties
stayFutureListType
object
A collection of reservation history details attached to Profiles.
4 properties
relationshipInfoSummaryType
object
RelationshipInfoSummaryType contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact p…
7 properties
relationshipProfileSummaryType
object
11 properties
relationshipAddressType
object
Provides address information for a Relationship.
5 properties
profileDeliveryMethod
object
Delivery Information type to the profile.
7 properties
profileDeliveryModuleType
string
Module where this delivery type will be used. Example : EFolio Export, EInvoice , Fiscal, etc..
preferenceTypeType
object
Preference details for the profile.
13 properties
preferenceType
object
Guest Preference details for the profile.
8 properties
profileCommissionType
object
This is the preconfigured routing instruction type.
7 properties
commissionPaymentMethods
string
Check
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
dateUDFsType
array
Used to hold collection of user defined fields of Date Type.
characterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
numericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
blockRestrictionsType
object
List of restrictions belonging to a block.
3 properties
blockRestrictionType
object
Restriction details for a block.
4 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
restrictionStatusesType
string
timeSpanDaysOfWeekType
object
Container for Time span with days of week.
8 properties
blockDetailsType
object
Information about the Block Details
56 properties
subBlockIdList
array
Unique Id that references an object uniquely in the system.
bookingStatusDetailType
object
Booking Status details of the business block.
10 properties
blockStatusTypeType
string
Simple type for specifying the block status type.
blockCancellationTypeType
string
Simple type for cancellation reasons which helps to decide type of cancellation.
blockRateProtectionType
object
Block Rate Protection code information.
2 properties
rateProtectionType
string
Simple type for specifying the block protection type.
datesType
array
Specifies a single date.
blockNonCompeteType
object
Block Non Compete code information.
4 properties
blockAliasesType
array
List of Block Aliases.
marketCodeInfoType
object
4 properties
blockSourceOfSaleType
object
Point of Sale of Block. Identifies the entity/channel who made the block reservation.
3 properties
sourceCodeInfoType
object
4 properties
blockNextStatusListType
array
Next booking status of the business block.
reservationTypeInfoType
object
3 properties
blockStatusChangeHistoryType
array
Collection of block status history.
bookingStatusHistoryType
object
4 properties
cancellationDetailsType
object
This type holds information regarding booking status change to Cancel/ Lost.
6 properties
blockAccessExclusionsType
object
Access Exclusion information indicating the actions allowed under a HUB or hotel for which the access exclusion is set.
7 properties
blockAccessExclusionMessageType
object
Access exclusion message.
1 property
blockAccessExclusionType
object
Access Exclusion information indicating the actions allowed under a HUB or Hotel for which the access exclusion is set.
7 properties
eventTypeType
string
Contract type.
roomAllocationTypeType
object
A collection of Allocation objects for a block, such as Current Rooms, Original Rooms, Rate Amounts, etc.
2 properties
roomAllocationInfoType
object
A collection of Allocation objects for a block that indicate room inventory or rate amounts.
5 properties
roomGridDetailsType
object
Indicates the values of room inventory or rate amount per room type.
4 properties
blockStatisticsType
object
4 properties
roomStatisticsType
object
3 properties
blockPackageType
object
This contains the full information and schedule of the block package.
8 properties
packageCodeHeaderType
object
4 properties
configPostingAttributesType
object
A config Package posting attributes type.
18 properties
functionArgumentsType
array
Collection of function arguments and their corresponding values.
functionArgumentType
object
This type provided details of a function argument and the value it holds.
5 properties
packagePostingRhythmType
object
Package Posting rhythm type.
5 properties
postingRhythmType
string
Simple type for posting Rhythm types.
packageCalculationRuleType
string
Simple type for package caluculation rules.
pkgInventoryItemType
object
4 properties
configPackageUsageDetailType
object
A Config Package Usage Detail type.
4 properties
productSourceType
string
Sources of Products
configPackageTransactionType
object
A HotelPackageTransaction type.
5 properties
packagePostingRulesType
object
5 properties
packageTransactionCodeType
object
3 properties
amountDeterminationType
string
Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.
configPackagePrimaryDetailsType
object
A Config Package Info type.
6 properties
packageConsumptionType
object
Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.
4 properties
cateringType
object
Contains catering related information for the block.
25 properties
cateringNextStatusListType
array
Next catering status of the business block.
eventOrderType
object
Event order distribution information.
3 properties
cateringStatusChangeHistoryType
array
Collection of catering status history.
cateringRevenueType
object
Information about Catering Revenue.
4 properties
applyEventAttendeesChangesToEventsType
string
Non-Pkg Events on the same date.
eventAttendeesType
object
Event attendees information.
2 properties
resourceDiscountTypeType
string
Indicates the option to select resources that will be discounted with the Resource Discount Percentage.
masterBlockInfoType
object
Basic information pertaining to the master block.
15 properties
masterSubBlockBaseInfoType
object
13 properties
hotelCodeListType
array
Hotel code.
blockAlternateDateType
object
Information for Alternate date types
4 properties
blockStatisticsSummaryType
object
Type to store summary detail like rooms sold, average room rate and revenue for a statistic type.
4 properties
revenueSummaryType
object
Summary information pertaining to revenue like Room, Food and Beverage, Catering, Other, Catering Other and Total Revenue.
7 properties
statisticsSummaryType
string
Type of statistic for which summary information is populated.
blockWashSchedulesType
array
Wash Schedule attached to the block, which allows to release inventory based on selected wash schedule type.
blockWashScheduleType
object
Allows to select type of wash schedule: by number of rooms or by percentage.
4 properties
blockDetailInstructionType
string
Type for block instructions that can be used in requests for partial operations.
roomsStatusSummaryType
object
Contains Block's room status summary info.
7 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
activityLogListType
object
7 properties
activityLogType
object
12 properties
blockRateCodeValidationType
object
Information for validation of block rate code.
4 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.
recentlyAccessedBlocksType
array
A single recently accessed block.
recentlyAccessedBlockType
object
A recently used block record.
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
borrowableInventoryType
object
This provides a collection of all borrowable room types by date.
6 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…
borrowInventoryType
object
This holds the number of rooms for each date that will be borrowed from the candidate room type provided.
3 properties
borrowRoomType
object
Specifies the number of rooms to be borrowed from the room type or House.
3 properties
inventoryToReturnType
object
This holds the number of rooms for each date that will be returned to the room destination type provided.
3 properties
returnRoomType
object
Specifies the number of rooms to be returned to a room type or House.
3 properties
changeBlockStatusType
object
This holds the information required to change the booking status of the business block.
12 properties
changeCateringStatusType
object
This holds the information required to change the catering status of the business block.
8 properties
blockChangesByDateTimeSummary
object
1 property
rESTPaginationGroup
object
Provides Pagination Information for the REST API.
5 properties
blockChangesByDateTimeSummaryType
object
Block information for changed blocks by date time
11 properties
externalIdType
object
2 properties
blockInternalStatusEnumType
string
transactionActionEnumType
string
blockRangeInfoType
object
Block Information needed to perform a range operation.
2 properties
blockAllocationWashType
object
Holds criteria for performing a wash operation on a block.
11 properties
blockWashInfoType
object
Block information and allocated room types information for performing a wash operation.
2 properties
roomOrderType
object
4 properties
blockAvailabilityType
object
Holds block availability information.
5 properties
blockHeaderInfoType
object
Holds block header details.
17 properties
blockAvailabilityMasterInfoType
object
Holds master information for block availability.
4 properties
currencyExchangeRateType
object
Currency code configuration.
5 properties
blockAvailabilityRoomTypeInfo
object
Room type information including packages and basic room type details.
4 properties
roomTypeInfoType
object
18 properties
packageElementType
object
15 properties
blockAvailabilityRatePlanInfo
object
Rate plan information including package details.
1 property
ratePlanCommissionType
object
3 properties
codeListType
array
blockAvailabilityInfoType
object
Captures room availability information for the block.
3 properties
blockAvailabilityRoomInfoType
object
Captures occupancy and rate information for a room type.
12 properties
blockTotalAvailabilityInfoType
object
Captures total room availability information for the block by room type for the entire stay.
4 properties
roomingListSharesType
array
Contains a set of rooming list reservations that need to be shared.
roomingListShareType
object
Specifies a group of two or more rooming list reservations that need to be created as shared reservations.
3 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
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…
effectiveRatesType
array
Collection of effective rate amount per guest on specific dates.
effectiveRateType
object
Effective rate amount per guest on specific dates.
22 properties
rateByAgeBucketsType
array
Rate amount by age bucket.
rateByAgeBucketType
object
Rate amount by age bucket.
3 properties
roomingListBlockInfoType
object
Block Information for create rooming list operation.
2 properties
roomingListReservationsType
object
If anyone or more reservations failed, then it specifies the associated error messages.
4 properties
roomingListReservationType
object
This is used when changing block reservations in bulk.
5 properties
hotelReservationType
object
The Reservation class contains the current reservation being created or altered.
93 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
visaInfoType
object
3 properties
profileCashieringDetailType
object
The type contains routing instructions for the profile.
6 properties
profileRoutingInstructionsType
object
The type contains routing instructions for the profile.
3 properties
trxCodesInfoType
array
List of Transaction codes info.
trxInfoType
object
Transaction codes info.
10 properties
articleInfoType
object
Information regarding an article.
9 properties
articlePostItType
object
Post it information of an article.
2 properties
colorType
string
Color configuration type. This color configuration provides a visual category of entities.
billingInstructionsType
array
Set of Billing Instruction codes.
billingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
4 properties
transportInfoType
object
7 properties
reservationPaymentMethodsType
array
Defines reservation payment methods.
eCouponsType
array
Collection of ECouponType object.
eCouponType
object
Reservation eCoupon Type Information.
9 properties
compAuthorizerInfoType
object
Authorizer Information
3 properties
routingInfoListType
array
A routing info object can either be of type Folio OR of type Room with its corresponding instructions.
routingInfoType
object
A routing info object can either be of type Folio OR of type Room with its corresponding object.
5 properties
routingInstructionType
object
Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit
8 properties
compRoutingRequestType
object
Type for the details of a Comp Routing Request
4 properties
compRoutingStatusType
string
Status which indicates that the Request of Comp Routing was declined
userInfoType
object
Opera User Information
2 properties
trackItItemsType
array
trackItItemType
object
Detailed information of a Track It item.
14 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
trackItGroup
string
Group to which the Track It items belong.
trackItReservationInfoType
object
Reservation info associated with a Track It item.
9 properties
trackItLogListType
array
trackItLogType
object
Individual activity log related to the Track It ticket.
9 properties
trackItActionType
object
Identifies the response expected from staff or other parties relative to a Track It ticket.
2 properties
actionStatusType
string
Action status of the Track It item(Open, Closed).
trackItType
object
Identifies the kind of Parcel, Baggage, or Lost items or Valet-managed vehicles or services.
2 properties
applicationUserType
object
18 properties
attendantType
object
2 properties
userSessionInfoType
object
11 properties
userSessionDefaultsType
object
9 properties
parametersType
array
Collection of generic Name-Value-Pair parameters.
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
employeeInfoType
object
9 properties
serviceRequests
array
Service request.
serviceRequest
object
Service request.
19 properties
serviceRequestStatusType
string
resInventoryItemsType
object
Defines a collection of inventory items attached to a reservation.
2 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
resInventoryItemSourceType
object
Defines whether the item is setup due to a Rate Plan, Package or a Block.
5 properties
callHistoryType
array
Holds call information.
callType
object
Holds call information.
11 properties
callerType
object
Holds caller information.
11 properties
cateringResInfoType
object
Information regarding catering event and catering revenue type associated to the reservation.
2 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
reservationTransactionDiversionsType
array
List of Transaction Diversion rules.
reservationTransactionDiversionType
object
A Transaction Diversion Rule Type
16 properties
thresholdDetailsType
object
Type for the threshold elements.
5 properties
scopeType
string
Minimum required and complimentary values are applicable Per Stay.
entityType
string
Indicates the rule is based on Minutes associated with the charge.
transactionDiversionDailyDetailsType
array
List of daily details for Transaction Diversion rule.
transactionDiversionDailyDetailType
object
List of daily details for Transaction Diversion rule.
3 properties
transactionDiversionRuleLevelType
string
Reservation level.
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…
membershipTypeLevelType
object
2 properties
guestMessagesType
array
Holds the Message Information
guestMessageType
object
Holds the Message information for a Reservation
13 properties
messageDeliveryType
object
Holds the Delivery Information of the Message
8 properties
messageStatusType
string
Status of the Message.
messageType
object
Holds the Message Information
5 properties
typeOfMessageType
string
The type of Message for Guest Messages.
reservationLocatorsType
array
Holds the Locator Information.
reservationLocatorType
object
Holds the information for a Reservation Guest Locator
6 properties
reservationProfileType
object
3 properties
activityLookUpList
array
Criteria for fetching Activity Bookings.
fetchActivityBookingsType
object
Used in the request message to describe the "filtering Criteria" when executing an activity lookup.
5 properties
activityList
array
A collection of Activity objects.
alertsType
array
List of alerts.
alertType
object
25 properties
alertAreaType
string
alertGuestInfoType
object
13 properties
membershipType
object
Detailed information of the memberships.
41 properties
vIPStatusType
object
VIP status of the customer.
2 properties
welcomeOfferType
object
2 properties
welcomeOfferOptionsType
string
None of the Welcome Offer option is selected.
nameValueDetailType
object
Detailed information returned during name value search.
1 property
nameValuesType
array
List of name value pairs.
nameValueType
object
Contains name value pair.
6 properties
nameValueDataTypeType
string
nameValueOriginType
object
Contains origin details.
6 properties
nameValueModuleType
string
customChargeExemptionsType
array
List of Custom Charge Exemptions.
customChargeExemptionType
object
Contains custom charges exemption information.
6 properties
excludedDatesType
array
Contains list of dates which are valid for custom charge exemptions.
excludedDateType
object
Specifies all the enabled dates.
2 properties
exclusionReasonType
string
Custom Charge has already been Processed for this date within the reservation stay.
customChargeExemptionDatesType
array
Contains List of Custom Charge Exemption information for a day.
customChargeExemptionDateType
object
Contains Custom Charge Exemption information for a day.
2 properties
customChargeQuantityType
object
Contains quantity of custom charge exemptions.
2 properties
overrideInstructionsType
array
List of override actions done.
overrideInstructionType
object
Type for Overrides. Contains information for the override action performed while booking a reservation.
4 properties
hotelReservationsType
object
A collection of Reservation objects and Unique IDs of Reservation.
4 properties
reservationPackageType
object
A ReservationPackageType class.
13 properties
reservationPackageScheduleType
object
A HotelPackageSchedule type.
8 properties
reservationMembershipType
object
Detailed information of the memberships.
43 properties
roomStayType
object
24 properties
ownerResTypeType
string
currentRoomInfoType
object
Room information of the reservation for the current day.
7 properties
roomRateType
object
43 properties
foreignExchangeType
object
Foreign Exchange info.
2 properties
totalType
object
The total amount charged for the service including additional amounts and fees.
10 properties
taxesType
object
A collection of taxes.
3 properties
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
feesType
object
A collection of fees or service charges.
3 properties
feeType
object
Applicable service charges or fees.
5 properties
resAwardsType
object
Membership Awards code applied on the reservation.
4 properties
awardVouchersType
array
This stores the Membership Awards code applied on the reservation.
roomRateAvailReasonType
string
Indicates the Room Rate is not available due to unavailability of enough items for the rate code.
guestCountsType
object
A collection of GuestCount by age group.
4 properties
childBucketsType
object
Defines children counts with Age Qualifying Group(Child Bucket) classification.
5 properties
childAgesType
array
Age of a child in years.
childAgeType
object
Defines Child's Age.
1 property
ratesType
object
Individual rate amount.
2 properties
rateRangeType
object
Rate Range details like maximum rate amount and minimum rate amount in each available rate category.
2 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
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
additionalGuestAmountType
object
2 properties
primaryShareTypeType
string
upsellInfoType
object
Information regarding upsell for a reservation.
2 properties
resStatClassificationType
object
Statistical Classification information for the reservation.
2 properties
prepaidCardsType
array
Holds fixed charge detail.
prepaidCardType
object
Holds fixed charge information.
17 properties
prepaidCardDetailsType
object
Prepaid Card Details.
10 properties
prepaidCardTransactionType
object
Prepaid Card transaction.
9 properties
prepaidCardTrxTypeType
string
Reload transaction.
hotelReservationTracesType
array
List of Reservation Traces.
hotelReservationTraceType
object
Extended Trace object to hold information for a reservation.
16 properties
resGuestAdditionalInfoType
object
8 properties
fixedChargesType
array
Holds fixed charge detail.
fixedChargeType
object
Holds fixed charge information.
8 properties
fixedChargeScheduleType
object
Holds schedule of fixed charge.
5 properties
fixedChargeFrequencyType
string
Yearly.
fixedChargeDetailType
object
Fixed charge amount could be specified by flat fee or be a percentage of the rate amount.
7 properties
reservationECertificatesType
array
Collection of ECertificateType object.
reservationECertificateType
object
Reservation ECertificate Type Information.
3 properties
requestActionType
string
eCertificateClassficationType
string
Enumeration of the different type of Ecertificate.
confirmationsType
array
List of confirmation letters.
confirmationType
object
11 properties
confRecipientInfoType
object
7 properties
profileNameType
object
This provides name information for a person.
8 properties
confDeliveryInfoTypes
array
List of confirmation letter delivery methods and their status
confDeliveryInfoType
object
4 properties
confDeliveryMethod
string
sentConfirmationStatus
string
confirmationStyle
object
7 properties
associatedResType
object
Information regarding associated reservations to the reservation.
2 properties
ticketsType
array
Collection of TicketType objects.
ticketType
object
Reservation Ticket Type Information.
13 properties
linkedReservationsInfoType
object
Linked Reservations.
7 properties
linkedReservationInfoType
object
20 properties
linkedReservationType
string
Enumeration of the different Linked Reservation Types.
awardsType
array
List of awards.
awardType
object
Detailed information of the awards.
34 properties
reservationCertificateType
string
Certificate is incentive.
awardKindType
string
Indicates that this is electronic certificate.
awardStatusType
string
Indicates that certificate is in use.
fBAInfoType
object
FBA ( Flexible Benefits Awards ) related fields.
22 properties
fBAStatusType
string
Flexible benefit award has been reimbursed.
rewardCertificateType
string
Point Saver reward.
blockStatisticsAllotedRoomsType
object
List of all room types with alloted rooms.
1 property
statisticsRoomTypeInfoType
object
Extended room type to store room category.
19 properties
blockStatisticsDetailsType
object
Collection of statistics details for every statistic type.
3 properties
blockStatisticsDetailType
object
Statistics Detail for a statistic type.
2 properties
statisticsType
string
Type of statistic for which its statistics information by date and room type will be populated.
blockStatisticsDatesType
array
Collection of statistics detail for every allotment date.
blockStatisticsDateType
object
Holds the room type level statistics and total statistics for an allotment date.
3 properties
blockRoomStatisticsListType
array
Collection of room type level statistics.
blockRoomStatisticsType
object
Statistics information for the room type.
2 properties
blockStatisticsInfoType
object
Information about availability, rate and allotment statistics.
5 properties
copyBlockType
object
The source block will be used as a template to create the new copied block.
5 properties
copySubBlockDetail
object
Details of sub blocks that will be copied along with the Source Master Block.
4 properties
newBlockDetailsType
object
This is used when creating a copy of a block.
14 properties
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.
tourSeriesType
object
This contains information as the block code, block name, block status regarding the blocks to be created as tour series.
7 properties
tourSeriesBlocksType
array
Contains tour series blocks information.
tourSeriesBlockType
object
Information about a tour series block.
9 properties
createBlockRestrictionType
object
Information for creating restrictions for a block.
13 properties
reservationSnapshotsType
object
A collection of Reservation snapshot objects.
4 properties
reservationSnapshotType
object
This is used when changing block reservations in bulk.
2 properties
changeBlockReservationsType
object
Criteria used to perform batch changes to reservations that belong to a block.
6 properties
blockReservationsCriteriaType
object
Indicates the filter criteria to identify the block reservations that should implement the same changes as the reference reservation.
3 properties
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
blockApplyChangesToType
string
Valid values are All, Same Arrival Date, Checked In, Selected, In House.
changeBlockResvInstructionType
string
Sending this instruction would skip applying credit card payment types to other block reservations.
changeBlockReservationType
object
Information about the block reservation being changed.
3 properties
blockReservationsType
object
Collection of block reservations.
2 properties
setBlockOwnersType
object
Criteria to update block owners.
4 properties
blockAlternateDatesType
array
Contains a list of Block Alternate Dates.
createBlockPostingMasterCriteria
object
Criteria to create a new posting master reservation.
3 properties
cancelBlockType
object
ID information of the cancelled Block.
5 properties
salesAllowancesType
array
Collection of Sales Allowances.
salesAllowanceType
object
A single sales allowances.
8 properties
salesAllowanceIDType
object
Unique identifier of a single sales allowance.
1 property
createSubBlockBaseInfoType
object
5 properties
subAllocationsType
object
A collection of Sub Allocations or Unique IDs of Sub Allocation.
4 properties
subAllocationType
object
Extended Block Type object to hold information for a Sub Allocation along with master allocation identification.
36 properties
blockWashSchedulesInfoType
object
The criteria based on which the block wash schedules will be created/ changed.
3 properties
blockStatusChangesDetailsType
array
Block Status Changes Details
blockStatusChangesDetailType
object
6 properties
logUserInfoType
object
2 properties
blockRevenueChangesDetailsType
array
Block Revenue Changes Details
blockRevenueChangesDetailType
object
7 properties
blocksDailyStatisticsType
array
A collection of Blocks.
blockDailyStatisticsDatesType
array
Collection of statistics detail for every allotment date.
blockDailyStatisticsDateType
object
Holds the room type or generic room type(Room Pool) level statistics for an allotment date.
3 properties
blockDailyRoomStatisticsListType
array
Collection of room type level statistics.
blockDailyRoomStatisticsType
object
Statistics information for the room type.
2 properties
blockDailyStatisticsInfoType
object
Information about Block daily statistics.
3 properties
tracesType
array
List of the traces
miscTraceType
object
A collection of retrieved blocks and reservations traces.
3 properties
traceType
object
16 properties
traceBlockInfoType
object
Block information related to the trace.
4 properties
traceResvInfoType
object
Reservation information related to the trace.
7 properties
blockStatReportType
object
Base abstraction defining all details needed to create a statistical report.
10 properties
hSKStatCategoryType
object
Defines the codes and corresponding categories for which the data in the other elements has been gathered.
5 properties
hSKStatCategoryCodeType
string
Supported housekeeping statistical category codes.
hSKStatSetType
object
Base statistic set holder which defines the span of the statistical data.
4 properties
hSKStatType
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…
4 properties
statUnitCategoryType
string
Supported statistical units.
hSKStatCodeType
string
Supported housekeeping statistical codes.
hSKStatReportCodeType
string
Supported Housekeeping report codes.
operaVersion
object
Response for Ping operation.
3 properties
blockDownloadLog
object
Request object for creating Block Download Log.
3 properties
blockSummaries
object
It also contains Success,Warnings and Errors related to this operation.
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
blockRoomsStatus
object
It also contains Success,Warnings and Errors related to this operation.
3 properties
roomAllocationCriteriaType
string
Simple type for block allocation used in room rate grid.
blockGridType
object
7 properties
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
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
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
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
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
recentlyAccessedBlocks
object
3 properties
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
inventoryToBorrow
object
The standard optional Opera Context element is also included.
9 properties
borrowedInventoryToReturn
object
The standard optional Opera Context element is also included.
8 properties
blockStatusToChange
object
Request object for changing the booking status of the business block.
6 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
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
cateringStatusToChange
object
Request object for changing the catering status of the business block.
4 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
blockAllocationRange
object
Request for updating block allocation for a range of dates.
3 properties
blockRangeInfo
object
Response type for fetch block information for range operation.
3 properties
blockAllocationWash
object
Request object for block wash operation.
3 properties
blockWashInfo
object
Block information required for performing a wash operation on a block.
3 properties
blockRoomTypes
object
Response Object for FetchBlockRoomTypes operation.
3 properties
roomTypeOrder
object
Request object for SetRoomTypeOrder operation.
3 properties
nextBlockStatus
object
Response object for FetchNextBlockStatus operation.
4 properties
defaultBlockCodeDetails
object
Response object that returns a default block code based on template.
3 properties
blockAvailability
object
Response for FetchBlockAvailability operation.
3 properties
shiftedBlock
object
Response object for shift block operation.
3 properties
roomingList
object
Request object for creating rooming list reservations. The standard optional Opera Context element is also included.
5 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
blockStatistics
object
The response object that returns Block Statistics information.
4 properties
blockAccessExclusion
object
Request object for creating access exclusion permissions for a block.
3 properties
blockAccessExclusionInfo
object
Response object for fetching block access exclusions for a block.
3 properties
blockCopy
object
Request for creating a copy of an existing block.
4 properties
tourSeries
object
Request for creating a tour series based on an existing block.
4 properties
validateToursRS
object
A response collection of tour series after validation.
1 property
validateTourRS
object
3 properties
blockRestrictions
object
Response for FetchBlockRestrictions operation.
3 properties
blockRestriction
object
Request for CreateBlockRestriction operation.
3 properties
allRestrictions
object
Request for clearAllRestrictions operation.
5 properties
blockPMReservations
object
The response object that contains the PM reservations belonging to a block.
3 properties
blockReservationsToChange
object
The request object to implement batch changes to block reservations based upon changes made to a reference reservation.
3 properties
changedBlockReservations
object
The response object that contains the reservations that were changed for a block along with the status of each change.
3 properties
blockReservations
object
Response type for holding block reservations as part of the response to FetchBlockReservations operation.
3 properties
blockAttachments
object
Return object to the request for information regarding block attachments.
3 properties
blockOwners
object
Response object that returns all sales manager owners associated with a business block.
3 properties
blockOwnersToChange
object
Request object to change block owners.
3 properties
blockOwnersToAssign
object
Request object to assign block owners.
3 properties
blockAlternateDates
object
Request object to create block alternate dates.
5 properties
blockPostingMaster
object
Request object for creating a new Posting Master Reservation.
3 properties
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
salesAllowances
object
Response returned by fetch corrected sales allowances.
3 properties
subBlock
object
Request object to create new sub block.
3 properties
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
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
blockWashSchedulesInfo
object
Request object to change multiple Block Wash Schedules under the selected block.
3 properties
blockStatusChanges
object
Response object to fetch Status Logs for blocks.
9 properties
blockRevenueChanges
object
Response Object of details fetched of revenue log changes of selected block
9 properties
blockDailyStatistics
object
Response Object of Fetch Block Daily Statistics.
9 properties
blockStats
object
Response element for block statistics.
3 properties
rateOverride
object
Request object of change block rate override operation.
6 properties
rateOverrideStatus
object
Response Body.
2 properties
tracesByDateRange
object
Fetch traces response.
3 properties
centralSalesLeadsType
object
Basic information about the Central Lead and its linked Property Leads.
2 properties
leadInfoType
object
9 properties
getBlockExchangeInterfacesResponse
object
1 property
setBlockExchangeInterfacesRequest
object
1 property
propertyLeadsType
object
Request object to create Property Leads.
1 property
cateringRevenueToChange
object
Request object for changing the catering revenue for a business block.
7 properties
blockDailyRevenueType
object
Base abstraction defining all details needed to create a statistical report.
11 properties
blockDailyRevenueStatistics
object
3 properties
blockDailyRevenueCategory
string
A collection of supported list of revenue category for Block Daily Revenue.
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
fetchBlocksFetchInstructionsType
string
Type for block instructions that can be used in requests for partial operations.
profileIndicatorsDetails
object
A complex type containing the collection of Indicator objects along with Unique IDs of Profiles.
1 property
profileIndicatorDetails
object
Indicator details for a bounded context.
3 properties
profileDetails
object
A complex type containing the collection of Indicator objects along with Unique IDs of Profiles along with profile Type.
1 property
profileDetail
object
Indicator details for a bounded context.
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 Distribution ARI Publication
OPERA Cloud Distribution Outbound Lookup
OPERA Cloud Distribution Content Notification
OPERA Cloud Distribution Book
OPERA Cloud Distribution Content
OPERA Cloud Distribution Property Controls
OPERA Cloud Distribution Reservation Service
OPERA Cloud Distribution Authentication API
OPERA Cloud Distribution Onboarding
OPERA Cloud Distribution Reservation Notification
OPERA Cloud Distribution Shop
Nor1 Integrated Upsell API
#BlockAsync#Property Management#OPERA Cloud
Where this information came from
This is an independent, third-party profile of OPERA Cloud Block Reservation Asynchronous 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.