ControllerPeripheralStatusItem

Represents the result of a call to the API to get peripheral statuses for a controller

Overview of ControllerPeripheralStatusItem goes here.

ControllerPeripheralStatusItem Properties

ControllerPeripheralStatusItem

Field Type Inherited from Description
Key String ControllerPeripheralStatusItem Gets or sets the Key of the Peripheral.
Status PeripheralStatusItem ControllerPeripheralStatusItem Gets or sets the Status of the Peripheral.

JSON Structure of ControllerPeripheralStatusItem

{
   "Key"	:	"String",
   "Status"	:	"[PeripheralStatusItem](/object-model/peripheralstatusitem)"
}

Get Controller Peripheral Statuses Async

Example in C#

// Returns: ControllerPeripheralStatusItem
var controllerPeripheralStatusItem = await client.GetControllerPeripheralStatusesAsync(ControllerInfo controller);

Example in CURL



           curl -X GET \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/controllers/CONTROLLER.KEY/peripheral-status \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '
                 [{
                       "$type":"ControllerPeripheralStatusItem",
                       "Key":"",
                       "Status":{"$type":"Feenics.Keep.WebApi.Model.PeripheralStatusItem, Feenics.Keep.WebApi.Model"}
                   },
                   {
                       "$type":"ControllerPeripheralStatusItem",
                       "Key":"",
                       "Status":{"$type":"Feenics.Keep.WebApi.Model.PeripheralStatusItem, Feenics.Keep.WebApi.Model"}
                   }]'

Update Controller Peripheral Status Async

Example in C#

// Returns: Boolean
var item = await client.UpdateControllerPeripheralStatusAsync(ControllerInfo controller, PeripheralStatusItem readerStatus);

Example in CURL



           curl -X PUT \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/controllers/CONTROLLER.KEY/peripheral-status \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '{
                       "$type":"Feenics.Keep.WebApi.Model.PeripheralStatusItem, Feenics.Keep.WebApi.Model",
                       "Mode":"",
                       "IsTampered":false,
                       "DoorForcedOpen":false,
                       "MaskDoorForcedOpen":false,
                       "DoorHeldOpen":false,
                       "MaskDoorHeldOpen":false,
                       "DoorContactFaulted":false,
                       "DoorContactMessage":"",
                       "RexFaulted":false,
                       "RexMessage":""
                   }'