Table of Contents

GET /rsi/<type>/<id>

Return a room status content type.

Authentication Required
URI Path /rest/rsi/<type>/<id>
Version6.0.1

Method Parameters

Parameter Required Type Description
id no string ID to return. If not specified a list of the types will be returned.

<type> Options

Parameter Type Description
status string Return list of all status types.
room string Rooms associated with room status system.
user string List of users with room status access only.

Query Parameters

Parameter Type Description
none

Resource Errors

HTTP Code Description
200 Success.
401 Not authorized.
404 No content found.
405 Method specified is not supported.

Response Parameters

status
Name Type Description
description string Category description.
id string of numbers Status ID.
config
Name Type Description
roomList boolean Is system configured to use custom room list. Default is false to use guest database.
servers array Array of server configuration.
room
Name Type Description
description string Room description.
id string Room number.
tenant string Tenant ID for this category.
servers
Name Type Description
id number Room number.
enabled boolean Is this server enabled. System supports up to 5 servers.
user
Name Type Description
firstName string First name.
lastLogin string Date in ISO format.
lastName string Last name.
username string Username.

Status Example

Status

Request
GET /rest/rsi/status
Response
{
  "items" : [
    {
      "description" : "Maintenance",
      "id" : "13",
      "tenant" : ""
    },
    {
      "description" : "Dirty",
      "id" : "12",
      "tenant" : ""
    }
  ]
}
Request
GET /rest/rsi/status/11
Response
{
  "description" : "Clean",
  "id" : "11",
  "tenant" : ""
}

Room

Request
GET /rest/rsi/room
Response
{
  "rooms" : [
    {
      "description" : "test",
      "id" : "2000",
      "tenant" : ""
    },
    {
      "description" : "test 2",
      "id" : "2001",
      "tenant" : ""
    }
  ]
}
Request
GET /rest/rsi/room/1001
Response
{
  "description" : "",
  "id" : "1001",
  "tenant" : ""
}

User

Request
GET /rest/rsi/user
Response
{
  "users" : [
    {
      "firstName" : "Jane",
      "lastLogin" : "Tue, 12 Sep 2017 09:34:49 -0700",
      "lastName" : "Doe",
      "username" : "jane"
    },
    {
      "firstName" : "Brock",
      "lastLogin" : "Tue, 12 Sep 2017 14:04:45 -0700",
      "lastName" : "Sampson",
      "username" : "sampson"
    }
  ]
}

Config

Request
GET /rest/rsi/config
Response
{
  "roomList" : false,
  "servers" : [
    {
      "enabled" : true,
      "id" : 1
    },
    {
      "enabled" : false,
      "id" : 2
    },
    {
      "enabled" : false,
      "id" : 3
    },
    {
      "enabled" : false,
      "id" : 4
    },
    {
      "enabled" : false,
      "id" : 5
    }
  ]
}