Skip to main content

API Documentation: Beacons API

Updated

Reference

Base URI
Staging - https://staging-api-service.azurewebsites.net/ 
Production - https://api.peopletray.com 

Authentication
All requests to the PeopleTray API must be authenticated. See the Authentication page for more details

 

List of Beacons

Gets a list of all Beacons in the account (Equipment Items where the Category is a Beacon).

Endpoint {baseUri}/api/beacons
Method: GET
Authentication: Token

Each Beacon has the following details:

  • Name - Equipment Item Name
  • BeaconId - The Asset Number
  • EquipmentItemId - The system ID
  • LocalMapName - Name of the Local Map the Beacon is placed
  • LocalMapId - The system ID
  • FacilityName - Name of the Facility of the Local Map
  • FacilityId - The systemID
  • BeaconDetectCycleSecs - Beacon detection cycle time in seconds
  • IosUuid - IOS UUID - Guid
  • IosMajor - IOS Major - Int
  • IosMinor - IOS Minor - Int
  • Latitude - Latitude of the Facility that the Beacon is associated with
  • Longitude - Longitude of the Facility that the Beacon is associated with

The System IDs are included for referential purpose.

 

 

Submit Beacon Detections

Submit beacon detection from the Mobile App to the API.

Endpoint {baseUri}/api/beacondetections
Method: POST
Authentication: Token

Parameter:
detections - an array of beacon detection models:

Payload:

[
{
   "EquipmentItemId":677,
   "DetectionDateTime":"09-Jul-2020",
   "SignalStrength":"5"
},
{
   "EquipmentItemId":677,
   "DetectionDateTime":"09-Jul-2020",
   "SignalStrength":"5"
}
]
  • EquipmentItemId (int) - (required) the id passed down from the beacons api.
  • DetectionDateTime (datetime) - (required) - Date and Time of the detection (24hr format).
  • SignalStrength (string) - optional

 

 

Beacon Hound Scan Log

Submit scan logs from the Mobile App to the API.

Endpoint {baseUri}/api/beaconhoundscanlog
Method: POST
Authentication: Token

Payload:

{
    "scanDateTime":"2020-08-09T14:20:30"
}
  • ScanDateTime (datetime) - (required) - Date and Time of the scan (24hr format).

User details will be picked up from the Auth Token

 

 

Beacon Detection for PowerBi

Detection data is available for viewing/analysis on the PowerBi API at:
https://miningpatch.visualstudio.com/peopletray/_wiki/wikis/peopletray.wiki/65/Power-BI-API?anchor=beacon-detection

Powered by Zendesk