PeripheralStatusItem

Class PeripheralStatusItem.

This where the Peripheral’s status is set.

PeripheralStatusItem Properties

DeviceStatusItem -> PeripheralStatusItem

PeripheralStatusItem -> InputStatusItem -> OutputStatusItem -> ReaderStatusItem

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 PeripheralStatusItem

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

Update Peripheral Status Async

Example in C#

// Returns: Boolean
var item = await client.UpdatePeripheralStatusAsync(MercuryPeripheralInfo peripheral, PeripheralStatusItem status);

Example in CURL



           curl -X PUT \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/peripherals/Status \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '{"$type":"Feenics.Keep.WebApi.Model.PeripheralStatusItem, Feenics.Keep.WebApi.Model"}'