3 Configurations

To start calling Property APIs, you must perform the following tasks:

OPERA Cloud PMS Prerequisites for Using Wake-Up Calls

  • The OPERA Cloud Function Wake Up Calls must be active.
  • Activate the function in /Applications/OPERA Controls/FrontDesk/ Wake-Up Calls.

Streaming Business Events for Wakeup Calls

To retrieve the streaming Business Event, the partner system must subscribe to the CREATE WAKE UP CALL, UPDATE WAKE UP CALL and DELETE WAKE UP CALL Streaming Business Events.

Ensure that the GraphQL subscription contains the primaryKey element. The primaryKey value equals the reservationId in these events. With this element, the partner system can link the Business Event to the reservation.

The reservationId is required in all wakeUpCalls API operations (POST, PUT, DELETE).

Refer to Streaming APIs in the Oracle Hospitality Integration Platform (OHIP) User Guide for more details on how to configure Streaming Business Events.

Wake-Up Call Time

The wake-up call time is always based on the timezone specific to the property.

Retrieve OPERA Cloud Rooms Configured for a Property

To retrieve the defined Rooms and its details from OPERA Cloud, use the Get Rooms operation.

Description Operation

Get the configured Rooms in OPERA Cloud that will be used for wake-up calls.

Usually, the Physical rooms are the rooms where Hotel guests reside and would have devices to receive wake-up calls. Therefore, the search filter for the API call would be "physical = true."

If the room information shows "pseudo": false in the response, this means the room is not a pseudo room. Pseudo rooms do not physically exist but are used for other purposes, and guests usually do not set wake-up calls for them.

Note:

It is possible that room numbers have leading zeroes (0 or 00) or even other prefixes (for example, a letter). OPERA Cloud expects that the connecting system can handle this.

There will be no translation/conversion for sending out room numbers without leading zeroes or other prefixes.

Get Rooms

GET {{HostName}}/rm/config/v1/hotels/{{HotelId}}/rooms?physical=true

200 response

{
    "rooms": [
        {
            "room": [
                {
                    "roomType": {
                        "pseudo": false,
                        "suite": false,
                        "roomClass": "ALL",
                        "houseKeeping": true,
                        "maximumOccupancy": 6,
                        "accessible": false,
                        "roomType": "CLASSIC",
                        "meetingRoom": false
                    },
                    "roomDescription": "Classic Room",
                    "description": {
                        "defaultText": "Classic Room",
                        "translatedTexts": []
                    },
                    "accessible": false,
                    "roomId": "001",
                    "meetingRoom": false,
                    "roomComponents": [],
                    "rateCode": "1-MBOERACK",
                    "rateAmount": {},
                    "maximumOccupancy": 6,
                    "ownerRoom": false,
                    "keyOptions": [],
                    "turndownService": false,
                    "roomSection": {}
                },
                {
                    "roomType": {
                        "pseudo": false,
                        "suite": false,
                        "roomClass": "ALL",
                        "houseKeeping": true,
                        "maximumOccupancy": 6,
                        "accessible": false,
                        "roomType": "CLASSIC",
                        "meetingRoom": false
                    },
                    "roomDescription": "Classic Room",
                    "description": {
                        "defaultText": "Classic Room",
                        "translatedTexts": []
                    },
                    "accessible": false,
                    "roomId": "002",
                    "meetingRoom": false,
                    "roomComponents": [],
                    "rateCode": "1-MBOERACK",
                    "rateAmount": {},
                    "maximumOccupancy": 6,
                    "ownerRoom": false,
                    "keyOptions": [],
                    "turndownService": false,
                    "roomSection": {}
                },
                {
                    "roomType": {
                        "pseudo": false,
                        "suite": false,
                        "roomClass": "ALL",
                        "houseKeeping": true,
                        "maximumOccupancy": 6,
                        "accessible": false,
                        "roomType": "CLASSIC",
                        "meetingRoom": false
                    },
                    "roomDescription": "Classic Room",
                    "description": {
                        "defaultText": "Classic Room",
                        "translatedTexts": []
                    },
                    "accessible": false,
                    "roomId": "01",
                    "meetingRoom": false,
                    "roomComponents": [],
                    "rateAmount": {},
                    "maximumOccupancy": 6,
                    "ownerRoom": false,
                    "keyOptions": [],
                    "turndownService": false,
                    "roomSection": {}
                },
                {
                    "roomType": {
                        "pseudo": false,
                        "suite": false,
                        "roomClass": "ALL",
                        "houseKeeping": true,
                        "maximumOccupancy": 6,
                        "accessible": false,
                        "roomType": "CLASSIC",
                        "meetingRoom": false
                    },
                    "roomDescription": "Classic Room",
                    "description": {
                        "defaultText": "Classic Room",
                        "translatedTexts": []
                    },
                    "accessible": false,
                    "roomId": "02",
                    "meetingRoom": false,
                    "roomComponents": [],
                    "rateAmount": {},
                    "maximumOccupancy": 6,
                    "ownerRoom": false,
                    "keyOptions": [],
                    "turndownService": false,
                    "roomSection": {}
                },
                {
                    "roomType": {
                        "pseudo": false,
                        "suite": false,
                        "roomClass": "ALL",
                        "houseKeeping": true,
                        "maximumOccupancy": 6,
                        "accessible": false,
                        "roomType": "CLASSIC",
                        "meetingRoom": false
                    },
                    "roomDescription": "Classic Room",
                    "description": {
                        "defaultText": "Classic Room",
                        "translatedTexts": []
                    },
                    "accessible": false,
                    "roomId": "1",
                    "meetingRoom": false,
                    "roomComponents": [],
                    "rateAmount": {},
                    "maximumOccupancy": 6,
                    "ownerRoom": false,
                    "keyOptions": [],
                    "turndownService": false,
                    "roomSection": {}
                },
                {
                    "roomType": {
                        "pseudo": false,
                        "suite": false,
                        "roomClass": "ALL",
                        "houseKeeping": true,
                        "maximumOccupancy": 6,
                        "accessible": false,
                        "roomType": "CLASSIC",
                        "meetingRoom": false
                    },
                    "roomDescription": "Classic Room",
                    "description": {
                        "defaultText": "Classic Room",
                        "translatedTexts": []
                    },
                    "accessible": false,
                    "roomId": "100",
                    "meetingRoom": false,
                    "roomComponents": [],
                    "rateCode": "EURO",
                    "rateAmount": {
                        "amount": 100
                    },
                    "maximumOccupancy": 6,
                    "ownerRoom": false,
                    "keyOptions": [],
                    "turndownService": false,
                    "roomSection": {}
                },
                {
                    "roomType": {
                        "pseudo": false,
                        "suite": false,
                        "roomClass": "ALL",
                        "houseKeeping": true,
                        "maximumOccupancy": 6,
                        "accessible": false,
                        "roomType": "CLASSIC",
                        "meetingRoom": false
                    },
                    "roomDescription": "Classic Room",
                    "description": {
                        "defaultText": "Classic Room",
                        "translatedTexts": []
                    },
                    "accessible": false,
                    "roomId": "101",
                    "meetingRoom": false,
                    "roomComponents": [],
                    "rateAmount": {},
                    "maximumOccupancy": 6,
                    "ownerRoom": false,
                    "keyOptions": [],
                    "turndownService": false,
                    "roomSection": {}
                },
                {
                    "roomType": {
                        "pseudo": false,
                        "suite": false,
                        "roomClass": "ALL",
                        "houseKeeping": true,
                        "maximumOccupancy": 6,
                        "accessible": false,
                        "roomType": "CLASSIC",
                        "meetingRoom": false
                    },
                    "roomDescription": "Classic Room",
                    "description": {
                        "defaultText": "Classic Room",
                        "translatedTexts": []
                    },
                    "accessible": false,
                    "roomId": "102",
                    "meetingRoom": false,
                    "roomComponents": [],
                    "rateAmount": {},
                    "maximumOccupancy": 6,
                    "ownerRoom": false,
                    "keyOptions": [],
                    "turndownService": false,
                    "roomSection": {}
                },
                {
                    "roomType": {
                        "pseudo": false,
                        "suite": false,
                        "roomClass": "ALL",
                        "houseKeeping": true,
                        "maximumOccupancy": 6,
                        "accessible": false,
                        "roomType": "CLASSIC",
                        "meetingRoom": false
                    },
                    "roomDescription": "Classic Room",
                    "description": {
                        "defaultText": "Classic Room",
                        "translatedTexts": []
                    },
                    "accessible": false,
                    "roomId": "103",
                    "meetingRoom": false,
                    "roomComponents": [],
                    "rateAmount": {},
                    "maximumOccupancy": 6,
                    "ownerRoom": false,
                    "keyOptions": [],
                    "turndownService": false,
                    "roomSection": {}
                },
            ],
            "hotelId": "{{HotelId}}"
        }
    ],
    "links": []
}}