KeyCard Interface (FIAS)
Casablanca Hotelsoftware has implemented the FIAS (Fidelio Interface and Application Specification) interface. Casablanca can take on the role of client or server.
The FIAS interface description can be download under the following link:
The following commands are possible via the interface in use with a key system:
In the following examples, Casablanca takes on the role of server.
Link Status
Establish connection
At the start of the connection it is defined which fields are to be initialised via the connection:
Example:
- Request1 (IN):
[STX]LS|DA201214|TI121114|[ETX] - Request2 (IN):
[STX]LD|DA201214|TI121116|V#1.4.2.2|IFDL|[ETX] - Request3 (IN):
[STX]LR|RIKR|FLK#KCKTRNWSDADTG#GNGAGDTIKO|[ETX] - Request4 (IN):
[STX]LR|RIKD|FLKCRNWSDATIG#|[ETX] - Request5 (IN):
[STX]LR|RIKA|FLASKCWSCTDATIG#$2$3|[ETX] - Request6 (IN):
[STX]LR|RIRE|FLRNG#DOCTDATI|[ETX] - Request7 (IN):
[STX]LA|DA201214|TI121118|[ETX] - Response (OUT):
[STX]LA|DA201214|TI121119|[ETX]
Check connection
A check whether the link is still upright is performed by the client every X minutes after the start of the connection.
Example:
- Request (IN):
[STX]LS|DA201214|TI121644|[ETX] - Response (OUT):
[STX]LA|DA201214|TI121644|[ETX]
Close connection
Example:
- Request (IN):
[STX]LE|DA201214|TI121026|[ETX]
Generate Key
When a guest checks in, the reception triggers the process to create a KeyCard. (It is also possible to create the KeyCard before the guest arrives. Fields GA - GD contain the period of stay)
Example:
- Request (OUT):
[STX]KR|K#1|KC1|KTN|RN206|WS1|DA201214|DT12:00|G#16400|GN|GA201215|GD201216|TI131253|KO|[ETX] - Response (IN):
[STX]KA|ASOK|CTOK|KC1|WS1|DA201214|TI131253|G#16400|$230431712|$3|[ETX]
As in the example, it would be possible to send back the unique ID of the RFID chip in track $2.
Key Options
It is also possible to transmit additional authorisations, which can be set individually by the reception, via the interface. The Key Option (KO) field is used for this purpose.
Example In the following example, authorisation is set with ID 1 and ID 2... (Spaces have been replaced by commas for better presentation)
- Request (OUT):
[STX]KR|K#1|KC1|KTN|RN206|WS1|DA201214|DT12:00|G#16400|GN|GA201215|GD201216|TI131253|KO11,,,,,,,,,,,,,,,,,,|[ETX]
In the following example, authorisation is set with ID 5... (Spaces have been replaced by commas for better presentation)
- Request (OUT):
[STX]KR|K#1|KC1|KTN|RN206|WS1|DA201214|DT12:00|G#16400|GN|GA201215|GD201216|TI131253|KO,,,,1,,,,,,,,,,,,,,,|[ETX]
Error-Codes
Here you will find the error codes for the FIAS interface. These can be returned via the interface as an answer.
| Code | Supported Interface Types | Meaning |
|---|---|---|
| AA | PBX - DID-Response | Virtual Number already assigned |
| AN | PBX - DID-Response | Virtual Number not found |
| BM | VSS/remote check-out | Balance mismatch |
| BY | Wakeup/Key Services | Telephone / Encoder Busy |
| CD | VSS/remote check-out | Check-out date is not today |
| DN | EFT | Request denied |
| FX | Guest related requests | Guest not allowed this feature |
| IA | Guest related requests | Invalid account |
| NA | All systems | Night Audit |
| NF | VSS/remote check-out | Feature not enabled or Check-out process not running |
| NG | All information requests | Guest not found |
| NM | Message/Locator request | Message/Locator not found |
| NR | Wakeup | No Response |
| OK | All systems | Command or request completed successfully |
| RF | EFT | Referral |
| RY | All systems | Retry |
| UR | All systems | Unprocessable request, this request cannot be carried out , no retry |