8 Key Terminology

You should review the key terminology for Room Keys and OPERA Cloud before using the APIs.

OPERA Cloud Room Keys Action Type	Description
New Key Request	A request to create a new key for a reservation. It is expected that all previous active keys for the reservation or room will become invalid.
Duplicate Key Request	A request to create additional keys for a reservation which already has active keys. It is expected that existing active keys for this reservation or room remain active.
Delete Key Request	A request to delete active key(s) for a reservation or room. It is expected that with this request all active keys for the reservation or room will become inactive or invalid, so guests will not be able to open the room after the defined validity End time.
Read Key Request	A request to the Key Card system to read Key Card information from the requested Key Encoder/reader. The Key Read functionality is of pure informational purpose. None of the received information is stored or processed in the PMS, and it is only to display key information to the user. Note: It requires related PMS configuration to activate this action type. For more information, refer to Configuring Property Interface Rights in the OPERA Cloud User Guide.
One-Shot Key Request	A request to create or activate a room key for a specific room. It is expected that the room key is only valid for a room for specific time (for maintenance or Show room). Note: A One-Shot key is never related to a reservation. It requires related PMS configuration to activate this action type.
Modify Stay Request	For Online Door Lock Systems, a request to adjust Room key data when guest changes length of stay (validityEnd). It requires related PMS configuration to activate this action type.
Room Move Request	Note: For Online Door Lock Systems, a request to adjust Room key data when guest performs room move. It requires related PMS configuration to activate this action type.
Re Encode Request	A request to re-encode a room key. Usually only utilized when PMS has the "Multiple Guest per room" functionality activated, which allows you to choose a specific room key for re-encoding. It is expected that existing active keys for this reservation or room remain active. Note: It requires related PMS configuration to activate this action type.
Lost Key Request	A request to create a new room key for a reservation or room. Usually only utilized when PMS has the "Multiple Guest per room" functionality activated, which allows you to choose a specific room key for re-encoding. It is expected that all previous active keys for the room will become invalid. Note: It requires related PMS configuration to activate this action type.
responseCode	Each response message for a corresponding request message must have a responseCode value. This code indicates if the request has been successfully processed or not. Specific codes will indicate a reason why a request failed. Following "responseCode": values are supported: "OK" = Successful "BY" = Encoder Busy "UR" = Unprocessable Request "RY" = Retry
"Offline" and "Online" Door Lock System
What is the Offline Door Lock System?	OPERA Cloud PMS considers an "Offline Door Lock System" a system where the information necessary to allow access to a door is stored on the room Key (or similar media) that the related door Lock reads.
What is the Online Door Lock System?	OPERA Cloud PMS considers an "Online Door Lock System" a system where the information necessary to allow access to a door is stored in the System's database, despite being stored on the room key (or similar media). Such systems typically have the Door Lock being wired with the Door Lock System's database.
Room Move handling with offline Door Lock System	OPERA Cloud PMS handles Room move requests in a different way depending on whether it is connected to an Offline or Online Door Lock System. When connected to an "Offline Door Lock System," OPERA Cloud PMS sends a "Remove" Key request for the old room number to inactivate current active keys and will then send a Request for "New" (and "Duplicate") keys for the new room number. It is then required that the Hotel guest must visit the Front Desk to get the new room key(s).
Room Move handling with Online Door Lock System	When connected to an "Online Door Lock System," OPERA Cloud PMS sends requests with a different message type in case relevant data that a reservation will change. For example upon "Room move" of a reservation (guest moves to another room), OPERA Cloud will send a request with keyType "RoomMove" containing information of the old room and the new room number, so the Door Lock System would only need to change the data in its database. Thus, there is no need for the guest to have the room key re-encoded at the Front Desk.
Reservation data change with offline Door Lock System	When connected to an "Offline Door Lock System" and, for example, the reservation's check out date changes, OPERA Cloud PMS will send a "Remove" Key request for the reservation or room number to inactivate the current active keys. OPERA Cloud will then send a Request for "New" (and "Duplicate") keys for the reservation or room number with the updated check out date (here the keyValidityEnd). It is then required that the Hotel guest must visit the Front Desk to get the new room key(s).
Reservation data change with Online Door Lock System	When connected to an "Online Door Lock System" and, for example, the reservation's checkout date or time changes, the PMS will send a request message with keyType "ModifyStay" containing the updated checkout date (here the keyValidityEnd). The updated information is stored in the Door Lock System's database.
Note: Above room Key actions for the Create Room Keys menu need to be configured in the Interface Rights section of the Property Interface Configuration. See details in the OPERA Cloud User Guide.
Date & Time field format	The Date/Time format for the "keyValidityStart":, "keyValidityEnd":, "keyRequestTime":, "keyCreationTime": fields in PostRoomKeysOutbound request and response will conform to ISO8601 standard whereby Oracle/OPERA expects a max 3 character of milliseconds. The expected format for above values is: "yyyy-mm-ddThh:mm:ss[.mmm]Z" (for example, 2025-01-20T22:26:00.000Z).