Adapter - Dormakaba
This page describes version 2.0.5 of the adapter.
Overview
This adapter connects to a Dormakaba Lodging system and can be used to program a room key card on guest check in, create room key card copies, and unassigned any previously programmed room key on guest check out.
One of its typical use cases is to provide room key programming support for the Kiosk Client application.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| webServiceEndpoint | Dormakaba Web Service Endpoint Address | True | Dormakaba Web Service Endpoint address, starting with http:// or https://. | string | http:// | 1024 | |||
| userName | User Name | False | Enter the user name for an account with permissions to connect to Dormakaba Web Service. | string | 1024 | ||||
| password | Password | False | The password for the user id with permissions to connect to Dormakaba Web Service. | password | 1024 | ||||
| If the web service where the adapter connects does not use credentials, leave both the user name and the password empty. | |||||||||
| If you entered an user name, you must also enter a password. |
Commands
Create New Booking (createNewBooking)
Used to create a new key card for room access. Typically used when a guest checks in to the hotel using the Kiosk system.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| reservationNumber | Reservation Number | The guest reservation number provided by the PMS. Caution: the combination (reservation number + room) needs to be unique. | True | string |
| room | Room | The hotel room whose that can be opened with the encoded key card. Caution: the combination (reservation number + room) needs to be unique. | True | string |
| encoderId | Encoder ID | Unique identifier of the encoder device used to create the key. If 0 is used, the system will return encoded key data in the Access Key response field. | True | string |
| checkInDate | Check-In Date (yyyy-MM-dd HH:mm) | Guest check-in date. The key card validity starts with this date. | True | string |
| checkOutDate | Check-Out Date (yyyy-MM-dd HH:mm) | Guest check-out date. The key card validity ends at this date. | True | string |
| pmsTerminalId | PMS Terminal ID | PMS Terminal ID to be used. Caution - Dormakaba services allows only one request at a time per PMS Terminal ID. | True | string |
| siteName | Site Name | Name of the current hotel site. Used by Dormakaba services for information purposes only. | False | string |
| guestName | Guest Name | Guest name or key holder name. | False | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status of the command - true for success, false for failure | string |
| error | Error message in case of failure | string |
| accessKey | Encoded key card data as a base-64 string. Only provided when EncoderID = 0. | string |
Make Duplicate Key (makeDuplicateKey)
Used to create a key card for room access which is a clone of an existing key card. Typically used to create additional room keys after the main key was already created using the Kiosk system.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| reservationNumber | Reservation Number | The guest reservation number provided by the PMS. Needs to be the same number that was previously used with Create New Booking. | True | string |
| encoderId | Encoder ID | Unique identifier of the encoder device used to create the key. If 0 is used, the system will return encoded key data in the Access Key response field. | True | string |
| pmsTerminalId | PMS Terminal ID | PMS Terminal ID to be used. Caution - Dormakaba services allows only one request at a time per PMS Terminal ID. | True | string |
| siteName | Site Name | Name of the current hotel site. Used by Dormakaba services for information purposes only. | False | string |
| guestName | Guest Name | Guest name or key holder name. | False | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status of the command - true for success, false for failure | string |
| error | Error message in case of failure | string |
| accessKey | Encoded key card data as a base-64 string. Only provided when EncoderID = 0. | string |
Check Out Guest (checkOutGuest)
Used to forbid room access for a specified key. Typically used when the guest checks out from hotel using the Kiosk system.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| reservationNumber | Reservation Number | The guest reservation number provided by the PMS. Needs to be the same number that was previously used with Create New Booking. | True | string |
| pmsTerminalId | PMS Terminal ID | PMS Terminal ID to be used. Caution - Dormakaba services allows only one request at a time per PMS Terminal ID. | True | string |
| siteName | Site Name | Name of the current hotel site. Used by Dormakaba services for information purposes only. | False | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| status | Status of the command - true for success, false for failure | string |
| error | Error message in case of failure | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.3 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.5 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-12-05 |