GET api/Units/CurrentState?serialNumber={serialNumber}

Returns a specific unit's current state

Request Information

URI Parameters

Name	Description	Type	Additional information
serialNumber		string	Required

Body Parameters

None.

Response Information

Resource Description

Returns a specific unit's current state

UnitCurrentStateModel

Name	Description	Type	Additional information
Suspended	Access to this tracker's data has been suspended. All other datapoints will be null or meaningless.	boolean	None.
ReadyForActivation	Tracker is ready to be activated by magnet or otherwise	boolean	None.
Active	Tracker is functioning as expected	boolean	None.
NoCommunication	Tracker has missed 5 consecutive scheduled transmissions, and it is more than 5 days since we last received communication from the tracker	boolean	None.
LowBattery	Tracker is estimated to have less than 15% battery left	boolean	None.
NeedsInspection	Tracker has NextInspectionDate set, and it is overdue	boolean	None.
HasRecentAlarm	Tracker has alarm events in the last 24 hours	boolean	None.
BatteryPercent	The tracker's current estimated BatteryPercent	integer32	None.
NextInspectionDate		date	None.
RecentAlarmsCount	Tracker of alarm events in the last 24 hours	integer32	None.
SerialNumber	Read Only	string	Required
UserGroupId		integer32	None.
ReferenceId		string	None.
Name		string	None.
ItemDescription		string	None.
LastModified	UTC time of last modification	date	None.

Response Formats

application/json, text/json

Sample:

{
  "Suspended": true,
  "ReadyForActivation": true,
  "Active": true,
  "NoCommunication": true,
  "LowBattery": true,
  "NeedsInspection": true,
  "HasRecentAlarm": true,
  "BatteryPercent": 8,
  "NextInspectionDate": "2024-05-19T15:08:48.8986975+00:00",
  "RecentAlarmsCount": 9,
  "SerialNumber": "sample string 10",
  "UserGroupId": 11,
  "ReferenceId": "sample string 12",
  "Name": "sample string 13",
  "ItemDescription": "sample string 14",
  "LastModified": "2024-05-19T15:08:48.8986975+00:00"
}

application/xml, text/xml

Sample:

<UnitCurrentStateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models">
  <ItemDescription>sample string 14</ItemDescription>
  <LastModified>2024-05-19T15:08:48.8986975+00:00</LastModified>
  <Name>sample string 13</Name>
  <ReferenceId>sample string 12</ReferenceId>
  <SerialNumber>sample string 10</SerialNumber>
  <UserGroupId>11</UserGroupId>
  <Active>true</Active>
  <BatteryPercent>8</BatteryPercent>
  <HasRecentAlarm>true</HasRecentAlarm>
  <LowBattery>true</LowBattery>
  <NeedsInspection>true</NeedsInspection>
  <NextInspectionDate>2024-05-19T15:08:48.8986975+00:00</NextInspectionDate>
  <NoCommunication>true</NoCommunication>
  <ReadyForActivation>true</ReadyForActivation>
  <RecentAlarmsCount>9</RecentAlarmsCount>
  <Suspended>true</Suspended>
</UnitCurrentStateModel>