5 Configurations

To properly use the post roomKeysOutbound API, the following configurations must be completed in the OPERA Cloud UI:

In OPERA Cloud PMS, configure an Outbound system interface for Outbound Type GUESTKEY_GENERIC per OPERA Cloud Property.

Configuring Outbound Systems

In OPERA Cloud PMS, configure required outbound domain/host entry to allow HTTPS connection from OPERA Cloud to the partner system.

Configuring Outbound domain/host

In OPERA Cloud PMS, configure a Property Interface for IFC TYPE DLS linked to the Outbound Door Lock Interface per OPERA Cloud Property.

Configuring Property Interface DLS IFC

In OPERA Cloud PMS Property Interface, the supported room key action types must be configured (New key, Duplicate key, One-shot key, Read key, Delete key) to display them in the OPERA Cloud PMS 'Create Key' screen.

Configuring room key action types

In OPERA Cloud PMS, configure if the Door Lock system is an ONLINE KEY System or OFFLINE System, or if it is a system providing PIN Codes instead of "hard keys." Related PMS Functionality will then be enabled.

Configuring DLS system type

In OPERA Cloud PMS, configure additional optional access area codes (KeyOptions). The user can choose these upon the create key request.

Configuring DLS access areas

Mandatory data the Door Lock system needs to retrieve to properly handle Room Keys:

To properly integrate to the OPERA Cloud Outbound system, the Door Lock system must know the Chain Code/Tenant Code and the unique HotelId for an OPERA Cloud property of the customer.

• HotelId - The Property Code that identifies the specific hotel. This is part of the URL path and is sent with every API message.
• PMS RoomId - The configured room numbers of the hotel. The roomId identifies the door lock for which the room key will be requested.

How to retrieve the HotelId and configured Room numbers:

• The customer can hand out the Chain Code, all hotelIds, and the configured room numbers that are used with the DLS integration.

• Alternatively retrieve the hotelIds and also the configured room numbers through API calls by subscribing to our Oracle Hospitality Integration Portal (OHIP) .

  With OHIP, you have the ability to consume more than 3000 APIs and automatically retrieve specific necessary configurations (such as defined Room numbers) or retrieve additional Reservation or Guest information, which is not part of the outbound Door Lock API.

  For more information about onboarding and working with OHIP, refer to the Getting Started section of the OHIP User Guide.

Retrieving a List of all HotelIds for a Chain

Use the OperationId: getResortChains (Postman Example)

Use this API to retrieve HotelId information for a selected Chain.

At least ONE HotelId (the Hotel's OPERA Cloud Property Code) must be obtained directly from the customer as this is used with the API call.

Sample: getResortChains

GET HostName /lov/v1/listOfValues/ResortChains

Response

{ "listOfValues": { "items": [ { "flexfields": [ { "parameterName": "ChainCode", "parameterValue": "OHIPSB" }, { "parameterName": "ChainName", "parameterValue": "OHIPSB" }, { "parameterName": "ChainDesc", "parameterValue": "OHIPSB" } ], "code": "SAND01", "name": "OHIP Sandbox 1", "description": "OHIP Sandbox 1", "active": true }, { "flexfields": [ { "parameterName": "ChainCode", "parameterValue": "OHIPSB" }, { "parameterName": "ChainName", "parameterValue": "OHIPSB" }, { "parameterName": "ChainDesc", "parameterValue": "OHIPSB" } ], "code": "SAND02", "name": "OHIP Sandbox 2", "description": "OHIP Sandbox 2", "active": true }, { "flexfields": [ { "parameterName": "ChainCode", "parameterValue": "OHIPSB" }, { "parameterName": "ChainName", "parameterValue": "OHIPSB" }, { "parameterName": "ChainDesc", "parameterValue": "OHIPSB" } ], "code": "SAND03", "name": "OHIP Sandbox 3", "description": "OHIP Sandbox 3", "active": true } ], "lovName": "ResortChains", "itemCount": 3 } }

With OHIP, you can retrieve the configured room numbers of a specific property, which you must configure on your system.

Suggested OHIP API Operation:

Retrieve a simple list of room number of the resort (HotelId).

Use the OperationId getResortRoomNumbers (Postman Example).

Use this API to fetch room numbers plus simple information for a selected HotelId. The response includes a list of all configured rooms at a property.

Note:

Room numbers can have leading zeroes (for example, "010", "0101", "0002"). Since there is no translation of room numbers planned, the external system (and the Door Lock System) should support room numbers with leading zeroes.

Sample: getResortRoomNumbers

GET HostName /lov/v1/listOfValues/hotels/HotelId/resortRoomNumbers

Response

{ "listOfValues": { "items": [ { "flexfields": [ { "parameterName": "Label", "parameterValue": "JSUI" }, { "parameterName": "ShortDescription", "parameterValue": "Junior Suite" } ], "code": "1000", "name": "2 Double Beds and 1 Simple Bed", "description": "2 Double Beds and 1 Simple Bed", "active": true }, { "flexfields": [ { "parameterName": "Label", "parameterValue": "JSUI" }, { "parameterName": "ShortDescription", "parameterValue": "Junior Suite" } ], "code": "1001", "name": "2 Double Beds and 1 Simple Bed", "description": "2 Double Beds and 1 Simple Bed", "active": true }, { "flexfields": [ { "parameterName": "Label", "parameterValue": "JSUI" }, { "parameterName": "ShortDescription", "parameterValue": "Junior Suite" } ], "code": "1002", "name": "2 Double Beds and 1 Simple Bed", "description": "2 Double Beds and 1 Simple Bed", "active": true },

Retrieve a detailed list of physical and/or pseudo rooms for a property:

Pseudo Rooms can be defined in OPERA Cloud PMS as rooms that are checked in for Conference Rooms. Related door Lock Ids are defined in the Door Lock System and can be linked to the Pseudo Rooms in OPERA Cloud Configuration.

Note that room numbers can have leading zeroes (for example, "010", "0101", "0002"). Since there is no translation of room numbers planned, the external system (and the Door Lock System) should support room numbers with leading zeroes.

use the OperationId: getRooms (Postman Example)

Use this API to fetch detailed information of rooms that exist for a specified property. The response will include a list of all existing physical and or pseudo rooms at that property.

Sample: getRooms

GET HostName /rm/config/v1/hotels/ hotelId /rooms?limit=&offset=&physical=&pseudo=&roomClassCodes=&roomTypeCode=

Useful query parameters:

Parameter	Type	Description
hotelId	String	Unique ID of hotel.
limit	Number (max 20)	Indicates maximum number of records a Web Service should return.
offset	Number	Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count, then no data will be returned.
physical	Boolean (true/false)	Is it a physical room type.
pseudo	Boolean (true/false)	Is it a pseudo room type.
roomClassCodes	Array
roomTypeCodes	Array
room	String	Room to be searched.

Response Listing all Rooms

{ "rooms": [ { "room": [ { "roomType": { "pseudo": false, "suite": false, "roomClass": "STD", "houseKeeping": true, "minimumOccupancy": 1, "maximumOccupancy": 1, "accessible": false, "roomType": "ECO", "meetingRoom": false }, "roomFeatures": [ { "code": "QBED", "description": "Queen Bed", "orderSequence": 1 }, { "code": "NEAR", "description": "Near elevator", "orderSequence": 11 }, { "code": "PET", "description": "Pet room", "orderSequence": 15 } ], "roomDescription": "Economy Room", "description": { "defaultText": "Economy Room", "translatedTexts": [] }, "accessible": true, "roomId": "101", "meetingRoom": true, "roomComponents": [], "connectingRooms": [ { "roomType": { "roomType": "ECO" }, "description": { "defaultText": "Economy Room" }, "roomId": "102" } ], "rateAmount": {}, "maximumOccupancy": 1, "sellSequence": 1, "ownerRoom": false, "keyOptions": [], "turndownService": false, "roomSection": {} }, { "roomType": { "pseudo": false, "suite": false, "roomClass": "STD", "houseKeeping": true, "minimumOccupancy": 1, "maximumOccupancy": 1, "accessible": false, "roomType": "ECO", "meetingRoom": false }, "roomDescription": "Economy Room", "description": { "defaultText": "Economy Room", "translatedTexts": [] }, "accessible": true, "roomId": "102", "meetingRoom": false, "roomComponents": [], "connectingRooms": [ { "roomType": { "roomType": "ECO" }, "description": { "defaultText": "Economy Room" }, "roomId": "101" } ], "rateAmount": {}, "maximumOccupancy": 1, "sellSequence": 1, "ownerRoom": false, "keyOptions": [], "turndownService": false, "roomSection": {} }, { "roomType": { "pseudo": true, "suite": false, "roomClass": "ALL", "houseKeeping": false, "maximumOccupancy": 1, "accessible": false, "roomType": "PM", "meetingRoom": false }, "roomDescription": "Posting Master", "description": { "defaultText": "PM IFC other 15", "translatedTexts": [] }, "accessible": false, "roomId": "9015", "meetingRoom": false, "roomComponents": [], "rateAmount": {}, "maximumOccupancy": 1, "ownerRoom": false, "keyOptions": [], "turndownService": false, "roomSection": {} }, { "roomType": { "pseudo": true, "suite": false, "roomClass": "PSE", "houseKeeping": false, "accessible": false, "roomType": "DPDP", "meetingRoom": false }, "roomDescription": "DP", "description": { "defaultText": "DP", "translatedTexts": [] }, "accessible": false, "roomId": "9200", "meetingRoom": false, "roomComponents": [], "rateAmount": {}, "ownerRoom": false, "keyOptions": [], "turndownService": false, "roomSection": {} }, { "roomType": { "pseudo": true, "suite": false, "roomClass": "ALL", "houseKeeping": false, "building": "1", "maximumOccupancy": 300, "accessible": false, "roomType": "BALLROOM", "meetingRoom": true }, "roomDescription": "Grand Ballroom", "description": { "defaultText": "West Sunset Room 1", "translatedTexts": [] }, "building": "1", "accessible": true, "roomId": "BALLROOM", "meetingRoom": true, "roomComponents": [], "rateAmount": {}, "ownerRoom": false, "keyOptions": [], "turndownService": false, "roomSection": {} } ], "hotelId": "SAND01" }

Example Guest Room

{ "roomType": { "pseudo": false, "suite": false, "roomClass": "STD", "houseKeeping": true, "minimumOccupancy": 1, "maximumOccupancy": 1, "accessible": false, "roomType": "ECO", "meetingRoom": false }, "roomFeatures": [ { "code": "QBED", "description": "Queen Bed", "orderSequence": 1 }, { "code": "NEAR", "description": "Near elevator", "orderSequence": 11 }, { "code": "PET", "description": "Pet room", "orderSequence": 15 } ], "roomDescription": "Economy Room", "description": { "defaultText": "Economy Room", "translatedTexts": [] }, "accessible": true, "roomId": "101", "meetingRoom": true, "roomComponents": [], "connectingRooms": [ { "roomType": { "roomType": "ECO" }, "description": { "defaultText": "Economy Room" }, "roomId": "102" } ], "rateAmount": {}, "maximumOccupancy": 1, "sellSequence": 1, "ownerRoom": false, "keyOptions": [], "turndownService": false, "roomSection": {} },

Example Post Master (Room Type PM)

{ "roomType": { "pseudo": true, "suite": false, "roomClass": "ALL", "houseKeeping": false, "maximumOccupancy": 1, "accessible": false, "roomType": "PM", "meetingRoom": false }, "roomDescription": "Posting Master", "description": { "defaultText": "PM IFC other 15", "translatedTexts": [] }, "accessible": false, "roomId": "9015", "meetingRoom": false, "roomComponents": [], "rateAmount": {}, "maximumOccupancy": 1, "ownerRoom": false, "keyOptions": [], "turndownService": false, "roomSection": {} }, { "roomType": { "pseudo": true, "suite": false, "roomClass": "PSE", "houseKeeping": false, "accessible": false, "roomType": "DPDP", "meetingRoom": false }, "roomDescription": "DP", "description": { "defaultText": "DP", "translatedTexts": [] }, "accessible": false, "roomId": "9200", "meetingRoom": false, "roomComponents": [], "rateAmount": {}, "ownerRoom": false, "keyOptions": [], "turndownService": false, "roomSection": {} },