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/rtls/public/tags/display HTTP/1.1

The Trellix Locate 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: bearerf65f997a-6812-4c64-876b-dec7ad7d540a
Content-Type: application/json

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

Trellix Locate API calls are divided into the following categories, based on the type of data they return:

A typical session could look something like the following:

Trellix Locate 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 Locate, 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, such as getting the real-time location of an asset or the event history for an asset type.

API Token

An API token is a string of text that acts as a unique, single-session identifier of an application requesting access to the Locate API. For example, e55d3f8f-f1e2-41a8-9250-d6574f49387d.

To authenticate, you send an HTTP POST with the username APIUser (not case-sensitive) and a password configured by a Trellix administrator. For example:

https://192.168.1.99/uaa/oauth/token?grant_type=password&password=myAPIPassword&username=APIUser

The Locate API will return an access token you can use for subsequent requests.

Login Duration

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. With no activity 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.

The response to a Trellix Locate 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.

Example

The JSON below represents an array of tag objects in response to an All Tags Identity List call.

[
    {
        "name": "tag_A14C12",
        "inventoryId": "tag_A14C12",
        "macAddress": "A14C12"
    },
    {
        "name": "tag_A10E7D",
        "inventoryId": "tag_A10E7D",
        "macAddress": "A10E7D"
    }
]

The three views for displaying Trellix data that are found in most Locate API responses are described below.

Returns a detail list of all configured tags.

HTTP Header Fields

GET /v2/rtls/public/tags/detail HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

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

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/tags/detail

JSON Body Example

[
    {
        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
        "updatedTime": "2019-09-10T08:28:36.272-0400",
        "createdTime": "2019-08-26T15:22:16.537-0400",
        "name": "tag_A10D8B",
        "type": {
            "isDefault": false,
            "name": "Human Badge"
        },
        "batteryLevel": 95.0,
        "inventoryId": "tag_A10D8B",
        "beaconRateMotion": 1000,
        "beaconRateStatic": 3000,
        "model": "C7",
        "isRegistered": false,
        "isAssigned": false,
        "macAddress": "A10D8B"
    },
    {
        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
        "updatedTime": "2019-09-05T13:40:04.246-0400",
        "createdTime": "2019-08-26T13:31:11.210-0400",
        "name": "tag_2646D9",
        "type": {
            "isDefault": false,
            "name": "Human Badge"
        },
        "batteryLevel": 100.0,
        "inventoryId": "tag_2646D9",
        "beaconRateMotion": 1000,
        "beaconRateStatic": 3000,
        "model": "C7",
        "isRegistered": true,
        "isAssigned": true,
        "macAddress": "2646D9"
    }
]

JSON Response Values

Using ra as the All Tags - Detail List response array in the example above, the relevant values are described below.

Returns a display list of all configured tags.

HTTP Header Fields

GET /v2/rtls/public/tags/display
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

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

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/tags/display

JSON Body Example

[
    {
        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
        "updatedTime": "2019-09-10T08:28:36.272-0400",
        "name": "tag_A10D8B",
        "type": {
            "isDefault": false,
            "name": "Human Badge"
        },
        "batteryLevel": 100.0,
        "inventoryId": "tag_A10D8B",
        "model": "C7",
        "isRegistered": false,
        "isAssigned": false,
        "macAddress": "A10D8B"
    },
    {
        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
        "updatedTime": "2019-09-05T13:40:04.246-0400",
        "name": "tag_2646D9",
        "type": {
            "isDefault": false,
            "name": "Human Badge"
        },
        "batteryLevel": 80.0,
        "inventoryId": "tag_2646D9",
        "model": "C7 ", 
        "isRegistered": true,
        "isAssigned": true,
        "macAddress": "2646D9"
    }
]

JSON Response Values

Using ra as the All Tags - Display List response array in the example above, the relevant values are described below.

Returns an identity list of all configured tags.

HTTP Header Fields

GET /v2/rtls/public/tags/identity HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

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

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/tags/identity

JSON Body Example

[
    {
        "name": "tag_A14C12",
        "inventoryId": "tag_A14C12",
        "macAddress": "A14C12"
    },
    {
        "name": "tag_A10E9D",
        "inventoryId": "tag_A10E9D",
        "macAddress": "A10E9D"
    },
    {
        "name": "tag_A10E7D",
        "inventoryId": "tag_A10E7D",
        "macAddress": "A10E7D"
    }
]

JSON Response Values

Using ra as the All Tags - Identity List response array in the example above, the relevant values are described below.

Return the detail view for a specified tag ID.

HTTP Header Fields

GET /v2/rtls/public/tags/<TAG-ID>/detail HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/tags/<TAG-ID>/detail

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/tags/tag_2646D9/detail

JSON Body Example

{
    "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
    "updatedTime": "2019-09-05T13:40:04.246-0400",
    "createdTime": "2019-08-26T13:31:11.210-0400",
    "name": "tag_2646D9",
    "type": {
        "isDefault": false,
        "name": "Human Badge"
    },
    "batteryLevel": 100.0,
    "inventoryId": "tag_2646D9",
    "isRegistered": true,
    "isAssigned": true,
    "macAddress": "2646D9"
}

JSON Response Values

Using ro as the Tag by ID – Detail View response object in the example above, the relevant values are described below.

Return the display view for a specified tag ID.

HTTP Header Fields

GET /v2/rtls/public/tags/<TAG-ID>/display HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/tags/<TAG-ID>/display

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/tags/tag_A14C13/display

JSON Body Example

{
    "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
    "updatedTime": "2019-09-12T07:53:04.340-0400",
    "name": "tag_A14C13",
    "type": {
        "isDefault": false,
        "name": "Asset Tag 2yr"
    },
    "batteryLevel": 21.0,
    "inventoryId": "tag_A14C13",
    "isRegistered": true,
    "isAssigned": true,
    "macAddress": "A14C13"
}

JSON Response Values

Using ro as the Tag by ID – Display View response object in the example above, the relevant values are described below.

Return the identity view for a specified tag ID.

HTTP Header Fields

GET /v2/rtls/public/tags/<TAG-ID>/identity HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/tags/<TAG-ID>/identity

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/tags/tag_A14C13/identity

JSON Body Example

{
    "name": "tag_A14C13",
    "inventoryId": "tag_A14C13",
    "macAddress": "A14C13"
}

JSON Response Values

Using ro as the Tag by ID - Identity View response object in the example above, the relevant values are described below.

Returns a detail list of all configured tags for a specified tag type.

HTTP Header Fields

GET /v2/rtls/public/tags/type/<TAG-TYPE>/detail HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/tags/type/<TAG-TYPE>/detail

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/tags/type/56af3c5f-669a-40af-9a54-2434405d9dcd/detail

JSON Body Example

[
    {
        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
        "updatedTime": "2019-09-05T13:40:04.246-0400",
        "createdTime": "2019-08-26T13:31:11.210-0400",
        "name": "tag_2646D9",
        "type": {
            "isDefault": false,
            "name": "Human Badge"
        },
        "batteryLevel": 100.0,
        "inventoryId": "tag_2646D9",
        "isRegistered": true,
        "isAssigned": true,
        "macAddress": "2646D9"
    },
    {
        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
        "updatedTime": "2019-08-28T08:09:45.686-0400",
        "createdTime": "2019-08-26T13:31:11.217-0400",
        "name": "tag_2646D5",
        "type": {
            "isDefault": false,
            "name": "Human Badge"
        },
        "inventoryId": "tag_2646D5",
        "isRegistered": true,
        "isAssigned": true,
        "macAddress": "2646D5"
    }
]

JSON Response Values

Using ra as the Tag Detail response array in the example above, the relevant values are described below.

Return on display list of all configured tags for a specified tag type.

HTTP Header Fields

GET /v2/rtls/public/tags/type/<TAG-TYPE>/display HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/tags/type/<TAG-TYPE>/display

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/tags/type/56af3c5f-669a-40af-9a54-2434405d9dcd/display

JSON Body Example

[
    {
        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
        "updatedTime": "2019-09-05T13:40:04.246-0400",
        "name": "tag_2646D9",
        "type": {
            "isDefault": false,
            "name": "Human Badge"
        },
        "batteryLevel": 100.0,
        "inventoryId": "tag_2646D9",
        "isRegistered": true,
        "isAssigned": true,
        "macAddress": "2646D9"
    },
    {
        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
        "updatedTime": "2019-08-28T08:09:45.686-0400",
        "name": "tag_2646D5",
        "type": {
            "isDefault": false,
            "name": "Human Badge"
        },
        "inventoryId": "tag_2646D5",
        "isRegistered": true,
        "isAssigned": true,
        "macAddress": "2646D5"
    }
]

JSON Response Values

Using ra as the Tag by Type – Display View response array in the example above, the relevant values are described below.

Returns an identity list of all configured tags for a specified tag type.

HTTP Header Fields

GET /v2/rtls/public/tags/type/<TAG-TYPE>/identity HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/tags/type/<TAG-TYPE>/identity

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/tags/type/56af3c5f-669a-40af-9a54-2434405d9dcd/identity

JSON Body Example

[
    {
        "name": "tag_2646D9",
        "inventoryId": "tag_2646D9",
        "macAddress": "2646D9"
    },
    {
        "name": "tag_2646D5",
        "inventoryId": "tag_2646D5",
        "macAddress": "2646D5"
    }
]

JSON Response Values

Using ra as the Tag by Type – Identity List response array in the example above, the relevant values are described below.

Returns a detail list of all configured assets.

HTTP Header Fields

GET /v2/rtls/public/assets/detail HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

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

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/detail

JSON Body Example

[
    {
        "createdTime": "2019-08-26T14:22:27.296-0400",
        "departments": [
            {
                "id": "d97da5d9-4c94-482c-a457-74f5213e04de",
                "name": "Dermatology"
            }
        ],
        "inventoryId": "1234567",
        "name": "Test",
        "propertyValues": [
            {
                "property": {
                    "default": "0",
                    "displayName": "alarmCount",
                    "id": "ca9d04ed-9803-442d-ac5d-7926bbe931f1",
                    "mandatory": false,
                    "name": "alarmCount",
                    "operation": "RW",
                    "type": "INTEGER",
                    "updatedTime": "2019-08-27T02:15:37.695548-04:00"
                },
                "updatedTime": "2019-09-12T10:48:17.030-0400",
                "value": "1"
            }
        ],
        "tags": [
            {
                "name": "tag_270D09",
                "inventoryId": "tag_270D09",
                "macAddress": "270D09"
            }
        ],
        "type": {
            "id": "11c9ab74-6852-11e9-a923-1681be663d3e",
            "isDefault": false,
            "name": "Foot Pumps"
        },
        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
        "updatedTime": "2019-09-09T13:38:19.197-0400"
    }
]

JSON Response Values

Using ra as the All Assets - Detail List response array in the example above, the relevant values are described below.

Returns a display list of all configured assets.

HTTP Header Fields

GET /v2/rtls/public/assets/display
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

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

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/display

JSON Body Example

[
    {
        "departments": [
            {
                "id": "d97da5d9-4c94-482c-a457-74f5213e04de",
                "name": "Dermatology"
            }
        ],
        "inventoryId": "1234567",
        "name": "Test",
        "propertyValues": [
            {
                "property": {
                    "default": "0",
                    "displayName": "alarmCount",
                    "id": "ca9d04ed-9803-442d-ac5d-7926bbe931f1",
                    "mandatory": false,
                    "name": "alarmCount",
                    "operation": "RW",
                    "type": "INTEGER",
                    "updatedTime": "2019-08-27T02:15:37.695548-04:00"
                },
                "updatedTime": "2019-09-12T10:48:17.030-0400",
                "value": "1"
            }
        ],
        "tags": [
            {
                "name": "tag_270D09",
                "inventoryId": "tag_270D09",
                "macAddress": "270D09"
            }
        ],
        "type": {
            "id": "11c9ab74-6852-11e9-a923-1681be663d3e",
            "isDefault": false,
            "name": "Foot Pumps"
        },
        "updatedBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
        "updatedTime": "2019-09-09T13:38:19.197-0400"
    }
]

JSON Response Values

Using ra as the All Assets - Display List response array in the example above, the relevant values are described below.

Returns an identity list of all configured assets.

HTTP Header Fields

GET /v2/rtls/public/assets/identity
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

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

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/identity

JSON Body Example

[
    {
        "inventoryId": "1234567",
        "name": "Test"
    },
    {
        "inventoryId": "Office_3",
        "name": "Office_Tag_46D5_Battery"
    },
    {
        "inventoryId": "NotTagAsset2",
        "name": "NotTagAsset2"
    },
    {
        "inventoryId": "NoTagAsset1",
        "name": "NoTagAsset1"
    }
]

JSON Response Values

Using ra as the All Assets - Identity List response array in the example above, the relevant values are described below.

Returns a detail view of an asset specified by ID.

HTTP Header Fields

GET /v2/rtls/public/assets/<ASSET-ID>/detail HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/<ASSET-ID>/detail

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/Office_1/detail

JSON Body Example

{
    "createdBy": "69add548-ec7c-49ba-aec1-0cabb5e2238c",
    "createdTime": "2019-09-05T13:40:04.228-0400",
    "departments": [
        {
            "id": "e5fa967b-b0f0-4007-9a31-d7121656230b",
            "name": "Anesthesiology & Perioperative Care"
        }
    ],
    "inventoryId": "Office_1",
    "name": "Office_Tag_46D9_Battery",
    "propertyValues": [
        {
            "property": {
                "displayName": "Inventory ID",
                "displayOrder": -1,
                "id": "71f3931e-f7fe-4b1d-a5e1-adf0eac4e8aa",
                "isHidden": false,
                "mandatory": false,
                "name": "property_43186",
                "operation": "RW",
                "range": "1-200",
                "type": "STRING",
                "updatedTime": "2019-08-26T14:39:16.519216-04:00"
            },
            "updatedTime": "2019-09-05T13:55:32.625-0400"
        },
        {
            "property": {
                "default": "0",
                "displayName": "alarmCount",
                "id": "0d84a539-ca69-4b65-a4e3-1c6e3e907b98",
                "mandatory": false,
                "name": "alarmCount",
                "operation": "RW",
                "type": "INTEGER",
                "updatedTime": "2019-08-27T02:15:37.712057-04:00"
            },
            "updatedTime": "2019-09-13T15:51:11.772-0400",
            "value": "5"
        }
    ],
    "tags": [
        {
            "name": "tag_2646D9",
            "inventoryId": "tag_2646D9",
            "macAddress": "2646D9"
        }
    ],
    "type": {
        "id": "11c9f4e4-6852-11e9-a923-1681be663d3e",
        "isDefault": false,
        "name": "Aerosol Tents"
    },
    "updatedBy": "51a3fc1a-61a4-4e18-a576-aa27da0a9f89",
    "updatedTime": "2019-09-05T13:55:32.625-0400"
}

JSON Response Values

Using ro as the Asset by ID - Detail View response object in the example above, the relevant values are described below.

Returns a display view of an asset specified by ID.

HTTP Header Fields

GET /v2/rtls/public/assets/<ASSET-ID>/display
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/<ASSET-ID>/display

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/Office_2/display

JSON Body Example

{
    "departments": [
        {
            "id": "bf8d94ee-e642-4f0c-bc84-3afa2660f57e",
            "name": "Neonatal intensive care unit"
        }
    ],
    "inventoryId": "Office_2",
    "name": "Office_Tag_46D6_Battery",
    "propertyValues": [
        {
            "property": {
                "displayName": "Name",
                "displayOrder": -1,
                "id": "3d7186e4-24ee-42cc-8b2b-1270eb13c8f4",
                "isHidden": false,
                "mandatory": false,
                "name": "property_63512",
                "operation": "RW",
                "range": "1-32",
                "type": "STRING",
                "updatedTime": "2019-08-26T14:45:59.550288-04:00"
            },
            "updatedTime": "2019-09-05T13:55:11.784-0400",
            "value": "Nitesh"
        },
        {
            "property": {
                "default": "0",
                "displayName": "alarmCount",
                "id": "03fa9211-066a-44a3-8b07-30f307ff85b1",
                "mandatory": false,
                "name": "alarmCount",
                "operation": "RW",
                "type": "INTEGER",
                "updatedTime": "2019-08-27T02:15:37.70357-04:00"
            },
            "updatedTime": "2019-09-13T15:51:11.789-0400",
            "value": "5"
        }
    ],
    "tags": [
        {
            "name": "tag_2646D6",
            "inventoryId": "tag_2646D6",
            "macAddress": "2646D6"
        }
    ],
    "type": {
        "id": "f254ae04-6853-11e9-a923-1681be663d3e",
        "isDefault": false,
        "name": "Babies"
    },
    "updatedBy": "51a3fc1a-61a4-4e18-a576-aa27da0a9f89",
    "updatedTime": "2019-09-05T13:55:11.784-0400"
}

JSON Response Values

Using ro as the Asset by ID - Display View response object in the example above, the relevant values are described below.

Returns an identity view of an asset specified by ID.

HTTP Header Fields

GET /v2/rtls/public/assets/<ASSET-ID>/identity
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/<ASSET-ID>/identity

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/Office_1/identity

JSON Body Example

{
    "inventoryId": "Office_1",
    "name": "Office_Tag_46D9_Battery"
}

JSON Response Values

Using ra as the Asset by ID - Identity View response array in the example above, the relevant values are described below.

Returns a detail list of assets by type.

HTTP Header Fields

GET /v2/rtls/public/assets/type/<ASSET-TYPE>/detail HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/type/<ASSET-TYPE>/detail

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/type/f254b516-6853-11e9-a923-1681be663d3e/detail

JSON Body Example

[
    {
        "createdBy": "dbf78335-65c6-486b-b5f8-71ed61438c41",
        "createdTime": "2019-09-10T14:47:12.211-0400",
        "departments": [
            {
                "id": "73d5997d-1e70-46f6-9367-4ecba984a35a",
                "name": "Cardiology"
            }
        ],
        "inventoryId": "NotTagAsset2",
        "name": "NotTagAsset2",
        "propertyValues": [
            {
                "property": {
                    "default": "0",
                    "displayName": "alarmCount",
                    "id": "49ae6029-81e7-446a-9f54-c221a251f7f4",
                    "mandatory": false,
                    "name": "alarmCount",
                    "operation": "RW",
                    "type": "INTEGER",
                    "updatedTime": "2019-08-27T02:15:37.700282-04:00"
                },
                "updatedTime": "2019-09-10T14:47:12.223-0400"
            }
        ],
        "type": {
            "id": "f254b516-6853-11e9-a923-1681be663d3e",
            "isDefault": false,
            "name": "Cleaning Crew"
        },
        "updatedBy": "dbf78335-65c6-486b-b5f8-71ed61438c41",
        "updatedTime": "2019-09-10T14:47:12.223-0400"
    }
]

JSON Response Values

Using ra as the Assets by Type - Detail List response array in the example above, the relevant values are described below.

Returns a display list of assets by type.

HTTP Header Fields

GET /v2/rtls/public/assets/type/<ASSET-TYPE>/display HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/type/<ASSET-TYPE>/display

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/type/f254b516-6853-11e9-a923-1681be663d3e/display

JSON Body Example

[
    {
        "departments": [
            {
                "id": "73d5997d-1e70-46f6-9367-4ecba984a35a",
                "name": "Cardiology"
            }
        ],
        "inventoryId": "NotTagAsset2",
        "name": "NotTagAsset2",
        "propertyValues": [
            {
                "property": {
                    "default": "0",
                    "displayName": "alarmCount",
                    "id": "49ae6029-81e7-446a-9f54-c221a251f7f4",
                    "mandatory": false,
                    "name": "alarmCount",
                    "operation": "RW",
                    "type": "INTEGER",
                    "updatedTime": "2019-08-27T02:15:37.700282-04:00"
                },
                "updatedTime": "2019-09-10T14:47:12.223-0400"
            }
        ],
        "type": {
            "id": "f254b516-6853-11e9-a923-1681be663d3e",
            "isDefault": false,
            "name": "Cleaning Crew"
        },
        "updatedBy": "dbf78335-65c6-486b-b5f8-71ed61438c41",
        "updatedTime": "2019-09-10T14:47:12.223-0400"
    }
]

JSON Response Values

Using ra as the Assets by Type - Display List response array in the example above, the relevant values are described below.

Returns an identity list of assets by type.

HTTP Header Fields

GET /v2/rtls/public/assets/type/<ASSET-TYPE>/identity HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/type/<ASSET-TYPE>/identity

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/type/f254b516-6853-11e9-a923-1681be663d3e/identity

JSON Body Example

[
    {
        "inventoryId": "HighTagAsset1",
        "name": " HighTagAsset1"
    },
    {
        "inventoryId": " MidTagAsset2",
        "name": " MidTagAsset2"
    },
    {
        "inventoryId": "LowTagAsset3",
        "name": "LowTagAsset3"
    }
]

JSON Response Values

Using ra as the Assets by Type - Identity List response array in the example above, the relevant values are described below.

Returns a detail list of all configured geo-fences.

HTTP Header Fields

GET /v2/rtls/public/geofences/detail HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

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

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/geofences/detail

JSON Body Example

[
    {
        "createdBy": "45bb301c-6c60-4115-a484-88a439a69f21",
        "createdTime": "2019-08-26T15:22:16.537-0400",
        "decorators": [
            {
                "createdTime": "2019-08-28T11:45:08.151-0400",
                "id": "17c04971-26d2-37e1-3356-ffb62053c07f",
                "isViewable": true,
                "name": "floorPlanProperties",
                "polygon": [
                    {
                        "x": 601.3897,
                        "y": 687.0397
                    },
                    {
                        "x": 785.88824,
                        "y": 682.18445
                    },
                    {
                        "x": 776.1778,
                        "y": 799.51904
                    },
                    {
                        "x": 604.6265,
                        "y": 804.37427
                    }
                ],
                "text": {
                    "fontSize": 12,
                    "position": "top-center"
                },
                "updatedTime": "2019-08-28T11:45:08.151-0400"
            }
        ],
        "floor": {
            "name": "DeleteFloor",
            "publicId": "F1"
        },
        "hysteresis": 0.0,
        "hysteresisEnabled": true,
        "isEnabled": true,
        "isHidden": true,
        "name": "Sample",
        "rules": [
            {
                "actions": [
                    "ALARM",
                    "EVENT"
                ],
                "createdTime": "2019-08-26T15:34:14.484-0400",
                "rule": {
                    "id": "953eb0ab-0216-4940-8950-cadee84f96cc",
                    "name": "Entry"
                },
                "scopes": [
                    {
                        "appliesTo": "DEPARTMENT",
                        "appliesToId": "73f53826-2d7b-41dc-bc01-74a7588f462b",
                        "id": "73f53826-2d7b-41dc-bc01-74a7588f462b"
                    },
                    {
                        "appliesTo": "DEPARTMENT",
                        "appliesToId": "34f3a24f-e515-4427-b715-7c90721072a0",
                        "id": "34f3a24f-e515-4427-b715-7c90721072a0"
                    },
                    {
                        "appliesTo": "DEPARTMENT",
                        "appliesToId": "f9bbcdc1-9e47-4ed0-a36f-b555bccb3be9",
                        "id": "f9bbcdc1-9e47-4ed0-a36f-b555bccb3be9"
                    }
                ],
                "updatedTime": "2019-09-03T13:22:31.935-0400"
            }
        ],
        "type": {
            "id": "3322c868-eee6-11e8-8eb2-f2801f1b9fd1",
            "isDefault": true,
            "name": "Safety/Security"
        },
        "updatedBy": "44bb677d-c701-45af-a71d-f92ea16712ad",
        "updatedTime": "2019-08-28T11:45:08.151-0400"
    }
]

JSON Response Values

Using ra as the All Geo-Fences - Detail List response array in the example above, the relevant values are described below.

Returns a display list of all configured geo-fences.

HTTP Header Fields

GET /v2/rtls/public/geofences/display HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

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

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/geofences/display

JSON Body Example

[
    {
        "decorators": [
            {
                "createdTime": "2019-09-15T12:08:18.163-0400",
                "id": "17c04971-26d2-37e1-3356-ffb62053c07f",
                "isViewable": true,
                "name": "floorPlanProperties",
                "polygon": [
                    {
                        "x": 601.3897,
                        "y": 687.0397
                    },
                    {
                        "x": 785.88824,
                        "y": 682.18445
                    },
                    {
                        "x": 776.1778,
                        "y": 799.51904
                    },
                    {
                        "x": 604.6265,
                        "y": 804.37427
                    }
                ],
                "text": {
                    "fontSize": 12,
                    "position": "top-center"
                },
                "updatedTime": "2019-08-28T11:45:08.151-0400"
            }
        ],
        "floor": {
            "name": "DeleteFloor",
            "publicId": "F1"
        },
        "hysteresis": 0.0,
        "hysteresisEnabled": true,
        "isEnabled": true,
        "isHidden": true,
        "name": "Sample",
        "rules": [
            {
                "actions": [
                    "ALARM",
                    "EVENT"
                ],
                "createdTime": "2019-08-26T15:34:14.484-0400",
                "rule": {
                    "id": "953eb0ab-0216-4940-8950-cadee84f96cc",
                    "name": "Entry"
                },
                "scopes": [
                    {
                        "appliesTo": "DEPARTMENT",
                        "appliesToId": "73f53826-2d7b-41dc-bc01-74a7588f462b",
                        "id": "73f53826-2d7b-41dc-bc01-74a7588f462b"
                    },
                    {
                        "appliesTo": "DEPARTMENT",
                        "appliesToId": "34f3a24f-e515-4427-b715-7c90721072a0",
                        "id": "34f3a24f-e515-4427-b715-7c90721072a0"
                    },
                    {
                        "appliesTo": "DEPARTMENT",
                        "appliesToId": "f9bbcdc1-9e47-4ed0-a36f-b555bccb3be9",
                        "id": "f9bbcdc1-9e47-4ed0-a36f-b555bccb3be9"
                    }
                ],
                "updatedTime": "2019-09-03T13:22:31.935-0400"
            }
        ],
        "type": {
            "id": "3322c868-eee6-11e8-8eb2-f2801f1b9fd1",
            "isDefault": true,
            "name": "Safety/Security"
        },
        "updatedBy": "44bb677d-c701-45af-a71d-f92ea16712ad",
        "updatedTime": "2019-08-28T11:45:08.151-0400"
    }
]

JSON Response Values

Using ra as the All Geo-Fences - Display List response array in the example above, the relevant values are described below.

Returns an identity list of all configured geo-fences.

HTTP Header Fields

GET /v2/rtls/public/geofences/identity HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

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

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/geofences/identity

JSON Body Example

[
    {
        "name": "Neo-Natal"
    },
    {
        "name": "Emergency"
    },
    {
        "name": "Cardiology"
    },
    {
        "name": "Receiving"
    },
]

JSON Response Values

Using ra as the All Geo-Fences - Identity List response array in the example above, the relevant values are described below.

Returns a detail list of a specified geo-fence.

HTTP Header Fields

GET /v2/rtls/public/geofences/<GEO-FENCE-TOKEN>/detail HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/geofences/<GEO-FENCE-TOKEN>/detail

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/geofences/a612eb71-f527-4b4d-a44a-ad4190df05a9/detail

JSON Body Example

{
    "createdBy": "bcda585b-a4e5-46df-b89c-65a629f6844f",
    "createdTime": "2019-08-28T11:45:08.151-0400",
    "decorators": [
        {
            "createdTime": "2019-08-28T13:55:20.659-0400",
            "id": "04721c8c-d11b-162d-baea-568ecae24562",
            "isViewable": true,
            "name": "floorPlanProperties",
            "polygon": [
                {
                    "x": 142.39656,
                    "y": 166.78516
                },
                {
                    "x": 420.4534,
                    "y": 188.49336
                }
            ],
            "text": {
                "fontSize": 12,
                "position": "top-center"
            },
            "updatedTime": "2019-08-28T13:55:20.659-0400"
        }
    ],
    "floor": {
        "name": "DeleteFloor",
        "publicId": "F1"
    },
    "hysteresis": 0.0,
    "hysteresisEnabled": true,
    "isEnabled": true,
    "isHidden": true,
    "name": "MyGeoasf",
    "rules": [
        {
            "actions": [
                "ALARM",
                "EVENT"
            ],
            "createdTime": "2019-08-28T08:07:23.946-0400",
            "rule": {
                "id": "9cbc08fb-767c-415e-a8c0-9eaa546058d4",
                "name": "Exit"
            },
            "scopes": [
                {
                    "appliesTo": "ASSET",
                    "appliesToId": "129a292a-e279-4dab-bb8e-42d10d869a35",
                    "id": "129a292a-e279-4dab-bb8e-42d10d869a35"
                },
                {
                    "appliesTo": "ASSET",
                    "appliesToId": "affa0d6b-955c-4d1a-b662-2b80b8a43440",
                    "id": "affa0d6b-955c-4d1a-b662-2b80b8a43440"
                },
                {
                    "appliesTo": "ASSET",
                    "appliesToId": "f1e88f91-b2e4-49b7-a885-97c11f9482cc",
                    "id": "f1e88f91-b2e4-49b7-a885-97c11f9482cc"
                }
            ],
            "updatedTime": "2019-08-28T14:47:52.991-0400"
        }
    ],
    "type": {
        "id": "3322c868-eee6-11e8-8eb2-f2801f1b9fd1",
        "isDefault": true,
        "name": "Safety/Security"
    },
    "updatedBy": "3e18ca5c-5f7f-4731-86ad-86dda63f0933",
    "updatedTime": "2019-08-28T14:47:52.991-0400"
}

JSON Response Values

Using ro as the Geo-Fence by ID - Detail List response object in the example above, the relevant values are described below.

Returns a display list of a specified geo-fence.

HTTP Header Fields

GET /v2/rtls/public/geofences/<GEO-FENCE-TOKEN>/display HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/geofences/<GEO-FENCE-TOKEN>/display

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/geofences/a612eb71-f527-4b4d-a44a-ad4190df05a9/display

JSON Body Example

{
    "decorators": [
        {
            "createdTime": "2019-08-28T13:55:20.659-0400",
            "id": "04721c8c-d11b-162d-baea-568ecae24562",
            "isViewable": true,
            "name": "floorPlanProperties",
            "polygon": [
                {
                    "x": 142.39656,
                    "y": 166.78516
                },
                {
                    "x": 420.4534,
                    "y": 188.49336
                }
            ],
            "text": {
                "fontSize": 12,
                "position": "top-center"
            },
            "updatedTime": "2019-08-28T13:55:20.659-0400"
        }
    ],
    "floor": {
        "name": "DeleteFloor",
        "publicId": "F1"
    },
    "hysteresis": 0.0,
    "hysteresisEnabled": true,
    "isEnabled": true,
    "isHidden": true,
    "name": "MyGeoasf",
    "rules": [
        {
            "actions": [
                "ALARM",
                "EVENT"
            ],
            "createdTime": "2019-08-28T08:07:23.946-0400",
            "rule": {
                "id": "9cbc08fb-767c-415e-a8c0-9eaa546058d4",
                "name": "Exit"
            },
            "scopes": [
                {
                    "appliesTo": "ASSET",
                    "appliesToId": "129a292a-e279-4dab-bb8e-42d10d869a35",
                    "id": "129a292a-e279-4dab-bb8e-42d10d869a35"
                },
                {
                    "appliesTo": "ASSET",
                    "appliesToId": "affa0d6b-955c-4d1a-b662-2b80b8a43440",
                    "id": "affa0d6b-955c-4d1a-b662-2b80b8a43440"
                },
                {
                    "appliesTo": "ASSET",
                    "appliesToId": "f1e88f91-b2e4-49b7-a885-97c11f9482cc",
                    "id": "f1e88f91-b2e4-49b7-a885-97c11f9482cc"
                }
            ],
            "updatedTime": "2019-08-28T14:47:52.991-0400"
        }
    ],
    "type": {
        "id": "3322c868-eee6-11e8-8eb2-f2801f1b9fd1",
        "isDefault": true,
        "name": "Safety/Security"
    },
    "updatedBy": "3e18ca5c-5f7f-4731-86ad-86dda63f0933",
    "updatedTime": "2019-08-28T14:47:52.991-0400"
}

JSON Response Values

Using ro as the Geo-Fence by ID - Display List response object in the example above, the relevant values are described below.

Returns an identity list of a specified geo-fence.

HTTP Header Fields

GET /v2/rtls/public/geofences/<GEO-FENCE-TOKEN>/identity HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/geofences/<GEO-FENCE-TOKEN>/identity

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/geofences/a612eb71-f527-4b4d-a44a-ad4190df05a9/identity

JSON Body Example

{
    "name": "MyGeoasf"
}

JSON Response Values

Using ro as the Geo-Fence by ID - Identity List response object in the example above, the relevant values are described below.

HTTP Header Fields

GET /v2/rtls/public/alarms/geofences/assets/detail HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

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

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/alarms/geofences/assets/detail

JSON Body Example

[
    {
        "updatedTime": "2019-09-11T10:27:34.357919-04:00",
        "createdTime": "2019-09-11T10:27:34.357629-04:00",
        "description": "Tag A1549B entered in NewGeo!",
        "status": "ACTIVE",
        "occurrenceTime": "2019-09-11T14:27:34.354Z",
        "sourceType": "Defibrillators",
        "sourceName": "Office_Tag_0DF7_Button",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_4"
    },
    {
        "updatedTime": "2019-09-11T10:25:19.358383-04:00",
        "createdTime": "2019-09-11T10:25:19.358188-04:00",
        "description": "Tag A1549B entered in NewGeo!",
        "status": "ACTIVE",
        "occurrenceTime": "2019-09-11T14:25:19.355Z",
        "sourceType": "Defibrillators",
        "sourceName": "Office_Tag_0DF7_Button",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_4"
    }
]

JSON Response Values

Using ra as the All Geo-Fence Alarms - Detail List response array in the example above, the relevant values are described below.

HTTP Header Fields

GET /v2/rtls/public/alarms/geofences/assets/display HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

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

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/alarms/geofences/assets/display

JSON Body Example

[
    {
        "updatedTime": "2019-09-11T10:27:34.357919-04:00",
        "createdTime": "2019-09-11T10:27:34.357629-04:00",
        "description": "Tag A1549B entered in NewGeo!",
        "status": "ACTIVE",
        "occurrenceTime": "2019-09-11T14:27:34.354Z",
        "sourceType": "Defibrillators",
        "sourceName": "Office_Tag_0DF7_Button",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_4"
    },
    {
        "updatedTime": "2019-09-11T10:25:19.358383-04:00",
        "createdTime": "2019-09-11T10:25:19.358188-04:00",
        "description": "Tag A1549B entered in NewGeo!",
        "status": "ACTIVE",
        "occurrenceTime": "2019-09-11T14:25:19.355Z",
        "sourceType": "Defibrillators",
        "sourceName": "Office_Tag_0DF7_Button",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_4"
    }
]

JSON Response Values

Using ra as the All Geo-Fence Alarms - Display List response array in the example above, the relevant values are described below.

HTTP Header Fields

GET /v2/rtls/public/alarms/geofences/assets/identity HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/alarms/geofences/assets/identity

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/alarms/geofences/assets/identity

JSON Body Example

[
    {
        "status": "ACTIVE",
        "occurrenceTime": "2019-09-11T14:27:34.354Z",
        "sourceName": "Office_Tag_0DF7_Button",
        "sourcePublicId": "Office_4"
    },
    {
        "status": "ACTIVE",
        "occurrenceTime": "2019-09-11T14:25:19.355Z",
        "sourceName": "Office_Tag_0DF7_Button",
        "sourcePublicId": "Office_4"
    },
    {
        "status": "ACTIVE",
        "occurrenceTime": "2019-09-11T14:22:49.353Z",
        "sourceName": "Office_Tag_0DF7_Button",
        "sourcePublicId": "Office_4"
    }
]

JSON Response Values

Using ra as the All Geo-Fence Alarms - Identity List response array in the example above, the relevant values are described below.

Returns a detail list of geo-fence alarms that match a specified asset type.

HTTP Header Fields

GET /v2/rtls/public/alarms/geofences/assets/detail?assetTypeId=<ASSET-TYPE-ID> HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/alarms/geofences/assets/detail?assetTypeId=<ASSET-TYPE-ID>

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/alarms/geofences/assets/detail?assetTypeId=11c9f4e4-6852-11e9-a923-1681be663d3e

JSON Body Example

[
    {
        "updatedTime": "2019-09-11T09:57:27.496097-04:00",
        "createdTime": "2019-09-10T23:54:26.856791-04:00",
        "description": "Tag 2646D9 entered in NewGeo!",
        "status": "ACKNOWLEDGED",
        "occurrenceTime": "2019-09-11T03:54:26.852Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    },
    {
        "updatedTime": "2019-09-11T09:57:27.484397-04:00",
        "createdTime": "2019-09-10T23:53:56.864702-04:00",
        "description": "Tag 2646D9 entered in NewGeo!",
        "status": "ACKNOWLEDGED",
        "occurrenceTime": "2019-09-11T03:53:56.858Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    },
    {
        "updatedTime": "2019-09-11T09:57:27.473062-04:00",
        "createdTime": "2019-09-10T23:53:19.367149-04:00",
        "description": "Tag 2646D9 entered in NewGeo!",
        "status": "ACKNOWLEDGED",
        "occurrenceTime": "2019-09-11T03:53:19.363Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    }
]

JSON Response Values

Using ra as the Geo-Fence Alarms by Asset Type - Detail List response array in the example above, the relevant values are described below.

Returns a display list of geo-fence alarms that match a specified asset type.

HTTP Header Fields

GET /v2/rtls/public/alarms/geofences/assets/display?assetTypeId=<ASSET-TYPE-ID> HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/alarms/geofences/assets/display?assetTypeId=<ASSET-TYPE-ID>

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/alarms/geofences/assets/display?assetTypeId=11c9f4e4-6852-11e9-a923-1681be663d3e

JSON Body Example

[
    {
        "updatedTime": "2019-09-11T09:57:27.496097-04:00",
        "description": "Tag 2646D9 entered in NewGeo!",
        "status": "ACKNOWLEDGED",
        "occurrenceTime": "2019-09-11T03:54:26.852Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    },
    {
        "updatedTime": "2019-09-11T09:57:27.484397-04:00",
        "description": "Tag 2646D9 entered in NewGeo!",
        "status": "ACKNOWLEDGED",
        "occurrenceTime": "2019-09-11T03:53:56.858Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    },
    {
        "updatedTime": "2019-09-11T09:57:27.473062-04:00",
        "description": "Tag 2646D9 entered in NewGeo!",
        "status": "ACKNOWLEDGED",
        "occurrenceTime": "2019-09-11T03:53:19.363Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    }
]

JSON Response Values

Using ra as the Geo-Fence Alarms by Asset Type - Detail List response array in the example above, the relevant values are described below.

Returns an identity list of geo-fence alarms that match a specified asset type.

HTTP Header Fields

GET /v2/rtls/public/alarms/geofences/assets/identity?assetTypeId=<ASSET-TYPE-ID> HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/alarms/geofences/assets/identity?assetTypeId=<ASSET-TYPE-ID>

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/alarms/geofences/assets/identity?assetTypeId=11c9f4e4-6852-11e9-a923-1681be663d3e

JSON Body Example

[
    {
        "status": "ACKNOWLEDGED",
        "occurrenceTime": "2019-09-11T03:54:26.852Z",
        "sourceName": "Office_Tag_46D9_Battery",
        "sourcePublicId": "Office_1"
    },
    {
        "status": "ACKNOWLEDGED",
        "occurrenceTime": "2019-09-11T03:53:56.858Z",
        "sourceName": "Office_Tag_46D9_Battery",
        "sourcePublicId": "Office_1"
    },
    {
        "status": "ACKNOWLEDGED",
        "occurrenceTime": "2019-09-11T03:53:19.363Z",
        "sourceName": "Office_Tag_46D9_Battery",
        "sourcePublicId": "Office_1"
    }
]

JSON Response Values

Using ra as the Geo-Fence Alarms by Asset Type - Detail List response array in the example above, the relevant values are described below.

Returns a detail list of geo-fence alarms that match a specified department.

HTTP Header Fields

GET /v2/rtls/public/alarms/geofences/assets/detail?departmentId=<DEPT-TYPE-ID> HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/alarms/geofences/assets/detail?departmentId=<DEPT-TYPE-ID>

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/alarms/geofences/assets/detail?departmentId=7f749bad-e65c-4150-ae5f-f49eecfe3878

JSON Body Example

[
    {
        "updatedTime": "2019-09-11T10:27:34.357919-04:00",
        "createdTime": "2019-09-11T10:27:34.357629-04:00",
        "description": "Tag A1549B entered in NewGeo!",
        "status": "ACTIVE",
        "occurrenceTime": "2019-09-11T14:27:34.354Z",
        "sourceType": "Defibrillators",
        "sourceName": "Office_Tag_0DF7_Button",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_4"
    },
    {
        "updatedTime": "2019-09-11T10:25:19.358383-04:00",
        "createdTime": "2019-09-11T10:25:19.358188-04:00",
        "description": "Tag A1549B entered in NewGeo!",
        "status": "ACTIVE",
        "occurrenceTime": "2019-09-11T14:25:19.355Z",
        "sourceType": "Defibrillators",
        "sourceName": "Office_Tag_0DF7_Button",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_4"
    },
    {
        "updatedTime": "2019-09-11T10:22:49.357392-04:00",
        "createdTime": "2019-09-11T10:22:49.35705-04:00",
        "description": "Tag A1549B entered in NewGeo!",
        "status": "ACTIVE",
        "occurrenceTime": "2019-09-11T14:22:49.353Z",
        "sourceType": "Defibrillators",
        "sourceName": "Office_Tag_0DF7_Button",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_4"
    }
]

JSON Response Values

Using ra as the Geo-Fence Alarms by Department Type - Detail List response array in the example above, the relevant values are described below.

Returns a detail list of geo-fence alarms that match a specified department.

HTTP Header Fields

GET /v2/rtls/public/alarms/geofences/assets/display?departmentId=<DEPT-TYPE-ID> HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/alarms/geofences/assets/display?departmentId=<DEPT-TYPE-ID>

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/alarms/geofences/assets/display?departmentId=7f749bad-e65c-4150-ae5f-f49eecfe3878

JSON Body Example

[
    {
        "updatedTime": "2019-09-11T10:27:34.357919-04:00",
        "description": "Tag A1549B entered in NewGeo!",
        "status": "ACTIVE",
        "occurrenceTime": "2019-09-11T14:27:34.354Z",
        "sourceType": "Defibrillators",
        "sourceName": "Office_Tag_0DF7_Button",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_4"
    },
    {
        "updatedTime": "2019-09-11T10:25:19.358383-04:00",
        "description": "Tag A1549B entered in NewGeo!",
        "status": "ACTIVE",
        "occurrenceTime": "2019-09-11T14:25:19.355Z",
        "sourceType": "Defibrillators",
        "sourceName": "Office_Tag_0DF7_Button",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_4"
    },
    {
        "updatedTime": "2019-09-11T10:22:49.357392-04:00",
        "description": "Tag A1549B entered in NewGeo!",
        "status": "ACTIVE",
        "occurrenceTime": "2019-09-11T14:22:49.353Z",
        "sourceType": "Defibrillators",
        "sourceName": "Office_Tag_0DF7_Button",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_4"
    }
]

JSON Response Values

Using ra as the Geo-Fence Alarms by Department Type - Display List response array in the example above, the relevant values are described below.

Returns an identity list of geo-fence alarms that match a specified department.

HTTP Header Fields

GET /v2/rtls/public/alarms/geofences/assets/identity?departmentId=<DEPT-TYPE-ID> HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/alarms/geofences/assets/identity?departmentId=<DEPT-TYPE-ID>

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/alarms/geofences/assets/identity?departmentId=7f749bad-e65c-4150-ae5f-f49eecfe3878

JSON Body Example

[
    {
        "status": "ACTIVE",
        "occurrenceTime": "2019-09-11T14:27:34.354Z",
        "sourceName": "Office_Tag_0DF7_Button",
        "sourcePublicId": "Office_4"
    },
    {
        "status": "ACTIVE",
        "occurrenceTime": "2019-09-11T14:25:19.355Z",
        "sourceName": "Office_Tag_0DF7_Button",
        "sourcePublicId": "Office_4"
    },
    {
        "status": "ACTIVE",
        "occurrenceTime": "2019-09-11T14:22:49.353Z",
        "sourceName": "Office_Tag_0DF7_Button",
        "sourcePublicId": "Office_4"
    }
]

JSON Response Values

Using ra as the Geo-Fence Alarms by Department Type - Identity List response array in the example above, the relevant values are described below.

HTTP Header Fields

GET /v2/rtls/public/alarms/geofences/assets/<ASSET-ID>/detail HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/alarms/geofences/assets/<ASSET-ID>/detail

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/alarms/geofences/assets/Office_1/detail

JSON Body Example

[
    {
        "updatedTime": "2019-09-11T09:57:27.496097-04:00",
        "createdTime": "2019-09-10T23:54:26.856791-04:00",
        "description": "Tag 2646D9 entered in NewGeo!",
        "status": "ACKNOWLEDGED",
        "occurrenceTime": "2019-09-11T03:54:26.852Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    },
    {
        "updatedTime": "2019-09-11T09:57:27.484397-04:00",
        "createdTime": "2019-09-10T23:53:56.864702-04:00",
        "description": "Tag 2646D9 entered in NewGeo!",
        "status": "ACKNOWLEDGED",
        "occurrenceTime": "2019-09-11T03:53:56.858Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    }
]

JSON Response Values

Using ra as the Geo-Fence Alarms for a Single Asset - Detail List response array in the example above, the relevant values are described below.

HTTP Header Fields

GET /v2/rtls/public/alarms/geofences/assets/<ASSET-ID>/display HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/alarms/geofences/assets/<ASSET-ID>/display

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/alarms/geofences/assets/Office_1/display

JSON Body Example

[
    {
        "updatedTime": "2019-09-11T09:57:27.496097-04:00",
        "description": "Tag 2646D9 entered in NewGeo!",
        "status": "ACKNOWLEDGED",
        "occurrenceTime": "2019-09-11T03:54:26.852Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    },
    {
        "updatedTime": "2019-09-11T09:57:27.484397-04:00",
        "description": "Tag 2646D9 entered in NewGeo!",
        "status": "ACKNOWLEDGED",
        "occurrenceTime": "2019-09-11T03:53:56.858Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    }
]

JSON Response Values

Using ra as the Geo-Fence Alarms for a Single Asset - Display List response array in the example above, the relevant values are described below.

HTTP Header Fields

GET /v2/rtls/public/alarms/geofences/assets/<ASSET-ID>/identity HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/alarms/geofences/assets/<ASSET-ID>/identity

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/alarms/geofences/assets/Office_1/identity

JSON Body Example

[
    {
        "status": "ACKNOWLEDGED",
        "occurrenceTime": "2019-09-11T03:54:26.852Z",
        "sourceName": "Office_Tag_46D9_Battery",
        "sourcePublicId": "Office_1"
    },
    {
        "status": "ACKNOWLEDGED",
        "occurrenceTime": "2019-09-11T03:53:56.858Z",
        "sourceName": "Office_Tag_46D9_Battery",
        "sourcePublicId": "Office_1"
    },
    {
        "status": "ACKNOWLEDGED",
        "occurrenceTime": "2019-09-11T03:53:19.363Z",
        "sourceName": "Office_Tag_46D9_Battery",
        "sourcePublicId": "Office_1"
    }
]

JSON Response Values

Using ra as the Geo-Fence Alarms for a Single Asset - Identity List response array in the example above, the relevant values are described below.

Returns a detail list of all geo-fence events for all assets.

HTTP Header Fields

GET /v2/rtls/public/events/geofences/assets/detail HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/events/geofences/assets/detail

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/events/geofences/assets/detail

JSON Body Example

[
    {
        "updatedTime": "2019-09-16T08:07:50.416274-04:00",
        "createdTime": "2019-09-16T08:07:50.416149-04:00",
        "description": "Tag 2646D9 exited from GeoAlarmOnly!",
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:07:50.413Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    },
    {
        "updatedTime": "2019-09-16T08:07:50.404172-04:00",
        "createdTime": "2019-09-16T08:07:50.403982-04:00",
        "description": "Tag 2646D6 entered in GeoAlarmOnly!",
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:07:50.400Z",
        "sourceType": "Babies",
        "sourceName": "Office_Tag_46D6_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_2"
    },
    {
        "updatedTime": "2019-09-16T08:07:42.981857-04:00",
        "createdTime": "2019-09-16T08:07:42.981706-04:00",
        "description": "Tag 2646D6 exited from GeoAlarmOnly!",
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:07:42.975Z",
        "sourceType": "Babies",
        "sourceName": "Office_Tag_46D6_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_2"
    }
]

JSON Response Values

Using ra as the Geo-Fence Events for All Assets - Detail List response array in the example above, the relevant values are described below.

Returns a display list of all geo-fence events for all assets.

HTTP Header Fields

GET /v2/rtls/public/events/geofences/assets/display HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/events/geofences/assets/display

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/events/geofences/assets/display

JSON Body Example

[
    {
        "updatedTime": "2019-09-16T08:07:50.416274-04:00",
        "description": "Tag 2646D9 exited from GeoAlarmOnly!",
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:07:50.413Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    },
    {
        "updatedTime": "2019-09-16T08:07:50.404172-04:00",
        "description": "Tag 2646D6 entered in GeoAlarmOnly!",
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:07:50.400Z",
        "sourceType": "Babies",
        "sourceName": "Office_Tag_46D6_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_2"
    },
    {
        "updatedTime": "2019-09-16T08:07:42.981857-04:00",
        "description": "Tag 2646D6 exited from GeoAlarmOnly!",
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:07:42.975Z",
        "sourceType": "Babies",
        "sourceName": "Office_Tag_46D6_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_2"
    }
]

JSON Response Values

Using ra as the Geo-Fence Events for All Assets - Display List response array in the example above, the relevant values are described below.

Returns an identity list of all geo-fence events for all assets.

HTTP Header Fields

GET /v2/rtls/public/events/geofences/assets/identity HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/events/geofences/assets/identity

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/events/geofences/assets/identity

JSON Body Example

[
    {
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:07:50.413Z",
        "sourceName": "Office_Tag_46D9_Battery",
        "sourcePublicId": "Office_1"
    },
    {
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:07:50.400Z",
        "sourceName": "Office_Tag_46D6_Battery",
        "sourcePublicId": "Office_2"
    },
    {
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:07:42.975Z",
        "sourceName": "Office_Tag_46D6_Battery",
        "sourcePublicId": "Office_2"
    }
]

JSON Response Values

Using ra as the Geo-Fence Events for All Assets - Identity List response array in the example above, the relevant values are described below.

Returns a detail list of all geo-fence events for a single asset.

HTTP Header Fields

GET /v2/rtls/public/events/geofences/assets/<ASSET-ID>/detail HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/events/geofences/assets/<ASSET-ID>/detail

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/events/geofences/assets/Office_1/detail

JSON Body Example

[
    {
        "updatedTime": "2019-09-16T08:07:50.416274-04:00",
        "createdTime": "2019-09-16T08:07:50.416149-04:00",
        "description": "Tag 2646D9 exited from GeoAlarmOnly!",
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:07:50.413Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    },
    {
        "updatedTime": "2019-09-16T08:06:50.426483-04:00",
        "createdTime": "2019-09-16T08:06:50.426291-04:00",
        "description": "Tag 2646D9 entered in GeoAlarmOnly!",
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:06:50.421Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    },
    {
        "updatedTime": "2019-09-16T08:06:42.916809-04:00",
        "createdTime": "2019-09-16T08:06:42.916647-04:00",
        "description": "Tag 2646D9 exited from GeoAlarmOnly!",
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:06:42.914Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    }
]

JSON Response Values

Using ra as the Geo-Fence Events for a Single Asset - Detail List response array in the example above, the relevant values are described below.

Returns a display list of all geo-fence events for a single asset.

HTTP Header Fields

GET /v2/rtls/public/events/geofences/assets/<ASSET-ID>/display HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/events/geofences/assets/<ASSET-ID>/display

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/events/geofences/assets/Office_1/display

JSON Body Example

[
    {
        "updatedTime": "2019-09-16T08:07:50.416274-04:00",
        "description": "Tag 2646D9 exited from GeoAlarmOnly!",
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:07:50.413Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    },
    {
        "updatedTime": "2019-09-16T08:06:50.426483-04:00",
        "description": "Tag 2646D9 entered in GeoAlarmOnly!",
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:06:50.421Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    },
    {
        "updatedTime": "2019-09-16T08:06:42.916809-04:00",
        "description": "Tag 2646D9 exited from GeoAlarmOnly!",
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:06:42.914Z",
        "sourceType": "Aerosol Tents",
        "sourceName": "Office_Tag_46D9_Battery",
        "errorCode": "RTLS.RULE.I.2001",
        "sourcePublicId": "Office_1"
    }
]

JSON Response Values

Using ra as the Geo-Fence Events for a Single Asset - Display List response array in the example above, the relevant values are described below.

Returns an identity list of all geo-fence events for a single asset.

HTTP Header Fields

GET /v2/rtls/public/events/geofences/assets/<ASSET-ID>/identity HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/events/geofences/assets/<ASSET-ID>/identity

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/events/geofences/assets/Office_1/identity

JSON Body Example

[
    {
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:07:50.413Z",
        "sourceName": "Office_Tag_46D9_Battery",
        "sourcePublicId": "Office_1"
    },
    {
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:07:50.400Z",
        "sourceName": "Office_Tag_46D6_Battery",
        "sourcePublicId": "Office_2"
    },
    {
        "errorEventType": "I",
        "occurrenceTime": "2019-09-16T12:07:42.975Z",
        "sourceName": "Office_Tag_46D6_Battery",
        "sourcePublicId": "Office_2"
    }
]

JSON Response Values

Using ra as the Geo-Fence Events for a Single Asset - Identity List response array in the example above, the relevant values are described below.

Returns a detail list of real-time location for all configured assets.

HTTP Header Fields

GET /v2/rtls/public/assets/lastlocation/all/detail HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/lastlocation/all/detail

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/lastlocation/all/detail

JSON Body Example

[
    {
        "macAddress": "A10DF7",
        "x": 433.45,
        "y": 723.27,
        "z": 0.0,
        "inventoryId": "Office_4",
        "publicEndpointId": "E110",
        "publicFloorId": "F12",
        "processedAt": "2019-09-09T13:34:18.993-0400"
    },
    {
        "macAddress": "2646D9",
        "x": 341.23,
        "y": 713.37,
        "z": 0.0,
        "inventoryId": "Office_1",
        "publicEndpointId": "E98",
        "publicFloorId": "F12",
        "processedAt": "2019-09-16T09:30:57.914-0400"
    },
    {
        "macAddress": "A10E75",
        "x": 644.06,
        "y": 553.87,
        "z": 0.0,
        "inventoryId": "Office_4",
        "publicEndpointId": "E182",
        "publicFloorId": "F12",
        "processedAt": "2019-09-09T17:39:36.274-0400"
    }
]

JSON Response Values

Using ra as the Realtime Location for All Assets – Detail List response array in the example above, the relevant values are described below.

Returns a display list of real-time location for all configured assets.

HTTP Header Fields

GET /v2/rtls/public/assets/lastlocation/all/display HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/lastlocation/all/display

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/lastlocation/all/display

JSON Body Example

[
    {
        "macAddress": "A10DF7",
        "x": 433.45,
        "y": 723.27,
        "z": 0.0,
        "inventoryId": "Office_4",
        "publicEndpointId": "E110",
        "publicFloorId": "F12",
        "processedAt": "2019-09-09T13:34:18.993-0400"
    },
    {
        "macAddress": "2646D9",
        "x": 432.43,
        "y": 441.12,
        "z": 0.0,
        "inventoryId": "Office_1",
        "publicEndpointId": "E477",
        "publicFloorId": "F13",
        "processedAt": "2019-09-16T10:08:42.900-0400"
    },
    {
        "macAddress": "A10E75",
        "x": 644.06,
        "y": 553.87,
        "z": 0.0,
        "inventoryId": "Office_4",
        "publicEndpointId": "E182",
        "publicFloorId": "F12",
        "processedAt": "2019-09-09T17:39:36.274-0400"
    }
]

JSON Response Values

Using ra as the Realtime Location for All Assets – Display List response array in the example above, the relevant values are described below.

Returns an identity list of real-time location for all configured assets.

HTTP Header Fields

GET /v2/rtls/public/assets/lastlocation/all/identity HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/lastlocation/all/identity

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/lastlocation/all/identity

JSON Body Example

[
    {
        "macAddress": "A10DF7",
        "x": 433.45,
        "y": 723.27,
        "z": 0.0,
        "inventoryId": "Office_4",
        "publicEndpointId": "E110",
        "publicFloorId": "F12",
        "processedAt": "2019-09-09T13:34:18.993-0400"
    },
    {
        "macAddress": "2646D9",
        "x": 424.8256,
        "y": 458.21674,
        "z": 0.0,
        "inventoryId": "Office_1",
        "publicEndpointId": "E477",
        "publicFloorId": "F13",
        "processedAt": "2019-09-16T10:12:20.407-0400"
    },
    {
        "macAddress": "A10E75",
        "x": 644.06,
        "y": 553.87,
        "z": 0.0,
        "inventoryId": "Office_4",
        "publicEndpointId": "E182",
        "publicFloorId": "F12",
        "processedAt": "2019-09-09T17:39:36.274-0400"
    }
]

JSON Response Values

Using ra as the Realtime Location for All Assets – Identity List response array in the example above, the relevant values are described below.

Returns a detail view of the real-time location for a specified asset.

HTTP Header Fields

GET /v2/rtls/public/assets/<ASSET-ID>/lastlocation/detail HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/<ASSET-ID>/lastlocation/detail

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/Office_2/lastlocation/detail

JSON Body Example

{
    "macAddress": "2646D6",
    "x": 352.67,
    "y": 462.86,
    "z": 0.0,
    "inventoryId": "Office_2",
    "publicEndpointId": "E481",
    "publicFloorId": "F13",
    "processedAt": "2019-09-16T10:14:42.901-0400"
}

JSON Response Values

Using ro as the Realtime Location for a Single Asset – Detail View response object in the example above, the relevant values are described below.

Returns a display view of the real-time location for a specified asset.

HTTP Header Fields

GET /v2/rtls/public/assets/<ASSET-ID>/lastlocation/display HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/<ASSET-ID>/lastlocation/display

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/Office_2/lastlocation/display

JSON Body Example

{
    "macAddress": "2646D6",
    "x": 409.61,
    "y": 457.26,
    "z": 0.0,
    "inventoryId": "Office_2",
    "publicEndpointId": "E477",
    "publicFloorId": "F13",
    "processedAt": "2019-09-16T10:24:57.908-0400"
}

JSON Response Values

Using ro as the Realtime Location for a Single Asset – Display View response object in the example above, the relevant values are described below.

Returns an identity view of the real-time location for a specified asset.

HTTP Header Fields

GET /v2/rtls/public/assets/<ASSET-ID>/lastlocation/identity HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/<ASSET-ID>/lastlocation/identity

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/Office_2/lastlocation/identity

JSON Body Example

{
    "macAddress": "2646D6",
    "x": 424.8256,
    "y": 458.21674,
    "z": 0.0,
    "inventoryId": "Office_2",
    "publicEndpointId": "E477",
    "publicFloorId": "F13",
    "processedAt": "2019-09-16T10:28:12.883-0400"
}

JSON Response Values

Using ro as the Realtime Location for a Single Asset – Identity View response object in the example above, the relevant values are described below.

Returns a detail list of asset locations that match a specified asset type.

HTTP Header Fields

GET /v2/rtls/public/assets/lastlocation/all/detail?assetTypeId=<ASSET-TYPE-ID> HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/lastlocation/all/detail?assetTypeId=<ASSET-TYPE-ID>

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/lastlocation/all/detail?assetTypeId=f254ae04-6853-11e9-a923-1681be663d3e

JSON Body Example

[
    {
        "macAddress": "A14C13",
        "x": 317.36,
        "y": 441.65,
        "z": 0.0,
        "inventoryId": "Office_6",
        "publicEndpointId": "E481",
        "publicFloorId": "F13",
        "processedAt": "2019-09-16T10:34:20.397-0400"
    },
    {
        "macAddress": "2646D6",
        "x": 406.36,
        "y": 455.28,
        "z": 0.0,
        "inventoryId": "Office_2",
        "publicEndpointId": "E477",
        "publicFloorId": "F13",
        "processedAt": "2019-09-16T10:34:20.390-0400"
    }
]

JSON Response Values

Using ra as the Asset Locations by Type - Detail List response array in the example above, the relevant values are described below.

Returns a display list of asset locations that match a specified asset type.

HTTP Header Fields

GET /v2/rtls/public/assets/lastlocation/all/display?assetTypeId=<ASSET-TYPE-ID> HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/lastlocation/all/display?assetTypeId=<ASSET-TYPE-ID>

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/lastlocation/all/display?assetTypeId=f254ae04-6853-11e9-a923-1681be663d3e

JSON Body Example

[
    {
        "macAddress": "A14C13",
        "x": 331.1,
        "y": 350.52,
        "z": 0.0,
        "inventoryId": "Office_6",
        "publicEndpointId": "E449",
        "publicFloorId": "F13",
        "processedAt": "2019-09-16T10:43:35.402-0400"
    },
    {
        "macAddress": "2646D6",
        "x": 309.94,
        "y": 681.51,
        "z": 0.0,
        "inventoryId": "Office_2",
        "publicEndpointId": "E92",
        "publicFloorId": "F12",
        "processedAt": "2019-09-16T10:43:35.401-0400"
    }
]

JSON Response Values

Using ra as the Asset Locations by Type - Display List response array in the example above, the relevant values are described below.

Returns an identity list of asset locations that match a specified asset type.

HTTP Header Fields

GET /v2/rtls/public/assets/lastlocation/all/identity?assetTypeId=<ASSET-TYPE-ID> HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/lastlocation/all/identity?assetTypeId=<ASSET-TYPE-ID>

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/lastlocation/all/identity?assetTypeId=f254ae04-6853-11e9-a923-1681be663d3e

JSON Body Example

[
    {
        "macAddress": "A14C13",
        "x": 411.55,
        "y": 714.28,
        "z": 0.0,
        "inventoryId": "Office_6",
        "publicEndpointId": "E110",
        "publicFloorId": "F12",
        "processedAt": "2019-09-16T10:45:57.907-0400"
    },
    {
        "macAddress": "2646D6",
        "x": 325.49,
        "y": 672.94,
        "z": 0.0,
        "inventoryId": "Office_2",
        "publicEndposintId": "E92",
        "publicFloorId": "F12",
        "processedAt": "2019-09-16T10:45:57.903-0400"
    }
]

JSON Response Values

Using ra as the Asset Locations by Type - Identity List response array in the example above, the relevant values are described below.

Returns a detail list of asset locations that match a specified department type.

HTTP Header Fields

GET /v2/rtls/public/assets/lastlocation/all/detail?departmentId=<DEPT-TYPE-ID> HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/lastlocation/all/detail?departmentId=<DEPT-TYPE-ID>

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/lastlocation/all/detail?departmentId=73d5997d-1e70-46f6-9367-4ecba984a35a

JSON Body Example

[
    {
        "macAddress": "A14C13",
        "x": 317.36,
        "y": 441.65,
        "z": 0.0,
        "inventoryId": "Office_6",
        "publicEndpointId": "E481",
        "publicFloorId": "F13",
        "processedAt": "2019-09-16T10:34:20.397-0400"
    },
    {
        "macAddress": "2646D6",
        "x": 406.36,
        "y": 455.28,
        "z": 0.0,
        "inventoryId": "Office_2",
        "publicEndpointId": "E477",
        "publicFloorId": "F13",
        "processedAt": "2019-09-16T10:34:20.390-0400"
    }
]

JSON Response Values

Using ra as the Asset Locations by Department - Detail List response array in the example above, the relevant values are described below.

Returns a display list of asset locations that match a specified department type.

HTTP Header Fields

GET /v2/rtls/public/assets/lastlocation/all/display?departmentId=<DEPT-TYPE-ID> HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/lastlocation/all/display?departmentId=<DEPT-TYPE-ID>

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/lastlocation/all/display?departmentId=73d5997d-1e70-46f6-9367-4ecba984a35a

JSON Body Example

[
    {
        "macAddress": "A14C13",
        "x": 331.1,
        "y": 350.52,
        "z": 0.0,
        "inventoryId": "Office_6",
        "publicEndpointId": "E449",
        "publicFloorId": "F13",
        "processedAt": "2019-09-16T10:43:35.402-0400"
    },
    {
        "macAddress": "2646D6",
        "x": 309.94,
        "y": 681.51,
        "z": 0.0,
        "inventoryId": "Office_2",
        "publicEndpointId": "E92",
        "publicFloorId": "F12",
        "processedAt": "2019-09-16T10:43:35.401-0400"
    }
]

JSON Response Values

Using ra as the Asset Locations by Department - Display List response array in the example above, the relevant values are described below.

Returns an identity list of asset locations that match a specified department.

HTTP Header Fields

GET /v2/rtls/public/assets/lastlocation/all/identity?departmentId=<DEPT-TYPE-ID> HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/lastlocation/all/identity?departmentId=<DEPT-TYPE-ID>

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/lastlocation/all/identity?departmentId=73d5997d-1e70-46f6-9367-4ecba984a35a

JSON Body Example

[
    {
        "macAddress": "A10DF7",
        "x": 633.69,
        "y": 550.52,
        "z": 0.0,
        "inventoryId": "East_Wing",
        "publicEndpointId": "E182",
        "publicFloorId": "F12",
        "processedAt": "2019-09-09T14:46:18.988-0400"
    },
    {
        "macAddress": "A1549B",
        "x": 563.44,
        "y": 522.91,
        "z": 0.0,
        "inventoryId": "gfg",
        "publicEndpointId": "E116",
        "publicFloorId": "F12",
        "processedAt": "2019-09-09T13:38:41.479-0400"
    }
]

JSON Response Values

Using ra as the Asset Locations by Department - Identity List response array in the example above, the relevant values are described below.

Returns a detail list of location history for a specified asset.

HTTP Header Fields

GET /v2/rtls/public/assets/location/history/<ASSET-ID>/detail HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/location/history/<ASSET-ID>/detail

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/location/history/Office_2/detail

JSON Body Example

[
    {
        "macAddress": "2646D6",
        "x": 569.2315,
        "y": 658.0092,
        "z": 0.0,
        "inventoryId": "Office_2",
        "publicEndpointId": "E80",
        "publicFloorId": "F12",
        "processedAt": "2019-09-16T11:29:40.117-0400"
    },
    {
        "macAddress": "2646D6",
        "x": 569.2315,
        "y": 658.0092,
        "z": 0.0,
        "inventoryId": "Office_2",
        "publicEndpointId": "E80",
        "publicFloorId": "F12",
        "processedAt": "2019-09-16T11:29:32.613-0400"
    },
    {
        "macAddress": "2646D6",
        "x": 569.2315,
        "y": 658.0092,
        "z": 0.0,
        "inventoryId": "Office_2",
        "publicEndpointId": "E80",
        "publicFloorId": "F12",
        "processedAt": "2019-09-16T11:29:25.114-0400"
    }
]

JSON Response Values

Using ra as the Realtime Location for All Assets – Detail List response array in the example above, the relevant values are described below.

Returns a display list of location history for a specified asset.

HTTP Header Fields

GET /v2/rtls/public/assets/location/history/<ASSET-ID>/display HTTP/1.1
Host: <HOST-IP>:<HOST-PORT>
Authorization: <TOKEN-TYPE> <ACCESS-TOKEN>
Content-Type: application/json
Cache-Control: no-cache

GET Request Structure

https://<HOST-IP>:<HOST-PORT>/v2/rtls/public/assets/location/history/<ASSET-ID>/display

Where:

GET Request Example

https://192.168.2.100/v2/rtls/public/assets/location/history/Office_1/display

JSON Body Example

[
    {
        "macAddress": "2646D9",
        "x": 569.2315,
        "y": 658.0092,
        "z": 0.0,
        "inventoryId": "Office_1",
        "publicEndpointId": "E80",
        "publicFloorId": "F12",
        "processedAt": "2019-09-16T11:28:17.628-0400"
    },
    {
        "macAddress": "2646D9",
        "x": 569.2315,
        "y": 658.0092,
        "z": 0.0,
        "inventoryId": "Office_1",
        "publicEndpointId": "E80",
        "publicFloorId": "F12",
        "processedAt": "2019-09-16T11:26:55.124-0400"
    },
    {
        "macAddress": "2646D9",
        "x": 569.2315,
        "y": 658.0092,
        "z": 0.0,
        "inventoryId": "Office_1",
        "publicEndpointId": "E80",
        "publicFloorId": "F12",
        "processedAt": "2019-09-16T11:21:47.622-0400"
    }
]

JSON Response Values