Log In

Overview

Represents a physical beacon device.

The Beacon object

NameTypeMandatory?Description
createdAtlongAutogeneratedCreation date (timestamp UTC).
updatedAtlongAutogeneratedLast update time (timestamp UTC).
beaconIdstringAutogeneratedBeacon identifier.
accountIdstringYesAccount id.
zoneIdstringNoId of the Zone this Beacon belongs to.
config.namestringYesName of the Beacon.
config.descriptionstringNoDescription of the Beacon.
config.providerstringNoProvider of the Beacon.
config.codestringNo4-digit code used in MOCA/Kontakt.io beacons. Replaces UUID, major and minor.
config.uuidstringYesUniversally Unique ID of the Beacon.
config.majorintegerYesMajor number of the Beacon.
config.minorintegerYesMinor number of the Beacon.
{
  "createdAt": 1492088716569,
  "updatedAt": 1492091163757,
  "beaconId": "iqfruxiURO2HE4_OhxJ6kg",
  "accountId": "TAPFXFowToO4dFsktFzz9Q",
  "zoneId": null,
  "config": {
    "name": "HQ Gate",
    "description": "Beacon at HQ building gate",
    "provider": "MOCA",
    "code": "sHSK",
    "uuid": "f7826da6-4fa2-4e98-8024-bc5b71e0893e",
    "major": 11236,
    "minor": 5795
  }
}