Represents the operational status of an Allegion Engage mobile credential reader
This where the Engage Reader’s status is set.
EngageReaderStatusItem
| Field | Type | Inherited from | Description |
|---|---|---|---|
| BatteryLevel | String | EngageReaderStatusItem | Gets or sets the current battery level description |
| FirmwareTransferCompletePercentage | String | EngageReaderStatusItem | Gets or sets the firmware transfer completion percentage |
| FirmwareUpdateCancelTime | Nullable<DateTime> | EngageReaderStatusItem | Gets or sets when the firmware update was cancelled |
| FirmwareUpdateCompletionTime | Nullable<DateTime> | EngageReaderStatusItem | Gets or sets when the firmware update completed |
| FirmwareUpdateStartTime | Nullable<DateTime> | EngageReaderStatusItem | Gets or sets when the firmware update started |
| FirmwareUpdateStatus | String | EngageReaderStatusItem | Gets or sets the firmware update status description |
| IsCriticalBattery | Nullable<Boolean> | EngageReaderStatusItem | Gets or sets whether the battery is critically low |
| IsDeadboltExtended | Nullable<Boolean> | EngageReaderStatusItem | Gets or sets whether the deadbolt is extended |
| IsDoorForcedOpen | Nullable<Boolean> | EngageReaderStatusItem | Gets or sets whether the door is being forced open |
| IsDoorHeldOpen | Nullable<Boolean> | EngageReaderStatusItem | Gets or sets whether the door is being held open |
| IsDoorOpen | Nullable<Boolean> | EngageReaderStatusItem | Gets or sets whether the door is currently open |
| IsFdrActive | Nullable<Boolean> | EngageReaderStatusItem | Gets or sets whether Fire Door Release (FDR) is active |
| IsKeyOverrideActive | Nullable<Boolean> | EngageReaderStatusItem | Gets or sets whether the key override is active (mechanical key used) |
| IsLowBattery | Nullable<Boolean> | EngageReaderStatusItem | Gets or sets whether the battery is low |
| IsMagneticTampered | Nullable<Boolean> | EngageReaderStatusItem | Gets or sets whether magnetic tampering has been detected |
| IsOnline | Nullable<Boolean> | EngageReaderStatusItem | Gets or sets whether the reader is online and communicating |
| IsPassage | Nullable<Boolean> | EngageReaderStatusItem | Gets or sets whether the lock is in passage mode (unlocked) |
| IsTampered | Nullable<Boolean> | EngageReaderStatusItem | Gets or sets whether the lock has been tampered with |
| LinkStatus | String | EngageReaderStatusItem | Gets or sets the link status description |
| SignalQuality | String | EngageReaderStatusItem | Gets or sets the signal quality description |
{
"BatteryLevel" : "String",
"FirmwareTransferCompletePercentage" : "String",
"FirmwareUpdateCancelTime" : "Nullable\<DateTime\>",
"FirmwareUpdateCompletionTime" : "Nullable\<DateTime\>",
"FirmwareUpdateStartTime" : "Nullable\<DateTime\>",
"FirmwareUpdateStatus" : "String",
"IsCriticalBattery" : "Nullable\<Boolean\>",
"IsDeadboltExtended" : "Nullable\<Boolean\>",
"IsDoorForcedOpen" : "Nullable\<Boolean\>",
"IsDoorHeldOpen" : "Nullable\<Boolean\>",
"IsDoorOpen" : "Nullable\<Boolean\>",
"IsFdrActive" : "Nullable\<Boolean\>",
"IsKeyOverrideActive" : "Nullable\<Boolean\>",
"IsLowBattery" : "Nullable\<Boolean\>",
"IsMagneticTampered" : "Nullable\<Boolean\>",
"IsOnline" : "Nullable\<Boolean\>",
"IsPassage" : "Nullable\<Boolean\>",
"IsTampered" : "Nullable\<Boolean\>",
"LinkStatus" : "String",
"SignalQuality" : "String"
}
Example in C#
// Returns: nothing
await client.UpdateEngageReaderStatusAsync(EngageReaderInfo reader, EngageReaderStatusItem status);
Example in CURL
curl -X PUT \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/engagereaders/ENGAGEREADERS.KEY/status \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d ENGAGEREADER.STATUSITEM