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

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}

Aruba Tags chirp once every second, but new locations are only updated every 8 seconds. This is subject to change.

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):

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. The tags field contains ids and label names.

Learn more about using Labels in the Asset Tag Label API article.

Check Tags Accuracy

In order to check the accuracy of an Aruba Tag, you can use control_x and control_y to note the spot on a map where a Tag actually is. You can then compare this to where Meridian has located the Tag.

control_x and control_y have no values until defined by the user.

Internal Tags URLs

You can subscribe to Aruba Tag events, or asset updates, by MAC, Tag label, or map ID. You can have multiple Tag subscriptions on one socket.

The following URLs permit you to get information on a Tag regardless of your account access. Do not share with customers.

Create a Tag

Use POST to create a new Tag.

The required values are name and mac. The external_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}