In the REST API interface all responses are returned in JSON format, data fields are returned in alphabetical order.

Access Token

Contains an access token. The access token authenticates the customer in all further calls. An access token expires after a few hours.

Header	Format	Description
access_token	String	The newly generated access token
expires_in	Integer	Expires in X seconds from the time of this requiest
token_type	String	To be used in the Authorization Header: token_type access_token

Device Status

A status holder that can contain either a status for either an Ubidium System, Decoder or Track Box. Note that the format of response may differ according to the device type.

Values - Ubidium

Header	Format	Description
ActiveExternal	Ubidium Active
ActiveInternal	Ubidium Active
Customer	Integer
ConnStatus	Integer	enum[Disconnected, Connected, Bad Connection]
Data	Ubidium Data
Passive	Ubidium Passive
Position	Position
Power	Ubidium Power
Settings	Ubidium Settings
System	Ubidium System
Time	Ubidium Time

Values - Decoder / TrackBox

Header	Format	Description
Customer	Integer
DeviceID	String
Received	String	DateTime
DeviceName	String
FileNo	Integer
BatteryCharge	Integer
Temperature	Number	Float
RecordsCount	Integer
IsRunTime	Bool
RealTime	String	DateTime
RealTimeAtRequest	String	DateTime
RunTime	Number	Double Only filled if RealTimeAtRequest is before 1000-01-01, indicating a zero start event.
RunTimeAtRequest	Number	Double Only filled if RealTimeAtRequest is before 1000-01-01, indicating a zero start event.
UTCOffset	Integer
TimeZoneName	String
Position	Position
Connected	Bool
DeviceType	String	enum[Decoder, TrackBox]
DecoderStatus	Decoder Status
TrackboxStatus	Track Box Status

Ubidium Status

Active

Header	Format	Description
Boxes	array[ Beacon ]
Channel	Integer
Connected	Bool
LoopID	Integer
LoopStatus	Integer
LoopPower	Integer

Battery

Header	Format	Description
Installed	Bool
Level	Integer
Remaining	Integer
State	Integer

Data

Header	Format	Description
FileNumber	Integer
PassingID	Integer
PassingNo	Integer

Passive

Header	Format	Description
Battery1	Ubidium Battery
Battery2	Ubidium Battery

Power

Header	Format	Description
Boxes	array[ Beacon ]
Channel	Integer
Connected	Bool
LoopID	Integer
LoopStatus	Integer
LoopPower	Integer

Settings

Header	Format	Description
DeadTime	Integer
ReactionTime	Integer

System

Header	Format	Description
DeviceID	String
DeviceName	String
Firmware	String
Temperature	Integer

Time

Header	Format	Description
DeviceTimeAtRequest	String	DateTime
Offset	Integer
Received	String	DateTime
Time	String	DateTime

Decoder Status

Decoder status values

Values

Header	Format	Description
Protocol	Number	Float
Firmware	String
Antennas	String	8 characters 0 or 1 to represent which antenna ports are connected
HasPower	Bool
Ext12Volt	Number	Float Voltage on the 12V power input
IsInTImingMode	Bool
ReaderIsHealthy	Bool
TimeIsRunning	Bool
ReaderTemperature	Number	Float Temperature in °C
DeadTime	Integer
ReactionTime	Integer
Notification	String
UHFFrequency	Integer
TimeSource	Integer
AutomaticStandbyEnabled	Bool
IsInStandby	Bool
ErrorFlags	Integer
ActiveExtension	Beacon
ActiveBoxes	array[ Beacon ]

Track Box Status

Track Box Status values

Values

Header	Format	Description
Protocol	Integer
Channel	Integer	2.4Ghz Channel Index (0...7)
MemoryLeft	Integer
Noise	Integer
Cell	String
LAC	String
Satellites	Integer
Session	String
BoxVariant	String	enum[ ATrack, PTrack ]
PowerStatus	String	enum[ BATTERY, POWER, SUNNY, SHADY, ERROR ]
ReaderStatus	String	enum[ ON, NOSYNC, SYNC, MULT, OFF, WARN, ERROR ]
NetPLMN	Integer
NetProvider	String
NetSignal	Integer

Position

GPS position location of the system at the time of upload

Header	Format	Description
Altitude	Integer
Flag	String	Additional information about the systems position / movement at the time of upload. U : Unknown S : Box was stationary within the last minute M : Box was moving within the last minute T : Box was moving with a speed of at least 5km/h in the last minute X : Position may not be accurate (box has moved since last GPS fix)
Latitude	Number	Double
Longitude	Number	Double

Beacon

Active Box beacon information

Header	Format	Description
BeaconIndex	Integer
BeaconLQI	Integer
BeaconRSSI	Integer
BeaconTimestamp	String
Channel	Integer
ChannelSwitchingMode	String
Connected	Bool
ID	Integer
LoopID	Integer
LoopPower	Integer
LoopStatus	Integer
Mode	Integer
NoiseAvg	Integer
NoisePeak	Integer
PowerConn	Integer
PowerStatus	Integer
SinceLastSeen	Integer	Duration as nanosecond count
TransLQI	Integer
TransRSSI	Integer

Device File Metadata

Metadata of the passings / trackping file

Header	Format	Description
Count	Integer
Created	String	DateTime
Customer	Integer
DeviceID	String
FileNo	Integer
FilePos	Position

Detection Data

Detection data represents an abstract class which may return one of the following according to the request:

Ubidium Detection

Ubidium Detection Data

Header	Format	Description
act_data	Active Passing Data	Active passing data
hits	Integer	Hits count
id	Integer	Internal ID of the passing
internal	String	Internally calculated code
loc	Passing Location	Location of the device at the time of passing (Omitted if empty)
no	Passing Number	Passing file reference
rssi	Integer	RSSI Value of active passing
src	Passing Source	Device data of passing
time	String	DateTime Full DateTime of the passing
time_offset	Integer	Time zone offset of device at time of passing
transp	Transponder Data	Transponder data of passing

Active Passing Data

Header	Format	Description
channel	Integer	Active passing channel
flags	Integer	Status / Warning Flags (Omitted if empty)
loop_id	Integer	Active passing Loop ID
loop_only	Bool	True if the passing was generated in store mode (Omitted if empty or false)

Passing Location

Header	Format	Description
alt	Number	Float Altitude
lat	Number	Float Latitude
long	Number	Float Longitude

Passing Number

Header	Format	Description
file	Integer	Passing file number
no	Integer	Passing number within the file

Passing Source

Header	Format	Description
customer	Integer	Customer ID passing was retrieved from
device_id	String	Device ID
device_name	String	Device name (Omitted if empty)
input	String	Name of the (sub) device that generated the passing

Transponder Data

Header	Format	Description
active	Active Transponder Data	Additional active transponder data (Omitted if empty)
id	String	Transponder ID
passive	Passive Transponder Data	Additional passive transponder data (Omitted if empty)

Active Transponder Data

Header	Format	Description
bat	Integer	Transponder battery data at time of passing Divide by 10 to retrieve true battery Voltage
temp	Integer	Transponder temperature at time of passing (°C)
wuc	Integer	Transponder wake-up-count

Passive Transponder Data

Header		Format	Description
order_id		Integer	The OrderID for the transponder

Decoder Passing

A decoder passing record

Header	Format	Description
Battery	Number	Float Active Transponder battery voltage (v)
Channel	Integer	Active Channel on which the passing was recorded
Code	String	Transponder code or number
Customer	Integer	Customer ID the passing was uploaded to
DeviceID	String	ID of the device which recorded the passing
DeviceName	String	Name of the device which recorded the passing, as of the time of upload
FileNo	Integer	File number the passing is saved to
Hits	Integer	Hits count
InternalActiveData*	Integer	Status Flags for Active passings
InternalData	String	Internally calculated code
IsActive	Bool	True if generated from an Active Transponder
LoopID	Integer	Active Loop ID on which the passing was recorded
LoopOnly	Bool	Is true if the passing was recorded in Store mode
MaxRSSIAntenna	Integer	The passive antenna port which recorded the passing
OrderID	Integer	The OrderID for the transponder
Position	Position
PassingNo	Integer	PassingID within the file
RSSI	Integer	RSSI Value of active passing
Temp	Integer	Active Transponder recorded temperature
IsRunTime	Bool	Is true if the RealTime date is before 1000-01-01, indicating a zero start event (Not using GPS time or synced computer time)
RealTime	String	DateTime Full DateTime of the passing
RunTime	Number	Double The run time as a value in seconds, only filled if RealTime is before the date 1000-01-01, indicating a zero start event.
UTCOffset	Integer	System UTC Offset at the time of the passing
WUC	Integer	Transponder wake-up-count

Trackping

A Trackping record

Header	Format	Description
TrackpingNo	Integer	Trackping ID within the file
Customer	Integer	Customer ID the trackping was uploaded to
DeviceID	String	Device ID which recorded the Trackping
FileNo	Integer	File number the Trackping is saved to
BoxType	String	enum[ ATrack, PTrack ]
DeviceName	String	Name of the device which recorded the Trackping as of the time of recording
Code	String	Transponder code or number
Time	String	DateTime Full DateTime of the Trackping
BoxTime	String	DateTime Timestamp of the device when sending the Trackping
Received	String	DateTime Timestamp of the server when the Trackping was received
Cell	String	Mobile network cell
Hits	Integer	Hits count
LAC	String	Location Area Code
MinRSSI	Integer	Minimal RSSI value of Trackping
MinTime	String	DateTime Timestamp the minimal RSSI was recorded
OrderID	Integer	Order ID of the transponder
PeakIndex	Integer	Index of the highest RSSI value
RSSI	Integer	RSSI value of Trackping
Position	Position	Position of the device at the time the Trackping was recorded
BoxPosition	Position	Position of the device at the time the Trackping was uploaded