Amadeus HotSOS

The interface communicates with an Amadeus HotSOS Server via REST-API.

Operation

The interface synchronizes only the room data and not the events. If this is required, please contact Antcas Support.

Note: The interface is very slow when sending. It may take a moment for the value to appear in the monitor.

Individual polls are made by the Antcas Server via HTTPS to the HotSOS portal. The API URL is fixed and cannot be changed. Rooms previously defined in the HotSOS application and in the Antcas Config are queried. The poll limit is 30 queries per minute by default. The Antcas Server strictly adheres to the set policy to reduce the load on the other side and the network. This means that it may take several minutes for a change to reach the Antcas Server.

When starting the server, messages are always retrieved first, followed by all status messages being transferred. If there is an interim change on the HotSOS side, this results in the status arriving at the PLC first and then being sent again.

If a connection error occurs, the query is automatically repeated after the timeout is reached. The error message appears only once in the monitor. If no connection is established within the set connection timeout, the interface is also declared offline.

Configuration

The target address is the server address without URI and https:// prefix.

Note: When using a proxy server, ensure that the URI path does not change.

Monitor

The monitor can display various sources. The following table explains all possibilities.

Source Description
Client Value coming from the HotSOS counterpart.
Server Value sent or read by Antcas Control.
System General system message.

Variables

Name Data Type Description
id string Sets the room number according to the interface.
make_up bool Request room cleaning.
service_status string Current service status of the room.
status string Status of the room.
name string Received room name.
dnd bool Do Not Disturb received.
occupied bool The room is occupied.

Note: Only the following values can be sent. All other values are not sent and marked in red in the monitor.

status

Value Description
CLEAN The room is clean.
DIRTY The room is dirty.
OUT_OF_ORDER The room is damaged.
OUT_OF_SERVICE The room is out of service.
INSPECTED The room has been inspected.
PICKUP The room is in the pickup status.

service_status

Note: Only the values AWAITING_SERVICE and DO_NOT_DISTURB can be sent.

Value Description
AWAITING_SERVICE The room is waiting for cleaning.
DO_NOT_DISTURB The guest does not want to be disturbed.
VACANT_CLEANED The room has been cleaned and is vacant.
OCCUPIED_CLEANED The room is cleaned and occupied.
CLEANING_STARTED Cleaning of the room has started.
SERVICE_REFUSED The guest has refused the service.
STOPPED Cleaning has been stopped.
TO_BE_INSPECTED The room needs an inspection.
INSPECTED The room has been inspected.
LATE_SERVICE The guest wants a late service.
RETURN_LATER The guest has requested a later return.