Oracle Hospitality Event Management API
The Event APIs will allow you to retrieve, create, manage and delete events and related event functionality such as event resources, catering packages and even event waitlists.
Oracle Hospitality Event Management 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 Event Management. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 45 operations across 34 paths, and defines 564 schemas. It is described by OpenAPI 3.2.0, at version 26.2.0.0.
Requests are made against a single base URL, /evm/v1.
45 operations
34 paths
564 schemas
5 DELETE19 GET6 POST15 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 45
Across 34 paths, the API surfaces 45 operations — 5 DELETE, 19 GET, 6 POST, 15 PUT. Each is listed below with its method, path, parameters, and response codes.
EventManagement 45
The Event APIs will allow you to retrieve, create, manage and delete events and related event functionality such as event resources, catering packages and even event waitlists.
PUT
/alternateEvents
Manage alternate events.
POST
/blocks/{blockId}/cateringPackages
Add catering packages to a block
GET
/blocks/{blockId}/cateringPackages
Get Catering packages
PUT
/blocks/{blockId}/cateringPackages
Update a Catering packages
PUT
/blocks/{blockId}/cateringPackages/{cateringpackageId}/copy
Copy a Catering package
GET
/blocks/{blockId}/cateringPackages/{cateringpackageId}/revenue
Get Catering package revenue
POST
/blocks/{blockId}/cateringPackages/{cateringpackageId}/revenue
Add catering package revenue to a block
PUT
/blocks/{blockId}/events/{eventId}/resources/copy
Copy event resources
PUT
/blocks/{blockId}/events/{eventId}/resources/move
Move event resources
GET
/blocks/{blockId}/events/{eventId}/resources/{resourceId}
Get Resources for an Event
PUT
/cateringEvents
Update multiple catering events
PUT
/cateringPackagesRevenue
Update Catering package revenue
DELETE
/cateringPackagesRevenue
Delete Catering package revenue
PUT
/eventResource
Update Event Resource
GET
/eventcalendar
Get the event calendar for Multiple Properties
GET
/events
Get Events
POST
/events
Create an Event
DELETE
/events
Delete Multiple Events
GET
/events/{eventId}/splitQuantity
Get Event item split quantity
PUT
/eventsResources
Update Events Resources by chain
GET
/hotels/{hotelId}/block/{blockId}/resourceEvents
Get events for the block ID and resource ID(optional)
PUT
/hotels/{hotelId}/blocks/{blockId}/cateringEvents/copy
Copy Catering Event
DELETE
/hotels/{hotelId}/blocks/{blockId}/cateringPackages
Delete one or more catering package(s)
DELETE
/hotels/{hotelId}/blocks/{blockId}/cateringPackages/{cateringPackageId}
Delete Catering package
GET
/hotels/{hotelId}/blocks/{blockId}/events/changesByDateTime
Get modified events from a specific time period in OPERA.
GET
/hotels/{hotelId}/cateringEventChanges
Get Catering Event changes
GET
/hotels/{hotelId}/eventcalendar
Get the event calendar
GET
/hotels/{hotelId}/events
Get Events
GET
/hotels/{hotelId}/events/{eventId}
Get an Event
PUT
/hotels/{hotelId}/events/{eventId}
Update an Event
DELETE
/hotels/{hotelId}/events/{eventId}
Delete an Event
GET
/hotels/{hotelId}/events/{eventId}/cateringEventPostings
Get Catering Event postings
PUT
/hotels/{hotelId}/events/{eventId}/cateringEventPostings
Manage Catering Event postings
POST
/hotels/{hotelId}/events/{eventId}/eventResources/{quickInsertId}
Add Resource to an Event in a hotel by ID
POST
/hotels/{hotelId}/events/{eventId}/menus/{menuId}/menuItems
Add Menu Items to a Booked Menu
PUT
/hotels/{hotelId}/events/{eventId}/notes/copy
Copy event notes
GET
/hotels/{hotelId}/eventsResources
Get Event Resources
PUT
/hotels/{hotelId}/eventsResources
Update Events Resources
GET
/hotels/{hotelId}/fetchBlockPostingAccountReservations
Get Catering Event postings
GET
/hotels/{hotelId}/functionalSpace
Get hotel's function space availability
GET
/hotels/{hotelId}/functionalSpaceEvents
Get shared function space events
GET
/hotels/{hotelId}/waitListedEvents
Retreve Waitlisted Events
PUT
/hotels/{hotelId}/waitListedEvents
Manage Waitlisted Events
POST
/opportunityEvents
Create Events for Opportunity Block
GET
/services/eventManagement/status
This API facilitates status check of event management service.
Schemas 564
The contract defines 564 schemas that model the data the API accepts and returns. The most detailed are hotelReservationType (92 properties), eventSummaryInfoType (51 properties), eventItemType (50 properties), roomRateType (43 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.
eventsResources
object
Response object for fetching event resources.
3 properties
cardReIssueType
string
Request to re issue a new card.
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
resAccompanyGuestInfoType
object
5 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.
copyCateringEventsResponse
object
Response object for copying events.
3 properties
folioStatusType
string
The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status.
waitlistedEventType
object
Catering Event information.
19 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 functionSpaceDetails type.
2 properties
quickInsertResourceListType
object
Collection of quick insert resource(s).
3 properties
eventDisplayType
object
Display Information for the Function Diary Event.
9 properties
pkgInventoryItemType
object
4 properties
alertType
object
25 properties
characterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
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
indicatorType
object
Lamp indicator Type.
2 properties
fixedChargesType
array
Holds fixed charge detail.
blockRateProtectionType
object
Block Rate Protection code information.
2 properties
eventResource
object
Object containing event resource details.
3 properties
imageStyleType
string
An enumeration of image styles.
addressInfoType
object
Provides address information.
3 properties
warningsType
array
Used in conjunction with the Success elementSpace to define a business error.
eventSummariesInfoType
object
Collection of events.
7 properties
eventChangesByDateTimeSummary
object
1 property
transactionDiversionDailyDetailType
object
List of daily details for Transaction Diversion rule.
3 properties
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
eventItemsType
object
List of event items
3 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
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
customerType
object
Contains basic data on the customer's identity, location, relationships, finances, memberships, etc.
4 properties
callType
object
Holds call information.
11 properties
housekeepingRoomStatusType
string
Simple type for functionSpaceDetails status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup,…
dateTimeRangeType
object
Date Range with Start and End dates.
2 properties
excludedDateType
object
Specifies all the enabled dates.
2 properties
blockStatisticsSummaryType
object
Type to store summary detail like rooms sold, average functionSpaceDetails rate and revenue for a statistic type.
4 properties
dietaryPrefListType
array
eventsResourcesListType
array
Event resource information.
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
reservationPaymentMethodsType
array
Defines reservation payment methods.
manageWaitlistedEvents
object
Request object for managing waitlisted catering events.
5 properties
cardProcessingType
string
packageConsumptionType
object
Package Consumption Information. Includes information on quantity of the package used, allowance consumption etc.
4 properties
functionSpaceAvailabilityDetails
object
Response object for retrieving availability for catering function spaces.
3 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
eventMenuItemType
object
Detailed attributes of Menu Item.
36 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.
servingType
string
Serving
eventResourceNoteType
object
Contains the event resource's comment information.
11 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…
benefitsType
array
Basic information about membership benefit.
userSessionInfoType
object
11 properties
facilityTaskType
object
Information regarding facility task on a reservation.
3 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
sharedFunctionSpaceEventType
object
Pertain shared event Information.
10 properties
productSourceType
string
Sources of Products
waitlistedEventsSearchType
object
Request object for retrieving waitlisted and current events holding the function space.
6 properties
resAwardsType
object
Membership Awards code applied on the reservation.
4 properties
cateringEventChangeDetailType
object
4 properties
postingRhythmType
string
Simple type for posting Rhythm types.
sourceCodeInfoType
object
4 properties
surnameType
string
Family name, last name.
menuTypeType
string
Defines values for Menu Type
eventResourceDetailType
object
Detail information of resource which can be a Menu, Item or Space.
3 properties
ownerType
object
Generic type for information about an owner.
11 properties
bookingStatusDetailType
object
Booking Status details of the business block.
6 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
8 properties
2 required
menuItemIds
object
Request payload for adding configured menu items to a booked event menu.
1 property
1 required
reservationECertificateType
object
Reservation ECertificate Type Information.
3 properties
createCateringPackageProcessedInfoList
array
Status/Info of the processed package.
attendantType
object
2 properties
hotelReservationsType
object
A collection of Reservation objects and Unique IDs of Reservation.
4 properties
prepaidCardTrxTypeType
string
Reload transaction.
cateringStatusTypeType
string
List of Event Status Types to identify the current status of catering events.
uniqueIDListType
array
Unique Id that references an object uniquely in the system.
waitlistedEvents
object
Response object for retrieving waitlisted and current events holding the function space.
3 properties
operaVersionNumberType
string
Current Opera Version Number
compRoutingStatusType
string
Status which indicates that the Request of Comp Routing was declined
addressType
object
Provides address information.
10 properties
bookingStatusHistoryType
object
4 properties
eventMenuBasicInfoType
object
Pertain Details Information of Menu.
27 properties
folioShortInfoType
object
This type contains information of generated bills.
8 properties
nameValueDetailType
object
Detailed information returned during name value search.
1 property
eventCodeDetailType
object
Event Code details for a given date.
8 properties
serviceRequests
array
Service request.
totalType
object
The total amount charged for the service including additional amounts and fees.
11 properties
taxesType
object
A collection of taxes.
3 properties
copyCateringEvents
object
Request object for copying events.
2 properties
overrideInstructionsType
array
List of override actions done.
cateringEventPostings
object
Object for retrieving catering events postings.
4 properties
eventAttendeesType
object
Event attendees information.
2 properties
stayFutureListType
object
A collection of reservation history details attached to Profiles.
4 properties
blockCateringPackageDetails
object
Response object for adding Catering Package/Template Events to block.
3 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.
6 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
resourceCopyAndMoveListType
array
Resource Type and its UniqueID.
additionalGuestAmountType
object
2 properties
itemVendorType
object
Details of the Item Vendor.
8 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
eventMenusType
object
List of event menus.
3 properties
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
serviceRequestStatusType
string
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
blockProfilesType
object
A collection of Profile objects or Unique IDs of Profiles.
4 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
cateringEventLinkTypeType
string
A collection of supported list of link types for catering events.
resCancellationPolicyType
object
A cancellation policy attached with the reservation.
5 properties
relationshipInfoType
object
Relationship Type contains information about the associations between and among individuals, companies, travel agents, groups, sources, and contact profiles.
8 properties
depositCancelRevenueType
string
The type to indicate what revenue is to be used for calculating deposit/cancellation amounts.
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 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…
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
nameValueType
object
Contains name value pair.
6 properties
alertAreaType
string
roomStatisticsType
object
3 properties
cateringEventChanges
object
Response object for fetching event change logs.
9 properties
blocksType
object
A collection of Block objects or Unique IDs of Blocks.
4 properties
blockNonCompeteType
object
Block Non Compete code information.
4 properties
cateringRevenueType
object
Information about Catering Revenue.
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.
resourceEventsSummariesInfoType
object
Collection of events.
2 properties
reservationTransactionDiversionsType
array
List of Transaction Diversion rules.
reservationPackageScheduleType
object
A HotelPackageSchedule type.
8 properties
foreignExchangeType
object
Foreign Exchange info.
2 properties
resCashieringType
object
Cashiering Information for the reservation.
14 properties
hotelReservationType
object
The Reservation class contains the current reservation being created or altered.
92 properties
routingInstructionType
object
Routing limit can be one of the three: Credit Limit, Percetage Limit, Covers Limit
8 properties
reservationPaymentMethodType
object
7 properties
quickInsertResourceStatus
object
Status/Info of the processed resource(s).
3 properties
copyEventNoteType
object
4 properties
blockCateringPackageType
object
Details of Catering Package Type.
20 properties
mealPlansType
array
Meal plan codes associated with the rate codes.
itemVendorsType
array
List of Item Vendors.
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
statusColorType
string
Status code color configuration type.
cateringEventsBulkUpdate
object
Request object that will Change a list of events.
3 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
rateProtectionType
string
Simple type for specifying the block protection type.
dateTimeStampGroupType
object
5 properties
blockOwnershipType
string
Specifies the type of the owner associated with the business block(Block/Rooms/Catering).
timeSpanDaysOfWeekType
object
Container for Time span with days of week.
8 properties
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
cateringEventLinkType
object
3 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,…
3 properties
nameValueOriginType
object
Contains origin details.
4 properties
masterInfoCodeDetailType
string
eventItemInfoType
object
Information about event item.
2 properties
functionSpacesAvailabilityType
array
Collection of available Function Spaces.
status
object
Response Body.
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
sellMessagesType
object
The SellMessagesType is the list of message and attributes returned by web service.
4 properties
resourceId
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
restrictionStatusesType
string
eventCalendar
object
Return object to the request for the Events Booked/Scheduled for the function spaces in the Hotel for the particular time period.
3 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.
1 property
blockTraceType
object
Extended Trace object to hold information for a block.
16 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.
cateringEventsBulkUpdateStatus
array
Status/Info of the processed event(s).
trxInfoType
object
Transaction codes info.
10 properties
eventRevenuesInformationType
object
Collection of revenue information about a catering event.
5 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
callHistoryType
array
Holds call information.
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
resAttachedProfileListType
array
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
relationshipProfileSummaryType
object
11 properties
functionSpaceEvents
object
Response object for fetching events shared by function space.
3 properties
awardsType
array
List of awards.
ownerResTypeType
string
givenNameType
string
Given name, first name or names
eCouponType
object
Reservation eCoupon Type Information.
9 properties
transactionActionEnumType
string
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
events
object
Response object for fetching events.
5 properties
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
eventCodeTypeType
string
Determines if the block has any Non Compete configured
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
parametersType
array
Collection of generic Name-Value-Pair parameters.
cateringEventRevenueChangeListType
array
Event Revenue Changes Details
exclusionReasonType
string
Custom Charge has already been Processed for this date within the reservation stay.
cateringEventChangeType
object
3 properties
quickInsertResourceType
object
Quick insert resource type.
3 properties
messageType
object
Holds the Message Information
5 properties
rESTPaginationGroup
object
Provides Pagination Information for the REST API.
5 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
amountType
object
Base charge and additional charges related to a functionSpaceDetails that includes such things as additional guest amounts, cancel fees, etc. Also includes Dis…
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
opportunityEventDetailType
object
Information about the Catering Event which will be added to the Opportunity Block
8 properties
blockCateringPackageListType
array
Collection of multiple Catering Packages.
cancellationDetailsType
object
This type holds information regarding booking status change to Cancel/ Lost.
6 properties
itemAttributeType
object
Details of the Item Attribute.
5 properties
copyCateringPackageProcessedInfoList
array
Status/Info of the processed packages.
bookingStatusType
object
Booking status code, description and configured color of the status. This will be used for block and event statuses.
2 properties
guestMessageType
object
Holds the Message information for a Reservation
13 properties
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.
traceTimeInfoType
object
4 properties
eventProcessInstructionsType
object
Instructions to control how the event is created.
9 properties
stayReservationInfoType
object
The Reservation class contains the current reservation being created or altered.
6 properties
resourceEvents
object
Response object for fetching events.
3 properties
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
applyEventAttendeesChangesToEventsType
string
Non-Pkg Events on the same date.
waitlistedEventProcessingInstructionsType
string
A collection of supported processing instructions for waitlisted catering events.
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.
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
profileStatusType
string
eventMenuItemsType
array
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
billingInstructionsType
array
Set of Billing Instruction codes.
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.
10 properties
commissionPayoutToType
string
childAgesType
array
Age of a child in years.
ticketType
object
Reservation Ticket Type Information.
13 properties
opportunityEventInfoType
object
Catering Event information.
2 properties
rewardCertificateType
string
Point Saver reward.
cateringStatusChangeHistoryType
array
Collection of catering status history.
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
opportunityEvents
object
Object containing details of the catering events which will be added to the Opportunity Block.
4 properties
spaceAreaUnitType
string
Room Area in Square Meters.
cateringEventStatusChangeListType
array
Event Status Changes Details
manageAlternateEventsStatus
object
Response Body.
2 properties
blockOwnerType
object
Generic type for information about an owner.
12 properties
prepaidCardTransactionType
object
Prepaid Card transaction.
9 properties
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.
8 properties
nameValuesType
array
List of name value pairs.
datesType
array
Specifies a single date.
reservationIdList
array
Unique Id that references an object uniquely in the system.
routingInfoType
object
A routing info object can either be of type Folio OR of type Room with its corresponding object.
4 properties
eventSpaceAttributesType
object
Collection of the Events Booked/Scheduled for the function spaces in the Hotel for the particular time period.
7 properties
alertsType
array
List of alerts.
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
actionStatusType
string
Action status of the Track It item(Open, Closed).
manageAlternateEventsInstructionType
string
Collection of instructions for managing catering events those are alternate to other catering events.
copyCateringPackage
object
Request object for Copying Catering Package/Template to another block.
2 properties
blockPostingAccountReservationsType
array
Fetch block's posting account reservations information.
thresholdDetailsType
object
Type for the threshold elements.
5 properties
billingInstructionType
object
Configured Billing Instruction which represents a set of Transaction Codes.
4 properties
resInventoryItemSourceType
object
Defines whether the item is setupCode due to a Rate Plan, Package or a Block.
5 properties
childBucketsType
object
Defines children counts with Age Qualifying Group(Child Bucket) classification.
5 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
profileRoutingInstructionsType
object
The type contains routing instructions for the profile.
3 properties
roomRateType
object
43 properties
cateringEventPostingType
object
Pertain catering event's posting information.
9 properties
vIPStatusType
object
VIP status of the customer.
2 properties
blockPostingReservationsType
object
Contains the block's posting account reservation information.
15 properties
foliosShortInfoType
array
This type contains a list of generated bills for a reservation.
resProfileTypeType
string
codeListType
array
eventResourcesListType
array
Event resources information.
sellMessageType
object
The SellMessagesType defines the standard attributes that will be retrieved with the sell message.
14 properties
customChargeExemptionsType
array
List of Custom Charge Exemptions.
customChargeExemptionType
object
Contains custom charges exemption information.
6 properties
trackItGroup
string
Group to which the Track It items belong.
reservationSnapshotsType
object
A collection of Reservation snapshot objects.
4 properties
cateringPackages
object
Object containing list of catering packages associated to block.
3 properties
cateringPackageRevenue
object
Object containing revenue details of the associated catering package.
3 properties
copyCateringEventResourcesProcessedInfoList
object
Status/Info list of the processed event resources.
2 properties
reservationStayHistoryFutureInfoType
object
Information of History and Future Reservation details attached to Profiles.
2 properties
associatedResType
object
Information regarding associated reservations to the reservation.
2 properties
packagePostingRhythmType
object
Package Posting rhythm type.
5 properties
commentType
object
An indication of a new paragraph for a sub-section of a formatted text message.
19 properties
functionArgumentType
object
This type provided details of a function argument and the value it holds.
5 properties
eventMenuType
object
Information about event menu.
4 properties
cateringEventsAttendeesType
object
All different attendees that a catering event can have.
9 properties
cateringPackageInfoType
object
Catering Package details.
5 properties
articlePostItType
object
Post it information of an article.
2 properties
copyStatusModeType
string
Indicates to pick the default status based on the parameter for event.
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
payeeInfoType
object
Payee information.
7 properties
blockIdList
array
Unique Id that references an object uniquely in the system.
resGuestAdditionalInfoType
object
8 properties
nameValueDataTypeType
string
userSessionDefaultsType
object
9 properties
hotelReservationTraceType
object
Extended Trace object to hold information for a reservation.
16 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
blockCateringPackage
object
Request object for adding Catering Package/Template Events to block .
4 properties
eventPrimaryInfoType
object
Pertain event identifications.
3 properties
linkedReservationInfoType
object
20 properties
membershipType
object
Detailed information of the memberships.
41 properties
attachmentType
object
Attached files.
12 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
eventRevenueInformationType
object
Pertain event's revenue information.
13 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…
welcomeOfferType
object
2 properties
roomStayType
object
24 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
cateringEventChangeInfoType
object
9 properties
trackItLogListType
array
trackItReservationInfoType
object
Reservation info associated with a Track It item.
9 properties
targetEventIdWithHotelIdType
object
2 properties
emailInfoType
object
Information on an email for the customer.
3 properties
resGuestType
object
A collection of ResGuest objects, identifying the guests associated with this reservation. Which guests are in which functionSpaceDetails is determined by each…
6 properties
ratesType
object
Individual rate amount.
2 properties
opportunityBlockInfoType
object
Opportunity Block Information
3 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.
revenueTypeDetailType
object
Details type provides information about Catering Revenue Type Details.
1 property
eventChangesByDateTimeSummaryType
object
Event information for changed events by date time
8 properties
translationTextType2000
object
Contains Multiple translated texts and language codes.
2 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
feeType
object
Applicable service charges or fees.
5 properties
dateUDFType
object
Used to hold user defined field of Date Type.
3 properties
logUserInfoType
object
2 properties
eventSummaryInfoType
object
Contains information about an event.
51 properties
cateringPackageCopyInstructionType
string
Include Source status.
uRLInfoType
object
Web site address.
3 properties
guestMessagesType
array
Holds the Message Information
resAttachedProfileType
object
3 properties
blockStatusTypeType
string
Simple type for specifying the block status type.
eventSpaceScheduleType
object
Collection of the Events Booked/Scheduled for the function spaces in the Hotel for the particular time period.
8 properties
transactionDiversionDailyDetailsType
array
List of daily details for Transaction Diversion rule.
reservationLocatorType
object
Holds the information for a Reservation Guest Locator
6 properties
blockPostingAccountReservationsInfo
object
Response object for retrieving block Posting account reservations.
3 properties
feesType
object
A collection of fees or service charges.
3 properties
translationsTextType
array
Language code for the translation.
manageAlternateEvents
object
Request object for managing catering events those are alternate to other catering events.
4 properties
configPackagePrimaryDetailsType
object
A Config Package Info type.
6 properties
eventsInfoType
array
Pertain event information.
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
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
dietaryPrefType
object
Base type provides information about Catering Revenue Types Configuration.
2 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.
blockClassificationType
string
Simple type for block instructions to be used in requests for fetching blocks. Valid status values are MASTERBLOCK, MASTERTOUR, FITMASTER, MASTERALLOCATION, MA…
employeeInfoType
object
10 properties
profileTypeType
string
The types of Profile handled by the web service.
cateringType
object
Contains catering related information for the block.
24 properties
eventResourceNotesType
array
Contains event resource comment information.
resourceCopyAndMoveType
object
Holds Resource Type and its UniqueID
2 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
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
lightEventDetailType
object
Light Event Details.
3 properties
prepaidCardDetailsType
object
Prepaid Card Details.
10 properties
cateringEventBulkUpdateDetailType
object
Catering Event detail type.
17 properties
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
cateringEventPostingsDetail
object
Object for retrieving catering events postings.
4 properties
links
array
blockRestrictionsType
object
List of restrictions belonging to a block.
3 properties
translationTextType200
object
Contains Multiple translated texts and language codes.
2 properties
trackItType
object
Identifies the kind of Parcel, Baggage, or Lost items or Valet-managed vehicles or services.
2 properties
revenueSummaryType
object
Summary information pertaining to revenue like Room, Food and Beverage, Catering, Other, Catering Other and Total Revenue.
7 properties
packagePostingRulesType
object
5 properties
lightEventsDetailType
array
Pertain event few information about events.
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
quickInsertResources
object
Request object to add resource on an event in a hotel.
2 properties
namePrefixType
string
Salutation of honorific. (e.g., Mr. Mrs., Ms., Miss, Dr.)
personNameType
object
This provides name information for a person.
8 properties
functionSpaceAvailabilityType
object
The summary information for a function space.
24 properties
cateringEventResourceType
object
Event resource information.
29 properties
fBAStatusType
string
Flexible benefit award has been reimbursed.
scopeType
string
Minimum required and complimentary values are applicable Per Stay.
eventBookingInfoType
object
Booking information about the Function Diary Event.
29 properties
amountDeterminationType
string
Used to indicate if an amount is inclusive or exclusive of other charges, such as taxes.
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
statisticsSummaryType
string
Type of statistic for which summary information is populated.
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
resHousekeepingType
object
Holds housekeeping turndown service information for the functionSpaceDetails.
7 properties
indicatorsType
array
Collection of lamp indicators.
trackItItemType
object
Detailed information of a Track It item.
14 properties
resourceType
string
List of resource types.
cateringEventChangeSources
string
List of sources that can cause the event change
timeWindowType
object
Defines a Time period with eventStartDate time and an eventEndDate time.
2 properties
addtionalCodeInfoType
array
Holds name of additional code information
roomOwnershipType
object
Define the search criteria for retrieving functionSpaceDetails ownership records
9 properties
messageStatusType
string
Status of the Message.
revenueTypeDetailsType
array
List of Revenue details associated to a Revenue Type (Additional Details)
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,…
2 properties
telephoneType
object
Information on a telephone number for the customer.
4 properties
eventNoteType
object
Pertain event's comment information.
11 properties
waitlistedEventsGroupsType
array
Collection of events waitlisted for a function space.
waitlistedEventsType
array
Pertain waitlisted event Information.
transactionDiversionRuleLevelType
string
Reservation level.
sellMessageConfigType
object
Only one of the following can hold a value: HotelCode, CROCode or ChainCode
19 properties
nameValueModuleType
string
eventMenuRevenuesType
array
eventRevenueType
object
2 properties
preferenceType
object
Guest Preference details for the profile.
8 properties
eventMenuInfoType
object
Information about event menu.
2 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
4 required
alertGuestInfoType
object
13 properties
roomRateAvailReasonType
string
Indicates the Room Rate is not available due to unavailability of enough items for the rate code.
eventIdList
array
Unique Id that references an object uniquely in the system.
blockCateringPackageRevenueBaseType
object
Pricing detail of associated catering package.
7 properties
configPostingAttributesType
object
A config Package posting attributes type.
18 properties
blockType
object
23 properties
traceResolveType
object
2 properties
eventItemType
object
Inventory Items identification details.
50 properties
blockCateringPackageRevenueType
object
Type used for managing Revenue Details associated with a particular Catering Package Price Code.
9 properties
authorizerInfoType
object
Authorizer Information
5 properties
resCommunicationType
object
Communication details for a reservation.
2 properties
resourceDiscountTypeType
string
Indicates the option to select resources that will be discounted with the Resource Discount Percentage.
masterInfoType
object
2 properties
transportInfoType
object
7 properties
eventCodeDetailListType
array
Collection of the Event Codes in a Property for a particular time period.
cateringEventChangeListType
array
packageTransactionCodeType
object
3 properties
resDepositPoliciesType
array
A list of deposit policies attached with the reservation.
reservationProfileType
object
3 properties
itemAttributesType
array
List of Item Attributes.
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
eventInfoType
object
Catering Event information.
13 properties
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.
calendarEventInfoType
object
Contains Function Diary Events information.
23 properties
copyCateringEventsProcessedInfoList
array
Status/Info of the processed events.
pingDetail
object
Response for Ping operation.
3 properties
sharedFunctionSpaceEventsType
object
Collection of events shared by function space.
3 properties
serviceRequest
object
Service request.
19 properties
articleInfoType
object
Information regarding an article.
9 properties
relationshipProfileType
object
13 properties
policyAmountPercentType
object
Defines the percentage basis for calculating the fee amount or the amount.
5 properties
eventResources
object
Request object for copying/moving event resources.
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
itemRateType
object
Details of the Item Rate.
6 properties
masterAccountInfoType
object
2 properties
eventDetailType
object
Pertain Information about the Event Details
33 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.
masterType
string
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
phoneNumberType
string
Phone number
membershipTypeLevelType
object
2 properties
eventRevenueChangeType
object
8 properties
copyCateringEventsType
object
Criteria to copy events
8 properties
upsellInfoType
object
Information regarding upsell for a reservation.
2 properties
reservationCertificateType
string
Certificate is incentive.
eventCalendarType
object
Collection of the Events Booked/Scheduled for the function spaces in the Hotel for the particular time period.
6 properties
awardKindType
string
Indicates that this is electronic certificate.
preferenceTypeType
object
Preference details for the profile.
13 properties
attachmentsType
array
Attachment List.
guestCountsType
object
A collection of GuestCount by age group.
4 properties
emailType
object
Information on an email for the customer.
4 properties
eventNotesType
array
Pertain event information.
ticketsType
array
Collection of TicketType objects.
cateringEventCopyInstructionType
string
Include Event Forecast Figures.
fixedChargeType
object
Holds fixed charge information.
8 properties
event
object
Object containing details of the event.
3 properties
uRLType
object
Web site address, in IETF(The Internet Engineering Task Force) specified format.
5 properties
eventFunctionSpaceType
object
Pertain Information about the Function Space for events.
15 properties
companyType
object
9 properties
codeInfoType
object
4 properties
trxCodesInfoType
array
List of Transaction codes info.
changeRelationsType
object
Detailed information regarding the changes made to relationships for the profile.
5 properties
customChargeExemptionDatesType
array
Contains List of Custom Charge Exemption information for a day.
resStatClassificationType
object
Statistical Classification information for the reservation.
2 properties
stayHistoryListType
object
A collection of reservation history details attached to Profiles.
4 properties
cateringEventsBulkUpdateType
object
Collection of Event/Function Space Details and their Event IDs to be updated.
4 properties
itemRatesType
array
List of Item Rates.
revenueListType
array
Collection of revenues associated with packaged event.
eventStatusChangeType
object
6 properties
resCancelPenaltyType
object
The CancelPenalty class defines the cancellation policy of the hotel facility.
9 properties
reservationAllowedActionsType
array
Allowed action.
blockProfileTypeType
string
Simple type for block profile types.
vIPType
object
The supplier's ranking of the customer.
2 properties
manageEventsResources
object
Object containing details for managing events resources.
5 properties
blockWashScheduleType
object
Allows to select type of wash schedule: by number of rooms or by percentage.
4 properties
languageType
string
cateringEventChangeDetailListType
array
cateringEventBulkUpdateFunctionSpaceType
object
Function Space info type.
7 properties
taxType
object
Applicable tax elementSpace. This elementSpace allows for both percentages and flat amounts. If one field is used, the other should be zero since logically, ta…
5 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
trackItItemsType
array
requestActionType
string
blockInventoryItemsType
array
Inventory item attached to a block.
functionArgumentsType
array
Collection of function arguments and their corresponding values.
revenueTypeType
object
Base type provides information about Catering Revenue Types Configuration.
7 properties
spaceAreaType
object
Collection of the Events Booked/Scheduled for the function spaces in the Hotel for the particular time period.
2 properties
cateringEventChangeActions
string
A collection of supported list of actions.
blockDetailsType
object
Information about the Block Details
25 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
cateringEventItemsProcessedInfoType
object
Status/Info of the processed items.
9 properties
fixedChargeFrequencyType
string
Yearly.
copyCateringPackageResponse
object
Response object for copying packages.
3 properties
eventMenuRevenueType
object
Pertain Revenue Detail Information of the Menu.
9 properties
resCancellationPoliciesType
array
A list of reservation cancellation policies.
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
translationTextType60
object
Contains Multiple translated texts and language codes.
2 properties
resourceEventSummaryInfoType
object
Contains information about an event.
10 properties
childAgeType
object
Defines Child's Age.
1 property
cateringEventPostingsType
object
Collection of catering event postings.
2 properties
copyCateringPkgType
object
Criteria to copy catering packages
9 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.
18 properties
paragraphType
object
An indication of a new paragraph for a sub-section of a formatted text message.
3 properties
copyAndMoveEventResourcesType
object
Criteria to copy/move event resources
8 properties
eventResourcesResponse
object
Response object for copying/moving event resources.
3 properties
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
reservationLocatorsType
array
Holds the Locator Information.
blockInventoryItemSourceType
object
Defines whether the item is setupCode 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
#Event Management
Where this information came from
This is an independent, third-party profile of Oracle Hospitality Event Management 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.