Table of Contents

Room status

The Room Status Interface (RSI) is a telephony interface designed to allow housekeeping personnel to report room status to one or more remote servers.

The RSI service is entirely separate from the hospitality service; changes to room status using RSI will not be passed to the PMS via the hospitality server. If you intend status of a room to be sent to the PMS, please see the maid status page.

Room status changes will automatically be posted to any servers receiving push notifications for room status server. This can include SDD Jazz, Comtrol, and other proprietary interfaces.

Features

Status change

A room status change is made using the method POST with minimal additional arguments making it easy for any type of interface.

In order to change the room status, only the ID and the room number need be passed.

Example

Request

curl -i -X POST http://127.0.0.1:10022/rest/rsi/change -d "id=2&room=7101" -u user:password

Response

HTTP/1.1 200 OK
Date: Fri, 27 Sep 2019 20:14:45 GMT
Connection: Close
Content-Language: en
Server: DuVoice/6.03.32 DVREST/6.0.1
Access-Control-Allow-Origin: *
Location: 127.0.0.1:10022

Get Status types

You can retrieve a list of all status types using the GET method with the parameter status.

Name Type Description
description string Category description.
id string of numbers Status ID.

Example

Request

curl -i -X GET http://127.0.0.1:10022/rest/rsi/status -u user:password

Response

HTTP/1.1 200 OK
Date: Fri, 27 Sep 2019 20:12:17 GMT
Connection: close
Content-Language: en
Server: DuVoice/6.03.32 DVREST/6.0.1
Access-Control-Allow-Origin: *
Location: 127.0.0.1:10022
Content-Type: application/json
Content-Length: 562
 
{
  "items" : [
    {
      "description" : "Mainenance",
      "id" : "001",
      "tenant" : ""
    },
    {
      "description" : "Occupied Clean",
      "id" : "1",
      "tenant" : ""
    },
    {
      "description" : "Vacant Clean",
      "id" : "2",
      "tenant" : ""
    },
    {
      "description" : "Occupied Dirty",
      "id" : "3",
      "tenant" : ""
    },
    {
      "description" : "Vacant Dirty",
      "id" : "4",
      "tenant" : ""
    },
    {
      "description" : "Vacant Inspected",
      "id" : "5",
      "tenant" : ""
    }
  ]
}