Get Tenant

This request returns the information of a tenant in a multi tenants system.

Resource

GET /tenants/<OID>

Where OID is the tenant ID (the databaseId field).

Parameters

None

Payload

None

Response

Object Response < Tenant >

Context

Authorization	Master
Configuration	Multi-tenant

Errors

Common Errors

HTTP code	Xelion code	Description
400	10063	Not the master tenant.
403	10101	Resource not accessable. User is not a master tenant administrator.
404	10060	No multi-tenant configuration.
404	10100	No tenant with the specified ID exists.

Example

Request

GET https://xelion.nl/api/v1/master/tenants/11

Response

{
  "object": {
    "databaseId": 11,
    "subDatabaseName": "pbx11",
    "active": true,
    "isTemplate": true,
    "statusEnum": "IN_USE",
    "licenseCounts": [
      {
        "license": {
          "permissions": "ReadWriteRemove",
          "commonName": "license.user",
          "oid": "1626984",
          "objectType": "X1License"
        },
        "maxLicenses": 100,
        "usedLicenses": 1,
        "oid": "0",
        "objectType": "X1LicenseCount"
      }
    ],
    "dbUsage": 0,
    "mohUsage": 0,
    "monitorUsage": 0,
    "totalUsage": 0,
    "permissions": "ReadWriteRemove",
    "commonName": "pbx 11",
    "oid": "11",
    "objectType": "XCCTenant"
  },
  "links": [
    {
      "rel": "self",
      "href": "http://www.xelion.nl/api/v1/master/tenants/11",
      "method": "GET"
    }
  ]
}