Skip to content

Fetch a Tag

Retrieves a Tag’s properties based on its Tag ID.

Request

GET /api/v1/enterprises/<enterprise_id>/tags/<tag_id>

Parameters

Request

Name Value Description
enterprise_id string The ID of the organization
tag_id string The ID or MAC address of the tag that is being queried. Scan the QR code on the tag to get the Tag_ID and the MAC address.

Response

Name Value Description
tag_id string The ID or MAC address of the tag that is being queried. Scan the QR code on the tag to get the Tag_ID and the MAC address.
tagID string The ID of the tag that is queried
tagMAC string MAC address of the tag
zone string Zone assigned to the tag
floor string Zone assigned to the tag
motion string true – The tag is moving
false – The tag is not moving
displayCoordinates string Coordinates of the marker to be displayed for the tag. The coordinates of the tag’s path are translated left and up by the anchor’s x and y points. Note that this does not indicate the actual position of the tag.
rawDataTimestamp string Timestamp of the most recent raw data included in the computation of this tag position
computationTimestamp string Timestamp at which this position was computed
batteryVoltage string Tag voltage
batteryVoltageTimestamp string Timestamp of the latest battery voltage update
buttonStatus string Tamper: When an Asset Tag is removed from an asset, the Tag’s Tamper button gets activated.
true – Tamper Button on the Asset Tag is activated
false – Tamper Button is not activated
Attention: Tag button events when the attention button is activated on the physical tag
true – Attention Button on the Asset Tag is activated
false – Attention Button is not activated
buttonTimeStamp String Timestamp of the most recent button message received from the tag

Sample Request

GET /api/v1/enterprises/211/tags/11

Sample Response

 {
     "tagId": "da375073-7e33-480d-8209-3467c6ccbc1b",
     "tagMac": "6864F5AD2C04",
     "zone": "Scrum_Area",
     "floor": "AAVmbG9vcgACdXMA7sxRX-kR6qQSr2ZiKK_pyL7WMV_pEeq0LVf43pYdWg",
     "motion": false,
      "displayCoordinates": {
           "x": 0.0,
           "y": 0.0
      },
      "rawDataTimestamp": "2022-11-15T07:38:25+00:00",
      "computationTimestamp": "2022-11-15T07:38:29.889260+00:00",
      "batteryVoltage": 2.823,
      "batteryVoltageTimestamp": "2022-11-15T07:42:15+00:00",
      "buttonStatus": {
           "tamper": true,
           "attention": false
      },
      "buttonTimestamp": "2022-11-15T07:38:54+00:00"
  }

Community

Connect and Collaborate with Industrial Professionals and Join the Community!

Click to load comments