Table of Contents

GET /tenant

Retrieve tenant information.

Authentication None
URI Path/rest/tenant/<id>
Version6.1.0

Method Parameters

Parameter Required Type Description
id no string ID of tenant to retrieve. If not specified response will contain a list of all tenants.

Query Parameters

Parameter Type Description
none

Resource Errors

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

Response Parameters

Name Type Description
hospitality object Hospitality settings.
name string Name of the tenant.
id string Tenant ID
profile string Profile ID
hospitality
Name Type Description
description string Description of this PMS interface.
enabled bool Is this PMS interface enabled.
id int PMS id.
maidcodes array Array of made codes.
protocol string Name of the PMS protocol being used.
restrictions array Array of restrictions.
maidcodes
Name Type Description
description string Description of this code.
id int Maid code.
pbx string Code sent to PBX.
pms string Code sent to PMS.
restrictions
Name Type Description
description string Description of this restriction.
pbx string String to be sent to PBX.
pms string String to be sent to PMS.

Example

Single Tenant

Request
GET /rest/tenant/288e1ab6-2f5b-11e7-b2a7-902b34db254e
Response
{
  "hospitality" : {
    "description" : "",
    "enabled" : true,
    "id" : "1",
    "maidcodes" : [
      {
        "description" : "Dirty",
        "id" : "0",
        "pbx" : "",
        "pms" : ""
      },
      {
        "description" : "Clean",
        "id" : "1",
        "pbx" : "",
        "pms" : ""
      },
      {
        "description" : "In progress",
        "id" : "2",
        "pbx" : "",
        "pms" : ""
      },
      {
        "description" : "Maintenance",
        "id" : "3",
        "pbx" : "",
        "pms" : ""
      },
      {
        "description" : "Out of service",
        "id" : "4",
        "pbx" : "",
        "pms" : ""
      }
    ],
    "protocol" : "DuVoice Advanced",
    "restrictions" : [
 
    ]
  },
  "id" : "8b9a6860-4a38-11e7-b52d-902b34db254e",
  "name" : "Sound Casino"
}

List Tenants

Request
GET /rest/tenant
Response
{
  "tenants" : [
    {
      "hospitality" : {
        "description" : "",
        "enabled" : true,
        "id" : 1,
        "protocol" : "DuVoice Advanced"
      },
      "id" : "8b9a6860-4a38-11e7-b52d-902b34db254e",
      "name" : "Sound Casino",
      "profile" : "8b9b2bd8-4a38-11e7-b52d-902b34db254e"
    },
    {
      "hospitality" : {
        "description" : "",
        "enabled" : true,
        "id" : 1,
        "protocol" : "DuVoice Advanced"
      },
      "id" : "ba9a4b36-7606-11e7-9704-902b34db254e",
      "name" : "Quiet Casino",
      "profile" : "926650f6-815a-11e7-bdac-902b34db254e"
    }
  ]
}