Location Beacon API Reference Follow

REST Resources

You can use the Locations endpoint to get all of the Beacons for a specific location ID.

/api/locations/{location_id}/beacons

You can get information on a specific Beacon using its MAC.

/api/locations/{location_id}/beacons/{MAC}

Changes made to a Beacon’s state in the Meridian Editor’s Beacons Management tool are sent as changesets to observers that are capable of modifying those Beacons, such as Aruba APs and IAPs. Changes are limited to Beacon type (Proximity or Location) and Proximity Beacon power level.

/api/locations/{location_id}/beacons/{MAC}/changesets

Equality Filtering

The results of the Beacons API can be filtered by the following properties on exact values:

• map
• type
• last_observation.major

Inequality Filtering

The results of the Beacons API can be filtered by an inequality expression, such as less than (<), using the inequality URL query parameter. Filtered results are automatically sorted by the filtered property.

For example, to return a paginated list of beacons with battery levels less than 50% use this query parameter:

?inequality=last_observation.battery_level<50

Filtering is supported on the following fields:

• last_observation.battery_level
• last_observation.timestamp

The following inequalities are supported:

• >
• >=
• <
• <=

Beacon Field Reference

Here are descriptions of the fields returned by the Beacons API endpoint.