Rajapinta kommunoi Amadeus HotSOS-palvelimen kanssa REST-API:n kautta.
Rajapinta synkronoi vain tiloihin liittyvät tiedot, ei tapahtumia. Jos tämä on tarpeen, ota yhteyttä Antcasin tukeen.
Huomautus: Rajapinta on hyvin hidas lähettämisessä. Se voi kestää hetken ennen kuin arvo ilmestyy monitoriin.
Antcas-palvelimelta tehdään yksittäisiä pyyntöjä HotSOS-portaaliin HTTPS:n kautta. API-osoite on kiinteä ja sitä ei voi muuttaa. Tällöin kyselytään tiloja, jotka on määritelty aiemmin HotSOS-sovelluksessa ja Antcas Configissa. Pyyntöraja on oletuksena 30 kyselyä minuutissa. Antcas-palvelin noudattaa tiukasti asetettua ohjetta, jotta vastapuolen ja verkon kuormitus vähenee. Tämä tarkoittaa sitä, että muutokseen voi kestää joitakin minuutteja ennen kuin se saapuu Antcas-palvelimelle.
Palvelimen käynnistämisen yhteydessä haetaan ensin viestit ja sen jälkeen kaikki tilanviestit lähetetään. Jos HotSOS-puolella tapahtuu muutoksia välissä, tämä johtaa siihen, että tila saapuu ensin SPS:ään ja sitten se lähetetään uudelleen.
Jos yhteysvirhe ilmenee, kysely toistetaan automaattisesti aikakatkaisun saavuttamisen jälkeen. Virheilmoitus näkyy monitorissa vain kerran. Jos yhteyttä ei saada aikaan asetetussa yhteysaikakatkaisussa, rajapinta julistetaan myös offline-tilaksi.
Kohdeosoite on palvelimen osoite ilman URI:tä ja https://-etuliitettä.
Huomautus: Proxy-palvelinta käytettäessä on varmistettava, että URI-polku ei muutu.
Monitori voi näyttää eri lähteitä. Seuraavassa taulukossa kaikki mahdollisuudet selitetään.
| Lähde | Kuvaus |
|---|---|
| Asiakas | HotSOS-vastapuolelta tuleva arvo. |
| Palvelin | Antcas Controlilta lähetetty tai luettu arvo. |
| Järjestelmä | Yleinen järjestelmäviesti. |
| Nimi | Tietotyyppi | Kuvaus |
|---|---|---|
| string | Asettaa tilanumeron rajapinnan mukaisesti. | |
| bool | Pyydä huoneen siivousta. | |
| string | Tilan nykyinen palvelustila. | |
| string | Tilan tila. | |
| string | Vastattu tilan nimi. | |
| bool | Do Not Disturb vastaanotettu. | |
| bool | Tila on varattu. |
Huomautus: Vain seuraavat arvot voidaan lähettää. Muut arvot eivät lähetä ja ne merkataan punaisella monitorissa.
| Arvo | Kuvaus |
|---|---|
| CLEAN | Tila on puhdas. |
| DIRTY | Tila on likainen. |
| OUT_OF_ORDER | Tila on vaurioitunut. |
| OUT_OF_SERVICE | Tila on poistettu käytöstä. |
| INSPECTED | Tilasta on tehty tarkastus. |
| PICKUP | Tila on nostotilassa. |
Huomautus: Vain arvot AWAITING_SERVICE ja DO_NOT_DISTURB voidaan lähettää.
| Arvo | Kuvaus |
|---|---|
| AWAITING_SERVICE | Tila odottaa siivousta. |
| DO_NOT_DISTURB | Vieras ei halua häiriintyä. |
| VACANT_CLEANED | Tila on siivottu ja vapaa. |
| OCCUPIED_CLEANED | Tila on siivottu ja varattu. |
| CLEANING_STARTED | Tilan siivous on aloitettu. |
| SERVICE_REFUSED | Vieras on kieltäytynyt palvelusta. |
| STOPPED | Siivous on pysäytetty. |
| TO_BE_INSPECTED | Tilasta tarvitaan tarkastus. |
| INSPECTED | Tilasta on tehty tarkastus. |
| LATE_SERVICE | Vieras haluaa myöhäisen palvelun. |
| RETURN_LATER | Vieras on pyytänyt palaamaan myöhemmin. |