Back to top

OMT RTLS location API

OMT RTLS location API can be used to access assets (tags, anchors, zones) position in the system.

Tags

Tag

Retrieve a Tag
GET/tags/{tagId}

Retrieves the tag with the given Id

Example URI

GET /tags/tagId
URI Parameters
HideShow
tagId
number (required) 

the Id of the desired tag

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "tagId": 82,
  "pos": [
    1,
    5.5,
    1
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "tagId": {
      "type": "number",
      "description": "the Id of the tag"
    },
    "pos": {
      "type": "array",
      "description": "x,y,z position of the tag"
    }
  }
}

List All Tags
GET/tags

Example URI

GET /tags
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "tagId": 82,
    "pos": [
      1,
      5.5,
      1
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Update Stream of All Tags
GET/tags/update

A websocket containing updates in json-patch format for all tags. Below example is a position update for tag number 82.

Example URI

GET /tags/update
Request
HideShow
Headers
Upgrade: websocket
Connection: Upgrade
Response  101
HideShow
Body
{
  "op": "replace",
  "path": "/tags/82/pos",
  "value": [
    12.2,
    5.3,
    2.1
  ]
}

Zones

Zones are areas, where OMT RTLS is installed and 4-8 Wall Units are syncronized in order to be able to locate tags in the area.

Zone

Retrieve a Zone
GET/zones/{zoneId}

Retrieves the zone with the given Id

Example URI

GET /zones/zoneId
URI Parameters
HideShow
zoneId
number (required) 

the Id of the desired zone

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "zoneId": 1,
  "baseAnchorId": 2563,
  "tOffBufferLength": 20,
  "upperBounds": [
    1,
    10,
    1
  ],
  "lowerBounds": [
    1,
    0,
    1
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "zoneId": {
      "type": "number",
      "description": "the Id of the zone"
    },
    "baseAnchorId": {
      "type": "number",
      "description": "the Id of anchor that is used for the calibration base. This shoud be the most closest LOS anchor to the calibSources"
    },
    "tOffBufferLength": {
      "type": "number"
    },
    "upperBounds": {
      "type": "array",
      "description": "x,y,z position of the 1st corner of the zone's rectangle"
    },
    "lowerBounds": {
      "type": "array",
      "description": "x,y,z position of the 3rd corner of the zone's rectangle"
    }
  }
}

List All Zones
GET/zones

Example URI

GET /zones
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "zoneId": 1,
    "baseAnchorId": 2563,
    "tOffBufferLength": 20,
    "upperBounds": [
      1,
      10,
      1
    ],
    "lowerBounds": [
      1,
      0,
      1
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Anchors

Anchors are OMT RTLS Wall Units installed at fixed location.

Anchor

Retrieve an Anchor
GET/zones/{zoneId}/anchors/{anchorId}

Retrieves the zone with the given Id

Example URI

GET /zones/zoneId/anchors/anchorId
URI Parameters
HideShow
zoneId
number (required) 

the Id of the zone where the anchor is located

anchorId
number (required) 

the Id of the desired anchor

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "anchorId": 2563,
  "calibSources": [
    1,
    1
  ],
  "pos": [
    1,
    5.5,
    1
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "anchorId": {
      "type": "number",
      "description": "the Id of the anchor"
    },
    "calibSources": {
      "type": "array",
      "description": "the anchorId list of the anchors that are transmitting sync packets and we use for calibration"
    },
    "pos": {
      "type": "array",
      "description": "x,y,z position of the anchor"
    }
  }
}

List All Anchors for a Zone
GET/zones/{zoneId}/anchors

Example URI

GET /zones/zoneId/anchors
URI Parameters
HideShow
zoneId
number (required) 

the Id of the zone to query

Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "anchorId": 2563,
    "calibSources": [
      1,
      1
    ],
    "pos": [
      1,
      5.5,
      1
    ]
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Generated by aglio on 11 May 2017