9 FAQ

Q. What is the maximum time to respond to a POST roomKeysOutbound request message?

  • The maximum time to respond to a POST roomKeysOutbound request message is 20 seconds. This is related to the maximum allowed call timeout within the OPERA Outbound service.

Q. The PMS user wants to have 3 room keys encoded/activated for the reservation. Will there be one API call sent with numberOfKeys = "3"?

  • The PMS sends out one API request call per room key to encode/activate. It awaits the corresponding response message prior to sending further request calls for the next room key to encode/activate and again waits for response from the door lock system prior to sending the request for the third room key.

Q. If the encoding/activation of a room key fails on the Door Lock System side, will the response be a common HTTP client error response (4xx)?

  • No, it is expected that the Door Lock System always sends back a HTTP 201 response message. Within the body of this message, we expect to receive a responseCode value and a user friendly responseText describing the reason of failure.

Q. Is it possible to send multiple roomKeysOutbound requests at the same time with different key EncoderIds to the Door Lock system through the Outbound system connection?

  • Yes, it is expected that multiple roomKeysOutbound requests for different key EncoderIds at same time can be handled by the Door Lock System.

Q. Does the Door Lock API include sending Guest or Reservation details, such as Guest Names?

  • The Door Lock API roomKeysOutbound only includes the necessary information needed to create a room key. It contains the reservationId but no further guest or reservation information/detail.

    To retrieve such additional information beside the room key information exchanged with this API, your system can subscribe to OHIP and consume related guest profile or reservation APIs.

Q. How can the Door Lock system be notified of a check-in or check-out of a reservation?

  • The Door Lock API roomKeysOutbound only includes the necessary information needed to create a room key. It contains the key validity information but it does not notify the external system that a guest / reservation has been checked-in or checked-out.

    To retrieve such additional information beside the room key information exchanged with this API, your system can subscribe to OHIP and consume related check-in/out notification by using the OPERA Cloud Business Events, either pulling these events or receiving them by streaming Business Events (push option).

Q. What are the keyTrack sub tags used for?

  • keyTrack1: The keyTrack1 tag can be used for a specific data string to be sent from OPERA Cloud PMS to the connected Door Lock System in case OPERA Cloud PMS does support the requested data. Could be room or guest specific information which the Door Lock System requests.

    Note that the PMS does not store incoming keyTrack1 data, it might pass the data through to external systems.

    Outgoing keyTrack1 data requires configuration in OPERA Cloud PMS interface set up.

  • keyTrack2: The keyTrack / keyTrack2 tag contains a unique Id which can either be created by OPERA Cloud PMS and is sent with the roomKeysOutbound request to let the door lock system store it on the key device.

    OR

    It will be sent by the door lock system in the related response message.

    It was common that the keyTrack2 was sent by OPERA Cloud PMS in the request, so it was written onto the Mag stripe of the door key card. Today it is more common that the Door Lock System sends the UDID of a key in the response message.

    In both cases, the keyTrack2 value will be stored in PMS and is linked to the reservation so that a guest can be identified by reading the door key “track2” value on another system and send an inquiry to the PMS. Usually used by Restaurant POS Systems.

  • keyTrack3: The keyTrack3 tag contains the unique Pin code provided by the Door Lock system which does use number pads on the guest room lock to enter a Pin to open the door. The Pin code will be stored in OPERA PMS as to enable the user to display and print the pin code to hand it out to the guest.

    To enable Pin code handling in OPERA Cloud, the related configuration parameter must be set in the OPERA Cloud Interface configuration.