7 Edit Event Number of Attendees or Event Description
Business Context
The Events feature is designed to manage any kind of catering activity. Events can be as simple as a one-hour reception or more complex, such as a three-day business meeting with meals, breaks, and specific meeting rooms with setup and resource requirements. Any group function can be an event.
Events require many levels of organization including: booking a function space for the event, creating a food and beverage menu, and making sure all other resources needed for the event are available. Sometimes, you need to make changes to existing events; those changes could be updating the event description, changing the number of attendees, changing the price of an item, and so on.
Prerequisites
The below workflow diagram explains typical use cases for updating an existing event.
Customer — The groom wants to send the final number of attendees for his wedding this upcoming weekend.
Partner — The partner sends the request to update the number of wedding attendees so the customer (groom) can receive the response with the updated information.
OPERA Cloud — The application searches for the event ID, updates the current information with the correct number of attendees, and sends the updated event with the final number of wedding attendees.
Figure 7-1 Workflow Diagram
Table 7-1 Required Software Tools
| Tool | Description | Links |
|---|---|---|
|
Postman |
Postman is an API Platform that allows you to design, create and test API's. Use Postman to send API requests or to use the Postman collections provided. |
Table 7-2 Current Versions Required
| OPERA Cloud Platform Module | Description | Minimum Version |
|---|---|---|
|
OPERA Cloud Services |
The customer must have a subscription to OPERA Cloud Foundation |
|
|
Oracle Hospitality Integration Platform (OHIP) |
For customers, OHIP is included in the subscription to OPERA Cloud Foundation. Partners need a subscription to the Oracle Hospitality Integration Cloud Service. |
Configuration of OPERA Controls
To activate the Create Block functionality, you must ensure the following OPERA Controls are active in the target property. You can use the following API operations to validate the settings:
Ensure that application function EVENTS - CATERING EVENTS is active
RQ: ent/config/v1/settings?hotelId={{HotelId}}¶meterNameWildCard=CATERING EVENTS
Mandatory Fields - Available Values:
Function Space Configuration
Note:
This will return the codes available for Rental Code and Setup Styles which are required fields when creating an event with function space.
RQ: evm/config/v1/hotels/{{HotelId}}/functionSpaces/{{FunctionSpaceCode}}/configurations
Workflow
Step by step solution including:
Figure 7-2 The sequence of API calls (in any direction)
Description of Steps
A typical process to add or change a function space on an existing event is as follows:
- Search for function space availability for the event date(s) using getEventCalendar or getAvailableSpaces.
- Search for the event by block Id. If you know the internal event ID, then omit this step.
- Add or Update the function space assigned to the event using putEvent.
- Ensure the mandatory fields Event Type, Event Status Code, Start Time, End Time, and Expected Attendees are sent with valid values.
- If you are intending to assign a function space, ensure that the elements for Rental Code and Setup Styles are present and contain valid values.
Sample calls: Sample API calls for steps described in the diagram.
Sample for getEventCalendar
Check Function Space Availability
getEventCalendar
GET {{HostName}}/evm/v1/hotels/{{HotelId}}/eventcalendar?eventEndDate=2025-04-20&isSortDescending=false&showAvailableRooms=true&display=ALL&eventLabel=Booking&sortingBy=Name&eventStartDate=2025-04-20
200 response:
{
"eventCalendarDetails": {
"eventSpace": [
{
"description": "Chesapeake A",
"eventSpaceAttributes": {
"spaceArea": {
"area": 744,
"unit": "SqFeet"
},
"shareable": false,
"comboSpace": false,
"alternate": false,
"maximumOccupancy": 95,
"comboElement": true,
"comboRoom": "CHER"
},
"hotelId": "BHOTEL",
"roomId": "CHEA",
"name": "CHEA",
"building": "MAIN",
"roomOrder": 1
}
],
"eventCodes": [],
"sellMessages": {},
"totalRooms": 1
},
"links": [],
"warnings": []
} Sample for getAvailableSpaces
Check Function Space Availability
getAvailableSpaces
GET {{HostName}}/lov/v1/listOfValues/AvailableSpaces?parameterName=Event_Start¶meterName=Event_End¶meterName=HotelCode&includeInactiveFlag=false¶meterValue=2025-04-20+18:00:00.0¶meterValue=2025-04-20+19:00:00.0¶meterValue={{HotelId}}
200 response:
{
"listOfValues": {
"items": [
{
"flexfields": [
{
{
"flexfields": [
{
"parameterName": "AvailableYn",
"parameterValue": "Y"
},
{
"parameterName": "SetupCode"
},
{
"parameterName": "OccMin"
},
{
"parameterName": "OccMax"
},
{
"parameterName": "SetupTime"
},
{
"parameterName": "SetdownTime"
},
{
"parameterName": "RateCode"
},
{
"parameterName": "Rate"
},
{
"parameterName": "ShareableYn",
"parameterValue": "N"
},
{
"parameterName": "ForceAlternateYn",
"parameterValue": "N"
}
],
"code": "CHEA",
"name": "Chesapeake A",
"description": "Chesapeake A",
"active": true
} Sample for putEvent
Create Event with Space
PUT{{HostName}}/evm/v1/events
Body:
{
"eventDetails": [
{
"eventPrimaryInfo": {
"eventId": {
"type": "EventId",
"idContext": "OPERA",
"id": "641634"
},
"hotelId": "BHOTEL"
},
"eventDetail": {
"eventName": {
"defaultText": "Welcome Reception"
},
"eventType": "REC",
"eventTimeSpan": {
"startDateTime": "2025-04-20 18:00:00.0",
"endDateTime": "2025-04-20 19:00:00.0"
},
"eventStatus": {
"status": {
"code": "INQ"
}
},
"attendees": {
"expected": "30"
},
"doorcard": "Do Not Update KD API Block",
"notMoveable": false,
"loudEvent": false,
"displayDoorcard": true,
"includeSpaceInPackage": false
},
"processInstructions": {
"overrideCapacity": false,
"overbook": false,
"overrideMaxgroups": false,
"warnFunctionSpace": true
},
"eventBlockInfo": {
"blockIdList": [
{
"type": "Block",
"id": "919698"
}
],
"hotelId": "BHOTEL",
"markAsRecentlyAccessed": false
},
"functionSpaceInformation": {
"functionSpaceCode": "CHEA",
"functionSpaceDescription": "Chesapeake A",
"setupCode": "BQ10",
"setupTime": "30",
"setdownTime": "30",
"rentalCode": "CUSTOM",
"rentalAmount": {
"amount": "500"
}
}
}
}
]
}200 Response: Created
Sample for getEvent
Fetch Event
GET{{HostName}}/evm/v1/events?hotelId={{HotelId}}&eventId={{EventId}}
{
"eventSummaries": {
"eventSummary": [
{
"eventId": {
"type": "EventId",
"idContext": "OPERA",
"id": "641634"
},
"blockIdList": [
{
"id": "919698",
"type": "Block"
}
],
"blockName": "Do Not Update KD API Block",
"attendees": 30,
"functionSpaceDetails": {
"code": "CHEA",
"description": "Chesapeake A"
},
"rentalAmount": 500,
"functionSpaceSetup": {
"code": "BQ10",
"description": "Banquets 10 Chairs"
},
"eventStatus": {
"status": {
"code": "INQ",
"description": "Inquiry Non Deduct"
},
"color": "Blue"
},
"cateringStatusDeductInventory": false,
"cateringStatusReturnToInventory": false,
"setupTime": 30,
"tearDownTime": 30,
"masterEvent": false,
"subEvent": false,
"packageEvent": false,
"alternateEvent": false,
"displayDoorCard": true,
"doorCard": "Do Not Update KD API Block",
"excludeFromForecast": false,
"useForecastRevenue": true,
"minimumOccupancy": 1,
"maximumOccupancy": 60,
"loudEvent": false,
"rentalCode": "CUSTOM",
"eventShared": false,
"shareable": false,
"includeSpaceInPackage": false,
"hotelId": "BHOTEL",
"blockHotelCode": "BHOTEL",
"hasPostings": false,
"blockHasPostings": false,
"hasPartialPostings": false,
"allPosted": false,
"nothingPosted": false,
"eventStartDate": "2025-04-20 18:00:00.0",
"eventEndDate": "2025-04-20 19:00:00.0",
"type": "REC",
"eventName": "Welcome Reception",
"cateringCurrency": "USD",
"cateringQuotedCurrency": "USD"
}
],
"totalPages": 1,
"offset": 200,
"limit": 200,
"hasMore": false,
"totalResults": 1
},
"links": []
}200 Response: OK
References
-
For more information, review the Anti-Patterns chapter in the OHIP user guide to learn more about functional and technical anti-patterns.
-
Fore more information, refer to the Events topic in the OPERA Cloud Services user guide.