DeviceStatusItem

Represents the base class for tracking the operational status of access control hardware devices including readers, controllers, inputs, outputs, and doors

Overview of DeviceStatusItem goes here.

DeviceStatusItem Properties

DeviceStatusItem

DeviceStatusItem -> ControllerStatusItem -> DoorStatusItem -> DownstreamStatusItem -> PeripheralStatusItem

Field Type Inherited from Description
ConcurrencyVersion Nullable<Int64> DeviceStatusItem Concurrency version for optimistic concurrency control.
DisplayLevel String DeviceStatusItem Gets or sets the display level for this item, typically used to indicate visual priority, severity, or categorization in the user interface (e.g., Info, Warning, Critical).
DisplayStatus String DeviceStatusItem Gets or sets the display-friendly status text for the device. This is typically used for UI representation and may differ from internal status codes. [BsonIgnoreIfDefault] to avoid reading the value.
Key String DeviceStatusItem Device ID of the device hosting the status. This is provided to link the status to the device.
LastUpdated Nullable<DateTime> DeviceStatusItem Last update time in UTC. If null, the current time will be used.
LogId Nullable<Int64> DeviceStatusItem The log ID is provided by the smart controller (AUP devices) with every log event. So if the device status is being updated as part of processing a log event, the log ID can be used to correlate the status update with the original log event and gives the order of events. (Don’t override the status with an older logId.)

JSON Structure of DeviceStatusItem

{
   "ConcurrencyVersion"	:	"Nullable\<Int64\>",
   "DisplayLevel"	:	"String",
   "DisplayStatus"	:	"String",
   "Key"	:	"String",
   "LastUpdated"	:	"Nullable\<DateTime\>",
   "LogId"	:	"Nullable\<Int64\>"
}

Get Device Status Async

Example in C#

// Returns: DeviceStatusItem
var deviceStatusItem = await client.GetDeviceStatusAsync(FolderInfo folder, String deviceKey);

Example in CURL



           curl -X GET \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/device-status?deviceKeyviceKey=DEVICE.KEY \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'

Update Device Statuses Async

Example in C#

// Returns: BulkResultInfo
var bulkResultInfo = await client.UpdateDeviceStatusesAsync(FolderInfo folder, DeviceStatusItem statusItems, Boolean suppressUpdateEvent);

Example in CURL



           curl -X PUT \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/device-status \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'