beacon object

About beacon

Beacon object reflect your real beacon. It contains informations about name, description, location and configuration.

📘

Keep your beacons organised

It is a good practice to provide detailed information about beacon position and role. This will allow you in a future to create campaigns, share with others or support beacons on site

JSON representation

beacon

{
  "id":"object id", 
  // beacon id contains proximityId /no dashes/ major and minor 
  "bid":"000000000000000000000021474836475936412297", 
  // beacon technical location
	"latitude": 52.505581, 
	"longitude": 13.429550,
  "createdAt":1431949901000, // created date in millis
  "description":"beacon description", 
  "proximityId":"00000000-0000-0000-0000-002147483647", // proximity id
	"major":59364, // major
  "minor":12297, // minor
  "name":"beacon name", 
  "shared":false, // is beacon shared by someone with you
  "sharedWith":null, // information about share
  "tags":["tag1","tag2"], // a list of tags
  "updatedAt":1432212924000 // updated date in millis
}

beacon list item

{
  "id":"object id", 
  // beacon id contains proximityId /no dashes/ major and minor 
  "bid":"000000000000000000000021474836475936412297", 
  "createdAt":1431949901000, // created date in millis
  "updatedAt":1432212924000, // updated date in millis
  "name":"beacon name", 
  "latitude": 52.505581, 
	"longitude": 13.429550,
  "shared":false, // is beacon shared by someone with you
  "tags":["tag1","tag2"] // a list of tags
}

bid format

For beacon with:

  • proximityId: aa991a74-96af-4371-876b-4724b668a3dd
  • major: 12345
  • minor: 67890

bid will be represented by proximityId without dashes joined with major and minor:

  • aa991a7496af4371876b4724b668a3dd1234567890