Asset Tracking REST API Follow
This document describes the Meridian APIs related to Asset Tracking.
The Asset-beacons Endpoint
The asset-beacons endpoint can be used to get information about tags that have been deployed to a location or to upload an image to a Tag.
/api/locations/{location_id}/asset-beacons
This endpoint will return Aruba Tag information without current position.
Response
id |
String Internal system identifier |
modified |
Timestamp (ISO 8601) The timestamp when the Tag was last modified. |
created |
Timestamp (ISO 8601) The timestamp when the Tag was created. |
name |
String User-supplied name of the Tag |
external_id |
String User-supplied reference to external identifier |
mac |
String MAC address of the Tag |
location |
String Meridian Location identifier |
image_url |
String URL to an image uploaded by the user |
is_control_tag |
Boolean Whether or not this Tag is used as a control tag |
control_x and control_y |
Floats The fixed X and Y values of a Tag being used as a control tag. Defined by the user. Control tags are used to measure and improve the accuracy of other non-control tags. |
battery_level |
Float A number between 0.0 and 100.0 indicating how much battery life is remaining |
tags |
List of Strings List of Tag Label names |
tag_ids |
List of Integers List of Tag Label identifiers |
GET a single Tag
You can use the asset-beacons endpoint to get the location of a specific Tag.
Aruba Tags aren’t tracked in real-time. The API isn’t intended for this purpose.
/api/locations/{location ID}/asset-beacons/{MAC address}
Response
The response to a single Tag is the same as the response for all tags with these properties structured as a dictionary (each level represented with a greater than):
calculations > default > location > location_id |
String The Meridian Location identifier |
calculations > default > location > map_id |
String The Meridian Map/Floor identifier |
calculations > default > location > x and calculations > default > location > y |
Float The X and Y position of the Tag on the Map/Floor |
Upload Images
You can use the asset-beacons endpoint to upload, replace, or delete an image for a specific Aruba Tag.
/api/locations/{location ID}/asset-beacons/{MAC}/image
Use PUT to upload or replace an image. Use DELETE to remove an image. Use GET to grab a Tag’s image.
Labels
Aruba Tag labels are collected in the tag_ids
field.
The
tag_ids
field is an array of unique label identifiers. Thetags
field contains ids and label names.
Learn more about using Labels in the Asset Tag Label API article.
Check Tags Accuracy
Create a Tag
Use POST to create a new Tag.
The required values are
name
andmac
. Theexternal_id
value is optional.
External ID is used to relate a Tag to a non-Meridian resource, such as an inventory database.
/api/locations/{location ID}/asset-beacons
Delete a Tag
Use DELETE to remove a Tag from your location.
/api/locations/{location ID}/asset_beacons/{MAC}
Comments
0 comments
Please sign in to leave a comment.