A lighting system is composed of wireless devices connected to Wireless Area Controllers (WAC). The WACs are connected to Trellix Core that acts as a data repository and hosts interfaces such as the Published (REST) API used by third-party systems. This logical or device hierarchy is as follows: Trellix Core > Wireless Area Controllers > Devices > Endpoints. An example of as device hierarchy is shown below.

A Device is a physical component of a lighting system. When connected to a network, each device has a unique ID (address) on that network that is used to route network communication to the device. The object structure is flexible enough to describe current and future devices in a general way but with an appropriate level of detail.

An Endpoint represents a function available on a Device, including controllers, inputs and outputs. Each device can have one or more endpoints. For example, a ceiling sensor contains an occupancy sensor endpoint, while an integrated sensor contains an occupancy sensor endpoint, a daylight sensor endpoint, and a dimming module endpoint.

Endpoints are represented as a list in a Device object, which in turn is presented to the network. An Endpoint may represent a physical component of a Device (e.g., a daylight sensor or occupancy sensor), a logical function of a Device (e.g., firmware update capability), or a link to a controlled device. Most system interactions take place directly through Endpoints, not the Device object that contains them.

The geographical or building hierarchy is as follows: Client > Building > Floor > Area > [ Zones / Occupancy Sets / Daylight Sets / Devices]. A building hierarchy reflects a physical relationship but also certain logical relationships that group endpoints into Occupancy Sets, Daylight Sets and Zones.

An example of a building hierarchy is shown below.

Integrated Sensor IS 1 installed in a light fixture and has an occupancy sensor endpoint, a daylight sensor endpoint, and a dimming module endpoint. The blue labels in the diagram highlights how the IS 1 dimming module appears in Screen Dimming Zone D1 while its occupancy set endpoint appears in Occupancy Set OS1, and its daylight sensor appears in Daylight Set DL1.

Components of a Building Hierarchy

The components of a building hierarchy are as follows:

An HTTP message consist of a request or response line, which appears first, and header fields in the lines that follow. Here is an example of the GET request:

GET /v2/public/<BUILDING-ID>/areas/detail HTTP/1.1

The Trellix Lighting API uses both GET and POST requests.

Each header field appears on a new line as a clear-text name-value pair, separated by colons. The line is terminated by a carriage return (CR) and line feed (LF) character sequence. For example:

Host: 192.168.2.100
Authorization: bearer 54ea09cb-dbea-45ad-836b-8b1436bcebdc
Content-Type: application/json
Cache-Control: no-cache

To learn more, refer to this List of HTTP header Fields.

Trellix Lighting supports the export and import of Tag and Asset Public ID data to facilitate communication with third-party systems. The Public ID template can be downloaded, modified, and then uploaded back into Trellix Lighting, align the Trellix Asset IDs with those of the external system. See the Trellix Lighting System Configuration Guide for information.

Example

Before you can access lighting system data, you must authenticate your account. This will generate an API token you can use for further requests, like getting the status of a zone or the details of an occupancy set.

To authenticate, you send an HTTP POST with the username Public (not case-sensitive) and a password provided by Cooper Lighting Solutions. For example:

https://192.168.1.99/uaa/oauth/token?grant_type=password&username=Public&password=myCooperPassword

The Trellix Lighting API will provide an access token you can use for subsequent requests.

The response to a Trellix Lighting API call will include an HTTP status code and a body. A successful call will return a status of 200, and the body will contain the requested Trellix data in JSON (JavaScript Object Notation) format. JSON is a simple and popular way to represent plain and structured data – such as booleans, arrays and objects – in plain text. For a brief introduction to JSON, see the JSON.org Web site. For the detailed specification, see the JSON Schema.

All Trellix Lighting API responses contain a single object. When a list is requested, such as the All Areas Detail List or All Endpoints Identity List, the properties described below will typically be included.

Example

The JSON below shows a response to an All Areas Identity List call. In this case, the content array contains the identity information for two areas, A1 and A2.

{
  "content": [
    {
      "publicId": "A1",
      "type": "52474f38-38aa-4ee8-8893-5541c0f5d04e",
      "name": "Default"
    },
    {
      "publicId": "A2",
      "type": "52474f38-38aa-4ee8-8893-5541c0f5d04e",
      "name": "Area 51"
    }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "size": 100,
  "number": 0
}

The three common sets of data that appear in most Trellix Lighting API responses are explained below.

When a successful Get Public Login Token call is made, access will be granted using that token for a minimum of 30 minutes. Trellix monitors for API activity in 30-minute windows after granting access. As long as one or more API calls are made within each window, Trellix will maintain access with the original token for up to two hours maximum (four 30-minute periods).

If there is no API activity in a 30-minute window, or when the two hours maximum has been reached, the token is revoked and access denied until a new Get Public Login Token call is made.

The diagram below shows an authentication cycle where a Login Token is granted and followed by API activity in two successive 30 minutes period. When no activity occurs between 60 and 90 minutes, the token expires, and a new Get Login Token request must be made.

To avoid being denied access, the Get Refresh Token call can be used before the current token expires. This will extend the cycle and maintain access for up to another two hours.

We recommend issuing a Get Refresh Token call just before the each 30-minute window. This will provide continuous access to Trellix, and future-proof your application should the maximum time be reduced from the current two hours.

This POST request returns an access token and its type.

HTTP Header Fields

POST /uaa/oauth/token HTTP/1.1
Authorization: Basic ZWF0b24tY2xpZW50OkFDdHZRQzFoSE4=
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

grant_type=password&username=Public&password=<COOPER-PASSWORD>

POST Request Structure

https://<HOST-IP>:<HOST-PORT>/uaa/oauth/token?grant_type=password&username=Public&password=<COOPER-PASSWORD>

Where:

Request Example

https://192.168.2.100/uaa/oauth/token?grant_type=password&username=Public&password=cooperPassword

JSON Body Example

{
  "access_token": "54ea09cb-dbea-45ad-836b-8b1436bcebdc",
  "token_type": "bearer",
  "refresh_token": "b67c9076-2565-4f18-a657-982e15d2725a",
  "expires_in": 4746,
  "scope": "openid",
  "user": {
    "id": "b57acccd-8cb0-40d9-8f76-1f330da0374c",
    "userName": "Public",
    "role": {
      "id": "56be369b-7acc-4d68-a815-39d58d026b55",
      "name": "Third Party Integration",
      "permissions": [
        {
          "id": "962f14db-2f9c-4625-82ee-93ebf99e0273",
          "name": "Interface Settings"
        }
      ],
      "updatedTime": "2018-05-11T15:12:10.280Z",
      "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c"
    },
    "authInfo": {
      "id": "2d808ff3-4dc7-4087-902d-63ec5a0c8da4",
      "passwordExpires": false,
      "policy": {
        "id": "ef89498b-cea8-43f8-a87d-443819adbe06",
        "name": "Default Policy",
        "expiryDuration": 7776000000,
        "reuseLimit": 10,
        "maximumLength": 16,
        "minimumLength": 8,
        "minimumNumber": 1,
        "minimumSpecial": 1,
        "minimumUpper": 1
      },
      "isLocked": false,
      "daysToExpiry": -1,
      "isExpired": false
    },
    "updatedTime": "2018-05-11T15:12:10.280Z",
    "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
    "createdTime": "2018-05-11T15:12:10.280Z",
    "createdBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
    "isLdap": false,
    "isDefault": true,
    "isClosed": false
  }
}

Using ro as the Get Public Login JSON response object in the example above, the relevant values are described below.

This POST request, which only works during an active login session, returns an updated access token to extend the login period by 30 minutes.

HTTP Header Fields

POST /uaa/oauth/token HTTP/1.1
Authorization: Basic ZWF0b24tY2xpZW50OkFDdHZRQzFoSE4=
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

POST Request Structure

https://<HOST-IP>:<HOST-PORT>/uaa/oauth/token

Request Example

https://192.168.2.100/uaa/oauth

JSON Body Example

{
    "access_token": "d6c621c2-a138-409b-ab11-8b096c103dad",
    "token_type": "bearer",
    "refresh_token": "d1256b8b-39ef-4cb0-bfc9-0691c8954471",
    "expires_in": 7199,
    "scope": "openid",
    "user": {
        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
        "updatedTime": "2019-12-06T11:04:53.737-0500",
        "createdBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
        "createdTime": "2019-12-06T11:03:44.484-0500",
        "id": "a81b3226-868e-469e-8c43-b4aa50f456ad",
        "userName": "LightingAPI",
        "roles": [
            {
                "createdBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
                "createdTime": "2019-11-28T09:40:44.676-0500",
                "id": "56be369b-7acc-4d68-a815-39d58d026b55",
                "name": "Third Party Integration",
                "permissions": [
                    {
                        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
                        "updatedTime": "2019-11-28T09:40:45.488-0500",
                        "createdBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
                        "createdTime": "2019-11-28T09:40:44.676-0500",
                        "id": "977c979b-c42c-409d-8ede-6ecd3415e8ed",
                        "name": "View Only",
                        "application": {
                            "id": "46779fe5-204f-44bf-984b-157dd148f5c8",
                            "shortName": "LXI",
                            "active": true,
                            "isActive": true,
                            "isEnabled": true
                        },
                        "identifier": "LXI_View_Only"
                    },
                    {
                        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
                        "updatedTime": "2019-11-28T09:40:45.488-0500",
                        "createdBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
                        "createdTime": "2019-11-28T09:40:44.676-0500",
                        "id": "4bf22b74-e1e5-49d4-a746-90b5200c5421",
                        "name": "Manual Action",
                        "application": {
                            "id": "46779fe5-204f-44bf-984b-157dd148f5c8",
                            "shortName": "LXI",
                            "active": true,
                            "isActive": true,
                            "isEnabled": true
                        },
                        "identifier": "LXI_Manual_Action"
                    },
                    {
                        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
                        "updatedTime": "2019-11-28T09:40:45.488-0500",
                        "createdBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
                        "createdTime": "2019-11-28T09:40:45.488-0500",
                        "id": "639e7237-7fb9-4678-aca3-9c7c95dfda0d",
                        "name": "View Only",
                        "application": {
                            "id": "4b237de7-a393-4a48-97d1-f697f50bcd0c",
                            "shortName": "BXI",
                            "active": true,
                            "isActive": true,
                            "isEnabled": true
                        },
                        "identifier": "BXI_View_Only"
                    },
                    {
                        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
                        "updatedTime": "2019-11-28T09:40:45.488-0500",
                        "createdBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
                        "createdTime": "2019-11-28T09:40:45.488-0500",
                        "id": "780434c7-7ce0-4a59-9252-261611959db6",
                        "name": "Lighting API",
                        "application": {
                            "id": "4b237de7-a393-4a48-97d1-f697f50bcd0c",
                            "shortName": "BXI",
                            "active": true,
                            "isActive": true,
                            "isEnabled": true
                        },
                        "identifier": "LXI_API_Access"
                    }
                ],
                "application": {
                    "id": "46779fe5-204f-44bf-984b-157dd148f5c8",
                    "shortName": "LXI",
                    "active": true,
                    "isActive": true,
                    "isEnabled": true
                },
                "isDefault": true
            }
        ],
        "authInfo": {
            "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
            "updatedTime": "2019-12-06T11:03:44.483-0500",
            "createdBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
            "createdTime": "2019-12-06T11:03:44.484-0500",
            "id": "c4462bd4-8ec7-4d1d-a76b-755b3c00c983",
            "passwordExpires": false,
            "policy": {
                "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
                "updatedTime": "2019-11-28T09:40:44.676-0500",
                "createdBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
                "createdTime": "2019-11-28T09:40:44.676-0500",
                "id": "ef89498b-cea8-43f8-a87d-443819adbe06",
                "expiryDuration": 7776000000,
                "reuseLimit": 10,
                "maximumLength": 16,
                "minimumLength": 8,
                "minimumNumber": 1,
                "minimumSpecial": 1,
                "minimumUpper": 1
            },
            "isLocked": false,
            "daysToExpiry": -1,
            "isExpired": false
        },
        "areaOfResponsibilityType": "PARTIAL",
        "departmentOfResponsibilityType": "PARTIAL",
        "departments": [
            {
                "id": "09455979-25b6-4260-b0ec-12a2df2b1a37",
                "name": "Default"
            },
            {
                "id": "ee38e32d-b3d1-4c85-86e8-04dde3e510cd",
                "name": "Default"
            },
            {
                "id": "c054738c-63dc-431d-8a0c-0614cf325d2c",
                "name": "Default"
            }
        ],
        "isLdap": false,
        "isDefault": false,
        "isClosed": false,
        "isRegPortalNotify": true
    }
}

The POST request returns a Demand Response token.

HTTP Header Fields

POST /uaa/oauth/token HTTP/1.1
Authorization: Basic ZWF0b24tY2xpZW50OkFDdHZRQzFoSE4=
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

POST Request Structure

https://<HOST-IP>:<HOST-PORT>/uaa/oauth/token?grant_type=password&username=Public&password=<COOPER-PASSWORD>

Where:

Request Example

https://192.168.2.100/uaa/oauth/token?grant_type=password&username=Public&password=cooperPassword

JSON Body Example

{
  "access_token": "54ea09cb-dbea-45ad-836b-8b1436bcebdc",
  "token_type": "bearer",
  "refresh_token": "b67c9076-2565-4f18-a657-982e15d2725a",
  "expires_in": 4746,
  "scope": "openid",
  "user": {
    "id": "b57acccd-8cb0-40d9-8f76-1f330da0374c",
    "userName": "Public",
    "role": {
      "id": "56be369b-7acc-4d68-a815-39d58d026b55",
      "name": "Third Party Integration",
      "permissions": [
        {
          "id": "962f14db-2f9c-4625-82ee-93ebf99e0273",
          "name": "Interface Settings"
        }
      ],
      "updatedTime": "2018-05-11T15:12:10.280Z",
      "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c"
    },
    "authInfo": {
      "id": "2d808ff3-4dc7-4087-902d-63ec5a0c8da4",
      "passwordExpires": false,
      "policy": {
        "id": "ef89498b-cea8-43f8-a87d-443819adbe06",
        "name": "Default Policy",
        "expiryDuration": 7776000000,
        "reuseLimit": 10,
        "maximumLength": 16,
        "minimumLength": 8,
        "minimumNumber": 1,
        "minimumSpecial": 1,
        "minimumUpper": 1
      },
      "isLocked": false,
      "daysToExpiry": -1,
      "isExpired": false
    },
    "updatedTime": "2018-05-11T15:12:10.280Z",
    "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
    "createdTime": "2018-05-11T15:12:10.280Z",
    "createdBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
    "isLdap": false,
    "isDefault": true,
    "isClosed": false
  }
}

Using ro as the Get Demand Response Login JSON response object in the example above, the relevant values are described below.

This POST request logs out an authenticated user.

HTTP Header Fields

POST /uaa/logout HTTP/1.1
Authorization: Basic ZWF0b24tY2xpZW50OkFDdHZRQzFoSE4=
Content-Type: multipart/form-data;
Cache-Control: no-cache

POST Request Structure

https://<HOST-IP>:<HOST-PORT>/uaa/logout

Where:

Request Example

https://192.168.2.100/uaa/logout

JSON Body Example

No JSON data is returned for this call.

All Buildings Detail List

Returns a detail list of all buildings.

HTTP Header Fields

GET /v2/public/buildings/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/buildings/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/buildings/detail

JSON Body Example

[
    {
        "buildingDecorators": [
            {
                "count": 260,
                "createdTime": "2020-05-26T23:40:05.189-0400",
                "name": "alarms",
                "updatedTime": "2020-05-26T23:40:05.189-0400"
            }
        ],
        "client": {
            "name": "MDT-RTLS",
            "publicId": "C1"
        },
        "createdTime": "2020-05-26T23:39:45.031-0400",
        "floors": [
            { FLOOR_OBJECT_PROPERTIES }
        ],
        "latitude": 0.0,
        "longitude": 0.0,
        "name": "Default Building",
        "number": 1,
        "publicId": "B4",
        "source": "WAC",
        "superficies": "0",
        "type": "OTHER",
        "updatedTime": "2020-06-18T23:04:06.153-0400"
    }
]

Using ro as the first All Buildings Detail response object in the example above, the relevant values are described below.

All Buildings Display List

Return a display list of all configured buildings.

HTTP Header Fields

GET /v2/public/buildings/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/buildings/display

Where:

GET Request Example

https://192.168.2.100/v2/public/buildings/display

JSON Body Example

[
    {
        "buildingDecorators": [
            {
                "count": 260,
                "name": "alarms",
                "updatedTime": "2020-05-26T23:40:05.189-0400"
            }
        ],
        "client": {
            "name": "MDT-RTLS",
            "publicId": "C1"
        },
        "floors": [
            { FLOOR_OBJECT_PROPERTIES }
        ],
        "latitude": 0.0,
        "longitude": 0.0,
        "name": "Default Building",
        "number": 1,
        "publicId": "B4",
        "source": "WAC",
        "superficies": "0",
        "type": "OTHER",
        "updatedTime": "2020-06-18T23:04:06.153-0400"
    }
]

Using ro as the first All Buildings Display response object in the example above, the relevant values are described below

All Buildings Identity List

Return an identity list of all configured buildings.

HTTP Header Fields

GET /v2/public/buildings/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/buildings/identity

Where:

GET Request Example

https://192.168.2.100/v2/public/buildings/identity

JSON Body Example

[
    {
        "name": "Default Building",
        "publicId": "B4",
        "type": "OTHER"
    }
]

Using ro as the first All Buildings Identity response object in the example above, the relevant values are described below

This section describes API calls that provide various views of the details of one building on the network.

Building Detail View

Return the detail information for a specified building.

HTTP Header Fields

GET /v2/public/buildings/<BUILDING-ID>/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/buildings/<BUILDING-ID>/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/buildings/B4/detail

JSON Body Example

{
    "buildingDecorators": [
        {
            "count": 260,
            "createdTime": "2020-05-26T23:40:05.189-0400",
            "name": "alarms",
            "updatedTime": "2020-05-26T23:40:05.189-0400"
        }
    ],
    "client": {
        "name": "MDT-RTLS",
        "publicId": "C1"
    },
    "createdTime": "2020-05-26T23:39:45.031-0400",
    "floors": [
        { FLOOR_OBJECT_PROPERTIES }
    ],
    "latitude": 0.0,
    "longitude": 0.0,
    "name": "Default Building",
    "number": 1,
    "publicId": "B4",
    "source": "WAC",
    "superficies": "0",
    "type": "OTHER",
    "updatedTime": "2020-06-18T23:04:06.153-0400"
}

Using ro as the Building Detail response object in the example above, the relevant values are described below.

Building Display View

Return the display information for a specified building.

HTTP Header Fields

GET /v2/public/buildings/<BUILDING-ID>/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/buildings/<BUILDING-ID>/display

Where:

GET Request Example

https://192.168.2.100/v2/public/buildings/B4/display

JSON Body Example

{
    "buildingDecorators": [
        {
            "count": 260,
            "name": "alarms",
            "updatedTime": "2020-05-26T23:40:05.189-0400"
        }
    ],
    "client": {
        "name": "MDT-RTLS",
        "publicId": "C1"
    },
    "floors": [
        { FLOOR_OBJECT_PROPERTIES }
    ],
    "latitude": 0.0,
    "longitude": 0.0,
    "name": "Default Building",
    "number": 1,
    "publicId": "B4",
    "source": "WAC",
    "superficies": "0",
    "type": "OTHER",
    "updatedTime": "2020-06-18T23:04:06.153-0400"
}

Using ro as the Building Display response object in the example above, the relevant values are described below.

Building Identity View

Return the identity information for a specified building.

HTTP Header Fields

GET /v2/public/buildings/<BUILDING-ID>/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/buildings/<BUILDING-ID>/identity

Where:

GET Request Example

https://192.168.2.100/v2/public/buildings/B4/identity

JSON Body Example

{
    "name": "Default Building",
    "publicId": "B4",
    "type": "OTHER"
}

Using ro as the Building Identity response object in the example above, the relevant values are described below.

All Floors Detail List

Returns a detail list of all floors.

HTTP Header Fields

GET /v2/public/floors/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/floors/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/floors/detail

JSON Body Example

[
    {
        "areas": [
            { AREA_OBJECT_PROPERTIES }
        ],
        "building": {},
        "capacity": 180,
        "createdTime": "2020-05-26T23:39:45.105-0400",
        "floorDecorators": [
            {
                "count": 260,
                "createdTime": "2020-05-26T23:40:05.261-0400",
                "name": "alarms",
                "updatedTime": "2020-05-26T23:40:05.261-0400"
            },
            {
                "createdTime": "2020-05-27T18:16:38.713-0400",
                "isHighPriorityOverrideMode": false,
                "name": "highPriorityOverride",
                "updatedTime": "2020-05-27T18:16:38.713-0400"
            }
        ],
        "floorplanFile": "Midtown_cropped.svg",
        "imageScale": 1.0,
        "imageScalePx": 12.0,
        "imageScaleUnit": "FEET",
        "name": "Default Floor",
        "number": 0,
        "publicId": "F4",
        "source": "WAC",
        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
        "updatedTime": "2020-06-18T23:04:06.153-0400"
    }
]

Using ro as the first All Floors Detail response object in the example above, the relevant values are described below.

All Floors Display List

Return a display list of all configured floors.

HTTP Header Fields

GET /v2/public/floors/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/floors/display

Where:

GET Request Example

https://192.168.2.100/v2/public/floors/display

JSON Body Example

[
    {
        "areas": [
            { AREA_OBJECT_PROPERTIES }
        ],
        "building": {},
        "capacity": 180,
        "createdTime": "2020-05-26T23:39:45.105-0400",
        "floorDecorators": [
            {
                "count": 260,
                "createdTime": "2020-05-26T23:40:05.261-0400",
                "name": "alarms",
                "updatedTime": "2020-05-26T23:40:05.261-0400"
            },
            {
                "createdTime": "2020-05-27T18:16:38.713-0400",
                "isHighPriorityOverrideMode": false,
                "name": "highPriorityOverride",
                "updatedTime": "2020-05-27T18:16:38.713-0400"
            }
        ],
        "floorplanFile": "Midtown_cropped.svg",
        "imageScale": 1.0,
        "imageScalePx": 12.0,
        "imageScaleUnit": "FEET",
        "name": "Default Floor",
        "number": 0,
        "publicId": "F4",
        "source": "WAC",
        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
        "updatedTime": "2020-06-18T23:04:06.153-0400"
    }
]

Using ro as the first All Floors Display response object in the example above, the relevant values are described below

All Floors Identity List

Return an identity list of all configured floors.

HTTP Header Fields

GET /v2/public/floors/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/floors/identity

Where:

GET Request Example

https://192.168.2.100/v2/public/floors/identity

JSON Body Example

[
    {
        "name": "Default Floor",
        "publicId": "F4"
    }
]

Using ro as the first All Floors Identity response object in the example above, the relevant values are described below

This section describes API calls that provide various views of the details of one floor in a building.

Floor Detail View

Return the detail information for a specified floor.

HTTP Header Fields

GET /v2/public/floors/<FLOOR-ID>/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/floors/<FLOOR-ID>/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/floors/F4/detail

JSON Body Example

{
    "areas": [
        { AREA_OBJECT_PROPERTIES }
    ],
    "building": {},
    "capacity": 180,
    "createdTime": "2020-05-26T23:39:45.105-0400",
    "floorDecorators": [
        {
            "count": 260,
            "createdTime": "2020-05-26T23:40:05.261-0400",
            "name": "alarms",
            "updatedTime": "2020-05-26T23:40:05.261-0400"
        },
        {
            "createdTime": "2020-05-27T18:16:38.713-0400",
            "isHighPriorityOverrideMode": false,
            "name": "highPriorityOverride",
            "updatedTime": "2020-05-27T18:16:38.713-0400"
        }
    ],
    "floorplanFile": "Midtown_cropped.svg",
    "imageScale": 1.0,
    "imageScalePx": 12.0,
    "imageScaleUnit": "FEET",
    "name": "Default Floor",
    "number": 0,
    "publicId": "F4",
    "source": "WAC",
    "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
    "updatedTime": "2020-06-18T23:04:06.153-0400"
}

Using ro as the Floor Detail response object in the example above, the relevant values are described below.

Floor Display View

Return the display information for a specified floor.

HTTP Header Fields

GET /v2/public/floors/<FLOOR-ID>/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/floor/<FLOOR-ID>/display

Where:

GET Request Example

https://192.168.2.100/v2/public/floors/F4/display

JSON Body Example

{
    "areas": [
        { AREA_OBJECT_PROPERTIES }
    ],
    "building": {},
    "capacity": 180,
    "createdTime": "2020-05-26T23:39:45.105-0400",
    "floorDecorators": [
        {
            "count": 260,
            "createdTime": "2020-05-26T23:40:05.261-0400",
            "name": "alarms",
            "updatedTime": "2020-05-26T23:40:05.261-0400"
        },
        {
            "createdTime": "2020-05-27T18:16:38.713-0400",
            "isHighPriorityOverrideMode": false,
            "name": "highPriorityOverride",
            "updatedTime": "2020-05-27T18:16:38.713-0400"
        }
    ],
    "floorplanFile": "Midtown_cropped.svg",
    "imageScale": 1.0,
    "imageScalePx": 12.0,
    "imageScaleUnit": "FEET",
    "name": "Default Floor",
    "number": 0,
    "publicId": "F4",
    "source": "WAC",
    "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
    "updatedTime": "2020-06-18T23:04:06.153-0400"
}

Using ro as the Floor Display response object in the example above, the relevant values are described below.

Floor Identity View

Return the identity information for a specified floor.

HTTP Header Fields

GET /v2/public/floors/<FLOOR-ID>/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/floors/<FLOOR-ID>/identity

Where:

GET Request Example

https://192.168.2.100/v2/public/floors/F4/identity

JSON Body Example

{
    "name": "Default Floor",
    "publicId": "F4"
}

Using ro as the Floor Identity response object in the example above, the relevant values are described below.

This section describes API calls that provide various ways to view a list of all alarms on the network.

All Alarms Detail List

Returns a detail list of all alarms.

HTTP Header Fields

GET /v2/public/alarms/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/alarms/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/alarms/detail

JSON Body Example

{
  "content": [
    {
        "updatedTime": "2020-06-05T06:26:20.139343-04:00",
        "createdTime": "2020-06-05T06:25:45.931412-04:00",
        "id": "e3c2d089-5611-48d8-ad37-abfcd844c156",
        "description": "Device not reachable",
        "status": "PRECLEARED",
        "occurrenceTime": "2020-06-05T10:25:45.298Z",
        "sourceType": "WLX Integrated Lighting, Occupancy/Daylight/BLE",
        "sourceName": "BLE Integrated Sensor 47",
        "address": "NA",
        "physicalLocation": "NA",
        "systemLocation": "NA",
        "errorCode": "WCL.DPC.E.0001",
        "sourceId": "3d84ffb4-9fcb-11ea-a550-001d054d35f4",
        "sourcePublicId": "D1309"
    },
    {
        "updatedTime": "2020-06-05T06:24:20.486192-04:00",
        "createdTime": "2020-06-05T06:23:46.600499-04:00",
        "id": "ac0761fe-c1a8-43da-8cde-b53dbf3d06a4",
        "description": "Device not reachable",
        "status": "PRECLEARED",
        "occurrenceTime": "2020-06-05T10:23:45.712Z",
        "sourceType": "WLX Integrated Lighting, Occupancy/Daylight/BLE",
        "sourceName": "BLE Integrated Sensor 46",
        "address": "NA",
        "physicalLocation": "NA",
        "systemLocation": "NA",
        "errorCode": "WCL.DPC.E.0001",
        "sourceId": "3851dfa8-9fcb-11ea-b613-001d054d35f4",

        "sourcePublicId": "D1308"

    },

  ],

  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the first All Alarms Detail response object in the example above, the relevant values are described below.

All Alarms Display List

Return a display list of all configured alarms.

HTTP Header Fields

GET /v2/public/alarms/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/alarms/display

Where:

GET Request Example

https://192.168.2.100/v2/public/alarms/display

JSON Body Example

[
    {
        "updatedTime": "2020-06-05T06:26:20.139343-04:00",
        "id": "e3c2d089-5611-48d8-ad37-abfcd844c156",
        "description": "Device not reachable",
        "status": "PRECLEARED",
        "occurrenceTime": "2020-06-05T10:25:45.298Z",
        "sourceType": "WLX Integrated Lighting, Occupancy/Daylight/BLE",
        "sourceName": "BLE Integrated Sensor 47",
        "address": "NA",
        "physicalLocation": "NA",
        "systemLocation": "NA",
        "errorCode": "WCL.DPC.E.0001",
        "sourceId": "3d84ffb4-9fcb-11ea-a550-001d054d35f4",
        "sourcePublicId": "D1309"
    },
    {
        "updatedTime": "2020-06-05T06:24:20.486192-04:00",
        "id": "ac0761fe-c1a8-43da-8cde-b53dbf3d06a4",
        "description": "Device not reachable",
        "status": "PRECLEARED",
        "occurrenceTime": "2020-06-05T10:23:45.712Z",
        "sourceType": "WLX Integrated Lighting, Occupancy/Daylight/BLE",
        "sourceName": "BLE Integrated Sensor 46",
        "address": "NA",
        "physicalLocation": "NA",
        "systemLocation": "NA",
        "errorCode": "WCL.DPC.E.0001",
        "sourceId": "3851dfa8-9fcb-11ea-b613-001d054d35f4",
        "sourcePublicId": "D1308"
    },
]

Using ro as the All Alarms Display response object in the example above, the relevant values are described below

All Alarms Identity List

Return an identity list of all configured areas.

HTTP Header Fields

GET /v2/public/alarms/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

Where:

GET Request Example

https://192.168.2.100/v2/public/alarms/identity

JSON Body Example

[
    {
        "id": "e3c2d089-5611-48d8-ad37-abfcd844c156",
        "status": "PRECLEARED",
        "occurrenceTime": "2020-06-05T10:25:45.298Z",
        "sourceName": "BLE Integrated Sensor 47",
        "sourceId": "3d84ffb4-9fcb-11ea-a550-001d054d35f4",
        "sourcePublicId": "D1309"
    },
    {
        "id": "ac0761fe-c1a8-43da-8cde-b53dbf3d06a4",
        "status": "PRECLEARED",
        "occurrenceTime": "2020-06-05T10:23:45.712Z",
        "sourceName": "BLE Integrated Sensor 46",
        "sourceId": "3851dfa8-9fcb-11ea-b613-001d054d35f4",
        "sourcePublicId": "D1308"
    },
]

Using ro as the first All Alarms Identity response object in the example above, the relevant values are described below

This section describes API calls that provide various views of the details of one alarm on the network.

Alarm Detail Viewc

Return the detail information for a specified alarm.

HTTP Header Fields

GET /v2/public/alarms/<ALARM-ID>/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/alarms/<ALARM-ID>/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/alarms/88e77d49-1a99-4dd3-b36b-f3860cb26a68/detail

JSON Body Example

{
    "updatedTime": "2020-06-17T16:50:34.204-0400",
    "createdTime": "2020-06-17T16:50:34.204-0400",
    "id": "2dc9e5f0-577d-4966-aeed-6f4f119f3c8e",
    "device": { DEVICE_OBJECT_PROPERTIES },
    "occurrenceTime": "2020-06-08T00:22:54.075-0400",
    "status": "PRECLEARED",
    "errorCode": "RTLSDATAE2101",
    "occurrence": 13,
    "sourcePublicId": "D1266",
    "sourceType": "DEVICE",
    "sourceName": "BLE Integrated Sensor 4",
    "physicalLocation": "MDT-RTLS>Default Building>Default Floor>Construction Area",
    "systemLocation": "2-KGARAGA-35-f4>BLE Integrated Sensor 4",
    "sourceId": "396665f4-9fca-11ea-a452-001d054d35f4"
}

Using ro as the Alarm Detail response object in the example above, the relevant values are described below.

Alarm Display View

Return the display information for a specified alarm.

HTTP Header Fields

GET /v2/public/alarms/<ALARM-ID>/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/alarms/<ALARM-ID>/display

Where:

GET Request Example

https://192.168.2.100/v2/public/alarms/1e96c895-ee75-4a58-a36e-7d29483822cf/display

JSON Body Example

{
    "updatedTime": "2020-06-05T06:26:20.139-0400",
    "id": "e3c2d089-5611-48d8-ad37-abfcd844c156",
    "device": { DEVICE_OBJECT_PROPERTIES },
    "occurrenceTime": "2020-06-05T06:25:45.298-0400",
    "status": "PRECLEARED",
    "errorCode": "WCLDPCE0001",
    "occurrence": 1,
    "sourcePublicId": "D1309",
    "sourceType": "DEVICE",
    "sourceName": "BLE Integrated Sensor 47",
    "physicalLocation": "MDT-RTLS>Default Building>Default Floor>Construction Area",
    "systemLocation": "2-KGARAGA-35-f4>BLE Integrated Sensor 47",
    "sourceId": "3d84ffb4-9fcb-11ea-a550-001d054d35f4"
}

Using ro as the Alarm Display response object in the example above, the relevant values are described below

Alarm Identity View

Return the identity information for a specified alarm.

HTTP Header Fields

GET /v2/public/alarms/<ALARM-ID>/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/alarms/<ALARM-ID>/identity

Where:

GET Request Example

https://192.168.2.100/v2/public/alarms/1e96c895-ee75-4a58-a36e-7d29483822cf/identity

JSON Body Example

{
    "id": "e3c2d089-5611-48d8-ad37-abfcd844c156",
    "sourcePublicId": "D1309",
    "sourceName": "BLE Integrated Sensor 47",
    "sourceId": "3d84ffb4-9fcb-11ea-a550-001d054d35f4"
}

Using ro as the Alarm Identity response object in the example above, the relevant values are described below

This section describes API calls that provide various ways to view a list of areas on the network.

All Areas Detail List

Returns a detail list of all configured areas in the specified building.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/detail

JSON Body Example

{
  "content": [
    { AREA_OBJECT_PROPERTIES },
    { AREA_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Areas Detail response object in the example above, the relevant values are described below. See Common Response Properties for descriptions of the standard list response properties.

All Areas Display List

Return a display list of all configured areas in the specified building.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/display

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/display

JSON Body Example

{
  "content": [
    { AREA_OBJECT_PROPERTIES },
    { AREA_OBJECT_PROPERTIES }    
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Areas Display response object in the example above, the relevant values are described below. See Common Response Properties for descriptions of the standard list response properties.

All Areas Identity List

Return an identity list of all configured areas in the specified building.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/identity

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/identity

JSON Body Example

{
  "content": [
    {
      "publicId": "A1",
      "type": "52474f38-38aa-4ee8-8893-5541c0f5d04e",
      "name": "Default"
    },
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Areas Identity response object in the example above, the relevant values are described below. See the Common Response Properties for more information about the standard list property descriptions.

All Areas List in Ascending Order

Return an identity list of all configured areas in the specified building, sorted in ascending order by name.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER> HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER>

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/identity?page=1&size=10&sort=name,DESC

JSON Body Example

{
  "content": [
    { AREA_OBJECT_PROPERTIES },
    { AREA_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "descending": false,
      "ascending": true
    }
  ],
  "size": 10,
  "number": 0
}

Using ro as the All Areas in Ascending Order JSON response object in the example above, the relevant values are described below. See the Common Response Properties for more information about the standard list property descriptions.

All Areas List in Descending Order

Return an identity list of all configured areas in the specified building, sorted in descending order by name.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/identity?page=1&amp;size=10&amp;sort=name,ASC HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER>

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/identity?page=1&size=10&sort=name,DESC

JSON Body Example

{
  "content": [
    { AREA_OBJECT_PROPERTIES },
    { AREA_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "sort": [
    {
      "direction": "DESC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "descending": true,
      "ascending": false
    }
  ],
  "size": 10,
  "number": 0
}

Using ro as the All Areas in Descending Order JSON response object in the example above, the relevant values are described below. See the Common Response Properties for more information about the standard list property descriptions.

This section describes API calls that provide various views of the areas on the network by a specified category.

All Area Categories

Return a list of all configured area categories.

HTTP Header Fields

GET /v2/public/areas/category HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/areas/category

Where:

GET Request Example

https://192.168.2.100/v2/public/areas/category

JSON Body Example

[
    "OPEN_OFFICE_SPACE",
    "PRIVATE_OFFICE",
    "WASHROOM",
    "CONFERENCE_ROOM",
    "BALLROOM",
    "HALLWAY",
    "ENTRANCE_LOBBY",
    "ELEVATOR_ESCALATOR_LOBBY",
    "KITCHEN",
    "MECHANICAL_ELECTRICAL_ROOM",
    "COMMUNICATION_EQUIPMENT_ROOM",
    "JANITORS_CLOSET",
    "CLASSROOM",
    "PARKING",
    "LOADING_DOCK",
    "STORAGE_ROOM",
    "OTHER"
]

As shown above, this call returns an array of string values, each representing an area category.

Areas by Category

Return a Details, Display, or Identity list of all areas in a specified building that are assigned to a specified category.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<DATA-TYPE>?category=<CATEGORY> HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>

/v2/public/<BUILDING-ID>/areas/<DATA-TYPE>?category=<CATEGORY>&page=0&size=5

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B4/areas/identity?category=OPEN_OFFICE_SPACE&page=0&size=5

JSON Body Example

{
    "content": [
        {
            "name": "Construction Area",
            "publicId": "A125",
            "type": "52474f38-38aa-4ee8-8893-5541c0f5d04e"
        },
        {
            "name": "Construction Area",
            "publicId": "A131",
            "type": "52474f38-38aa-4ee8-8893-5541c0f5d04e"
        }
    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "paginated": true,
        "pageNumber": 0,
        "pageSize": 5,
        "offset": 0,
        "unpaged": false,
        "paged": true
    },
    "totalElements": 2,
    "totalPages": 1,
    "last": true,
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "number": 0,
    "numberOfElements": 2,
    "first": true,
    "size": 5,
    "empty": false
}

Using ro as the Areas by Category response object in the example above, the relevant values are described below. See the Common Response Properties for more information about the standard list property descriptions.

Areas on a Floor by Category

Return a Details, Display, or Identity list of all areas on a specified building and floor that are assigned to a specified category.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/floors/<FLOOR-ID>/areas/<DATA-TYPE>?category=<CATEGORY> HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>

/v2/public/<BUILDING-ID>/floors/<FLOOR-ID>/areas/<DATA-TYPE>?category=<CATEGORY>&page=0&size=5

Where:

GET Request Example

https://10.130.160.150/
v2/public/C1B4/floors/F4/areas/identity?category=OPEN_OFFICE_SPACE&page=0&size=5

JSON Body Example

{
    "content": [
        {
            "name": "Construction Area",
            "publicId": "A125",
            "type": "52474f38-38aa-4ee8-8893-5541c0f5d04e"
        },
        {
            "name": "Construction Area",
            "publicId": "A131",
            "type": "52474f38-38aa-4ee8-8893-5541c0f5d04e"
        }
    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "paginated": true,
        "pageNumber": 0,
        "pageSize": 5,
        "offset": 0,
        "unpaged": false,
        "paged": true
    },
    "totalElements": 2,
    "totalPages": 1,
    "last": true,
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "number": 0,
    "numberOfElements": 2,
    "first": true,
    "size": 5,
    "empty": false
}

Using ro as the Areas by Category response object in the example above, the relevant values are described below. See the Common Response Properties for more information about the standard list property descriptions.

This section describes API calls that provide various views of the details of one area on the network.

Area Detail View

Return the detail information for a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/detail

JSON Body Example

{
  "updatedTime": "2018-06-05T15:58:57.961-0400",
  "createdTime": "2018-06-05T15:48:17.641-0400",
  "publicId": "A1",
  "type": "52474f38-38aa-4ee8-8893-5541c0f5d04e",
  "name": "Construction Area",
  "selectedScene": 1,
  "areaStatus": "GOOD",
  "sceneToSceneFadeTime": 1500,
  "offToSceneFadeTime": 1500,
  "zones": [
    { ZONE_OBJECT_PROPERTIES }, 
    { ZONE_OBJECT_PROPERTIES }
  ],
  "occupancySets": [
    { OCCUPANCY_SET_OBJECT_PROPERTIES }, 
    { OCCUPANCY_SET_OBJECT_PROPERTIES }
  ],
  "scenes": [
    { SCENE_OBJECT_PROPERTIES }, 
    { SCENE_OBJECT_PROPERTIES }
  ],
  "totalScenes": 1,
  "holdOccupancyDuration": 3600000,
  "areaDecorators": [
    { AREA_DECORATOR_OBJECT_PROPERTIES }, 
    { AREA_DECORATOR_OBJECT_PROPERTIES }
  ],
  "endpoints": [
    { ENDPOINT_OBJECT_PROPERTIES }, 
    { ENDPOINT_OBJECT_PROPERTIES }
  ],
  "capacity": 0,
  "isReachable": true,
  "isDefault": true,
  "hasAlerts": false,
  "isOccupiedLogical": true,
  "isOccupiedPhysical": true,
  "isHoldOccupancy": true
}

Using ro as the Area Detail response object in the example above, the relevant values are described below. See the Common Response Properties for more information about the standard list property descriptions.

Area Display View

Return the display information for a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/display

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/display

JSON Body Example

{
  "updatedTime": "2018-06-05T15:58:57.961-0400",
  "publicId": "A1",
  "type": "52474f38-38aa-4ee8-8893-5541c0f5d04e",
  "name": "Construction Area",
  "selectedScene": 2,
  "zones": [
    { ZONE_OBJECT_PROPERTIES }, 
    { ZONE_OBJECT_PROPERTIES }
  ],
  "occupancySets": [
    { OCCUPANCY_SET_OBJECT_PROPERTIES }, 
    { OCCUPANCY_SET_OBJECT_PROPERTIES },
  ],
  "scenes": [
    { SCENE_OBJECT_PROPERTIES },
    { SCENE_OBJECT_PROPERTIES }
  ],
  "areaDecorators": [
    { AREA_DECORATOR_OBJECT_PROPERTIES },
    { AREA_DECORATOR_OBJECT_PROPERTIES }
  ],
  "endpoints": [
    { ENDPOINT_OBJECT_PROPERTIES },
    { ENDPOINT_OBJECT_PROPERTIES }
  ],
  "capacity": 0,
  "isDefault": true,
  "hasAlerts": false
}

Using ro as the Area Display response object in the example above, the relevant values are described below.

Area Identity View

Return the identity information for a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/identity

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/identity

JSON Body Example

{
  "publicId": "A1",
  "type": "52474f38-38aa-4ee8-8893-5541c0f5d04e",
  "name": "Construction Area"
}

Using ro as the Area Display response object in the example above, the relevant values are described below.

This section describes API calls that provide various views of the endpoints assigned to a single area on the network.

All Endpoints Detail List

Returns a detail list of the endpoints in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/endpoints/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/endpoints/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/endpoints/detail

JSON Body Example

{
  "content": [
    { ENDPOINT_OBJECT_PROPERTIES },
    { ENDPOINT_OBJECT_PROPERTIES }    
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Endpoints Detail List response object in the example above, the relevant values are described below. See Common Response Properties for descriptions of the standard list response properties.

All Endpoints Display List

Returns a display list of the endpoints in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/endpoints/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/endpoints/display

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/endpoints/display

JSON Body Example

{
  "content": [
    { ENDPOINT_OBJECT_PROPERTIES },
    { ENDPOINT_OBJECT_PROPERTIES }    
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 8,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Endpoints Display List response object in the example above, the relevant values are described below. See Common Response Properties for descriptions of the standard list response properties.

All Endpoints Identity List

Returns an identity list of the endpoints in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/endpoints/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/endpoints/identity

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/endpoints/identity

JSON Body Example

{
  "content": [
    { ENDPOINT_OBJECT_PROPERTIES },
    { ENDPOINT_OBJECT_PROPERTIES }    
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 4,
  "numberOfElements": 4,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Endpoints Identity List response object in the example above, the relevant values are described below. See Common Response Properties for descriptions of the standard list response properties.

All Endpoints List in Ascending Order

Returns an identity list of all endpoints in a specified area, sorted in ascending order by name.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/endpoints/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER> HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/endpoints/identity?page=<PAGE-NUMBER>&size=<RESULTS-PER-PAGE>&sort=<SORT-FIELD>,<SORT-ORDER>

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/endpoints/identity?page=1&size=10&sort=name,ASC

JSON Body Example

{
  "content": [
    { ENDPOINT_OBJECT_PROPERTIES },
    { ENDPOINT_OBJECT_PROPERTIES }    
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 8,
  "numberOfElements": 8,
  "first": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "descending": false,
      "ascending": true
    }
  ],
  "size": 10,
  "number": 0
}

Using ro as the ascending All Endpoints List response object in the example above, the relevant values are described below. See Common Response Properties for descriptions of the standard list response properties.

All Endpoints List in Descending Order

Returns an identity list of all endpoints in a specified area, sorted in descending order by name.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/endpoints/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER> HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/endpoints/identity?page=<PAGE-NUMBER>&size=<RESULTS-PER-PAGE>&sort=<SORT-FIELD>,<SORT-ORDER>

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/endpoints/identity?page=1&size=10&sort=name,DESC

JSON Body Example

{
  "content": [
    { ENDPOINT_OBJECT_PROPERTIES },
    { ENDPOINT_OBJECT_PROPERTIES }    
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 8,
  "first": true,
  "sort": [
    {
      "direction": "DESC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "descending": true,
      "ascending": false
    }
  ],
  "size": 10,
  "number": 0
}

Using ro as the descending All Endpoints List response object in the example above, the relevant values are described below. See Common Response Properties for descriptions of the standard list response properties.

This section describes API calls that provide various views of the devices assigned to a single area on the network.

All Devices Detail List

Returns a detail list of all devices in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/devices/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/devices/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/devices/detail

JSON Body Example

{
  "content": [
    { DEVICE_OBJECT_PROPERTIES }, 
    { DEVICE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Devices Detail List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Devices Display List

Returns a display list of all devices in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/devices/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/devices/display

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/devices/display

JSON Body Example

  "content": [
    { DEVICE_OBJECT_PROPERTIES }, 
    { DEVICE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Devices Display List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Devices Identity List

Returns an identity list of all devices in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/devices/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/devices/identity

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/devices/identity

JSON Body Example

{
  "content": [
    { DEVICE_OBJECT_PROPERTIES }, 
    { DEVICE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Devices Identity List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Devices List in Ascending Order

Returns an identity list of all devices in a specified area, sorted in ascending order by name.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/devices/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER> HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/devices/identity?page=<PAGE-NUMBER>&size=<RESULTS-PER-PAGE>&sort=<SORT-FIELD>,<SORT-ORDER>

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/devices/identity?page=1&size=10&sort=name,ASC

JSON Body Example

{
  "content": [
    { DEVICE_OBJECT_PROPERTIES }, 
    { DEVICE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "descending": false,
      "ascending": true
    }
  ],
  "size": 10,
  "number": 0
}

Using ro as the ascending Devices List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Devices List in Descending Order

Returns an identity list of all devices in a specified area, sorted in descending order by name.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/devices/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER> HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/devices/identity?page=<PAGE-NUMBER>&size=<RESULTS-PER-PAGE>&sort=<SORT-FIELD>,<SORT-ORDER>

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/devices/identity?page=1&size=10&sort=name,DESC

JSON Body Example

{
  "content": [
    { DEVICE_OBJECT_PROPERTIES }, 
    { DEVICE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 6,
  "numberOfElements": 6,
  "first": true,
  "sort": [
    {
      "direction": "DESC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "descending": true,
      "ascending": false
    }
  ],
  "size": 10,
  "number": 0
}

Using ro as the descending Devices List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

This section describes API calls that provide various ways to view a list of scenes in a single area on the network.

Area Scene Detail View

Returns a detail view of a scene in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/scenes/<SCENE-ID>/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/scenes/<SCENE-ID>/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/scenes/S1/detail

JSON Body Example

{
  "updatedTime": "2018-06-05T16:18:36.987-0400",
  "createdTime": "2018-06-05T16:18:36.974-0400",
  "id": 7,
  "areaId": "e9432fea-ca14-11e7-bcea-001d054d15d2",
  "scenePublicId": "S49",
  "areaPublicId": "A1",
  "name": "Scene 6"
}

Using ro as the Area Scene Detail JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

Area Scene Display View

Returns a display view of a scenes in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/scenes/<SCENE-ID>/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/scenes/<SCENE-ID>/display

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/scenes/S1/display

JSON Body Example

{
  "updatedTime": "2018-06-05T16:18:36.987-0400",
  "createdTime": "2018-06-05T16:18:36.974-0400",
  "id": 7,
  "areaId": "e9432fea-ca14-11e7-bcea-001d054d15d2",
  "scenePublicId": "S49",
  "areaPublicId": "A1",
  "name": "Scene 6"
}

Using ro as the Area Scene Display JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

Area Scene Identity View

Returns an identity list of all scenes in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/scenes/<SCENE-ID>/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/scenes/<SCENE-ID>/identity

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/scenes/S1/identity

JSON Body Example

{
  "updatedTime": "2018-06-05T16:18:36.987-0400",
  "createdTime": "2018-06-05T16:18:36.974-0400",
  "id": 7,
  "areaId": "e9432fea-ca14-11e7-bcea-001d054d15d2",
  "scenePublicId": "S49",
  "areaPublicId": "A1",
  "name": "Scene 6"
}

Using ro as the Area Identity Detail JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

This section describes API calls that provide various ways to view a list of areas scenes on the network.

All Scenes Detail List

Return a detail list of all scenes in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/scenes/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/scenes/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/scenes/detail

JSON Body Example

{
  "content": [
    { SCENE_OBJECT_PROPERTIES }, 
    { SCENE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Area Scenes Detail List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Scenes Display List

Return a display list of all scenes in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/scenes/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/scenes/display

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/scenes/display

JSON Body Example

{
  "content": [
    { SCENE_OBJECT_PROPERTIES }, 
    { SCENE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Area Scenes Display List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Scenes Identity List

Return an identity list of all scenes in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/scenes/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/scenes/identity

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/scenes/identity

JSON Body Example

{
  "content": [
    { SCENE_OBJECT_PROPERTIES }, 
    { SCENE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 7,
  "numberOfElements": 7,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Area Scenes Identity List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Scenes List in Ascending Order

Return an identity list of all scenes in a specified area, sorted in ascending order by name.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/scenes/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER> HTTP/1.1
Authorization: bearer <PUBLIC-API-AUTH-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/scenes/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER>

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/identity?page=1&size=10&sort=name,ASC

JSON Body Example

{
  "content": [
    { SCENE_OBJECT_PROPERTIES }, 
    { SCENE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 7,
  "numberOfElements": 7,
  "first": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "descending": false,
      "ascending": true
    }
  ],
  "size": 10,
  "number": 0
}

Using ro as the ascending Area Scenes List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Scenes List in Descending Order

Return an identity list of all scenes in a specified area, sorted in descending order by name.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/scenes/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER> HTTP/1.1
Authorization: bearer <PUBLIC-API-AUTH-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/scenes/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER>

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/identity?page=1&size=10&sort=name,DESC

JSON Body Example

{
  "content": [
    { SCENE_OBJECT_PROPERTIES }, 
    { SCENE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 7,
  "numberOfElements": 7,
  "first": true,
  "sort": [
    {
      "direction": "DESC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "descending": true,
      "ascending": false
    }
  ],
  "size": 10,
  "number": 0
}

Using ro as the descending Area Scenes List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

This section describes API calls that provide various ways to view a list of zones in a specific area.

All Zones Detail List

Return a detail list of all zones in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/zones/<AREA-ID>/zones/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/zones/detail

JSON Body Example

{
  "content": [
    { ZONE_OBJECT_PROPERTIES },
    { ZONE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Zones Detail List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Zones Display List

Return a display list of all zones in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/display

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/zones/display

JSON Body Example

{
  "content": [
    { ZONE_OBJECT_PROPERTIES }, 
    { ZONE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Zones Display List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Zones Identity List

Return an identity list of all zones in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/identity

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/zones/identity

JSON Body Example

{
  "content": [
    { ZONE_OBJECT_PROPERTIES }, 
    { ZONE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Zones Identity List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Zones List in Ascending Order

Return an identity list of all zones in a specified area, sorted in ascending order by name.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER> HTTP/1.1
Authorization: bearer <PUBLIC-API-AUTH-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER>

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/zones/identity?page=1&size=10&sort=name,ASC

JSON Body Example

{
  "content": [
    { ZONE_OBJECT_PROPERTIES }, 
    { ZONE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "descending": false,
      "ascending": true
    }
  ],
  "size": 10,
  "number": 0
}

Using ro as the ascending All Zones List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Zones List in Descending Order

Return an identity list of all zones in a specified area, sorted in descending order by name.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER> HTTP/1.1
Authorization: bearer <PUBLIC-API-AUTH-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER>

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/zones?page=1&size=10&sort=name,DESC

JSON Body Example

{
  "content": [
    { ZONE_OBJECT_PROPERTIES }, 
    { ZONE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "numberOfElements": 2,
  "first": true,
  "sort": [
    {
      "direction": "DESC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "descending": true,
      "ascending": false
    }
  ],
  "size": 10,
  "number": 0
}

Using ro as the descending All Zones List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

This section describes API calls that provide various ways to view data for a single zone in a specific area.

Area Zone Detail View

Returns a detail view of one zone in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/<ZONE-ID>/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/<ZONE-ID>/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/zones/Z1/detail

JSON Body Example

{
  "updatedTime": "2018-06-05T16:24:07.639-0400",
  "createdTime": "2018-06-05T16:18:36.759-0400",
  "publicId": "Z1",
  "name": "Dimmable",
  "type": "3454641e-f73e-4517-8197-9084ec31d5e6",
  "zoneStatus": "UNKNOWN",
  "occupancySet": {
    OCCUPANCY_SET_OBJECT_PROPERTIES
  },
  "zoneDecorators": [
    {
      "name": "dimmableLight",
      "operationMode": "FOFO"
    }
  ],
  "isReachable": false,
  "isPartOfDemandResponse": true
}

Using ro as the Area Zones Detail JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

Area Zone Display View

Returns a display view of one zone in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/<ZONE-ID>/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/<ZONE-ID>/display

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/zones/Z1/display

JSON Body Example

{
  "updatedTime": "2018-06-05T16:24:07.639-0400",
  "publicId": "Z1",
  "name": "Dimmable",
  "type": "3454641e-f73e-4517-8197-9084ec31d5e6",
  "occupancySet": {
    OCCUPANCY_SET_OBJECT_PROPERTIES
  },
  "zoneDecorators": [
    {
      "name": "dimmableLight",
      "operationMode": "FOFO"
    }
  ],
  "isPartOfDemandResponse": true
}

Using ro as the Area Zones Display JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

Area Zone Identity View

Returns an identity view of one zone in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/<ZONE-ID>/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/<ZONE-ID>/identity

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/zones/Z1/identity

JSON Body Example

{
  "publicId": "Z1",
  "name": "Dimmable",
  "type": "3454641e-f73e-4517-8197-9084ec31d5e6"
}

Using ro as the Area Zones Identity JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Devices Detail List

Returns a detail list of all devices in one zone in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/<ZONE-ID>/devices/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/<ZONE-ID>/devices/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/zones/Z1/devices/detail

JSON Body Example

{
  "content": [
    { DEVICE_OBJECT_PROPERTIES },
    { DEVICE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 6,
  "numberOfElements": 6,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Devices Detail List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Devices Display List

Returns a display list of all devices in one zone in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/<ZONE-ID>/devices/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/<ZONE-ID>/devices/display

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/zones/Z1/devices/display

JSON Body Example

{
  "content": [
    { DEVICE_OBJECT_PROPERTIES },
    { DEVICE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 6,
  "numberOfElements": 6,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Devices Display List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Devices Identity List

Returns an identity list of all devices in one zone in a specified area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/<ZONE-ID>/devices/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/<ZONE-ID>/devices/identity

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/zones/Z1/devices/identity

JSON Body Example

{
  "content": [
    { DEVICE_OBJECT_PROPERTIES },
    { DEVICE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 6,
  "numberOfElements": 6,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Devices Identity List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Devices List in Ascending Order

Returns an identity list of all devices in one zone in a specified area, sorted in ascending order by name.>

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/<ZONE-ID>/devices/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER> HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/<ZONE-ID>/devices/identity?page=<PAGE-NUMBER>&size=<RESULTS-PER-PAGE>&sort=<SORT-FIELD>,<SORT-ORDER>

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/zones/Z1/devices/identity?page=1&size=10&sort=name,ASC

JSON Body Example

{
  "content": [
    { DEVICE_OBJECT_PROPERTIES },
    { DEVICE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 6,
  "numberOfElements": 6,
  "first": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "descending": false,
      "ascending": true
    }
  ],
  "size": 10,
  "number": 0
}

Using ro as the ascending All Devices List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Devices List in Descending Order

Returns an identity list of all devices in one zone in a specified area, sorted in descending order by name.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/<ZONE-ID>/devices/identity?page=<PAGE-NUMBER>&amp;size=<RESULTS-PER-PAGE>&amp;sort=<SORT-FIELD>,<SORT-ORDER> HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/zones/<ZONE-ID>/devices/identity?page=<PAGE-NUMBER>&size=<RESULTS-PER-PAGE>&sort=<SORT-FIELD>,<SORT-ORDER>

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/zones/Z1/devices/identity?page=1&size=10&sort=name,DESC

JSON Body Example

{
  "content": [
    { DEVICE_OBJECT_PROPERTIES },
    { DEVICE_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 6,
  "numberOfElements": 6,
  "first": true,
  "sort": [
    {
      "direction": "DESC",
      "property": "name",
      "ignoreCase": false,
      "nullHandling": "NATIVE",
      "descending": true,
      "ascending": false
    }
  ],
  "size": 10,
  "number": 0
}

Using ro as the descending All Devices List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

This section describes API calls that provide various ways to view a list of areas on the network.

All Occupancy Sets Detail List

Returns a detail list of all configured occupancy sets in a specific area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/occupancySets/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/occupancySets/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/occupancySets/detail

JSON Body Example

{
  "content": [
    { OCCUPANCY_SET_OBJECT_PROPERTIES },
    { OCCUPANCY_SET_OBJECT_PROPERTIES },
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Occupancy Sets Detail List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

All Occupancy Sets Display List

Return a display list of all configured occupancy sets in a specific area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/occupancySets/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/occupancySets/display

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/occupancySets/display

JSON Body Example

{
  "content": [
    { OCCUPANCY_SET_OBJECT_PROPERTIES },
    { OCCUPANCY_SET_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Occupancy Sets Display List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

NOTE

All Occupancy Sets Identity List

Return an identity list of all configured occupancy sets in a specific area.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/occupancySets/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/occupancySets/identity

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/occupancySets/identity

JSON Body Example

{
  "content": [
    { OCCUPANCY_SET_OBJECT_PROPERTIES },
    { OCCUPANCY_SET_OBJECT_PROPERTIES }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "first": true,
  "size": 100,
  "number": 0
}

Using ro as the All Occupancy Sets Identity List JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

This section describes API calls that provide various views of the details of a single Occupancy Set on the network.

Occupancy Set Detail View

Return the detail view for a specified occupancy set.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/occupancySets/<OCC-SET-ID>/detail HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/occupancySets/<OCC-SET-ID>/detail

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/occupancySets/OS2/detail

JSON Body Example

{
  "updatedTime": "2018-06-05T16:18:36.986-0400",
  "createdTime": "2018-06-05T16:18:36.750-0400",
  "publicId": "OS1",
  "name": "Default Occupancy",
  "zones": [
    { ZONE_OBJECT_PROPERTIES },
    { ZONE_OBJECT_PROPERTIES }
  ],
  "occupiedAction": {
    "id": "e99f7f20-ca14-11e7-8385-001d054d15d2",
    "name": "Occupied"
  },
  "unoccupiedAction": {
    "id": "e99e4204-ca14-11e7-9c31-001d054d15d2",
    "name": "Unoccupied"
  },
  "holdTime": 1200000,
  "area": { AREA_OBJECT_PROPERTIES },
  "isOccupiedLogical": true,
  "isOccupiedPhysical": true,
  "isAutoHoldTime": false,
  "isAutoOn": true
}

Using ro as the Occupancy Set Detail JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

Occupancy Set Display View

Return the display view for a specified occupancy set.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/occupancySets/<OCC-SET-ID>/display HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/occupancySets/<OCC-SET-ID>/display

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/occupancySets/OS2/display

JSON Body Example

{
  "updatedTime": "2018-06-05T16:18:36.986-0400",
  "publicId": "OS1",
  "name": "Default Occupancy",
  "zones": [
    { ZONE_OBJECT_PROPERTIES },
    { ZONE_OBJECT_PROPERTIES }
  ],
  "occupiedAction": {
    "updatedTime": "2018-06-05T16:18:36.986-0400",
    "id": "e99f7f20-ca14-11e7-8385-001d054d15d2",
    "name": "Occupied"
  },
  "unoccupiedAction": {
    "updatedTime": "2018-06-05T16:18:36.986-0400",
    "id": "e99e4204-ca14-11e7-9c31-001d054d15d2",
    "name": "Unoccupied"
  },
  "holdTime": 1200000,
  "area": { AREA_OBJECT_PROPERTIES },
  "isOccupiedLogical": true,
  "isOccupiedPhysical": true,
  "isAutoHoldTime": false,
  "isAutoOn": true
}

Using ro as the Occupancy Set Display JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.

Occupancy Set Identity View

Return the identity view for a specified occupancy set.

HTTP Header Fields

GET /v2/public/<BUILDING-ID>/areas/<AREA-ID>/occupancySets/<OCC-SET-ID>/identity HTTP/1.1
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/public/<BUILDING-ID>/areas/<AREA-ID>/occupancySets/<OCC-SET-ID>/identity

Where:

GET Request Example

https://192.168.2.100/v2/public/C1B1/areas/A1/occupancySets/<OCC-SET-ID>/identity

JSON Body Example

{
  "publicId": "OS2",
  "name": "Occupancy Set 1",
  "area": { AREA_OBJECT_PROPERTIES },
  "isOccupiedLogical": false
}

Using ro as the Occupancy Set Identity JSON response object in the example above, the relevant values are described below. See the Common Response Properties for descriptions of the standard list properties.