SafrControllerInfo

Overview of SafrControllerInfo goes here.

SafrControllerInfo Properties

Item -> BaseInfo -> ControllerInfo -> SafrControllerInfo

Field Type Inherited from Description
Href String Item Gets or sets the href.
CommonName String BaseInfo Common Name of the resource.The common name of the resource.
ConcurrencyVersion Nullable<Int64> BaseInfo Gets or Set the Version.
InFolderHref String BaseInfo relative path Href value for the containing folderAll objects exist within a folder. Even folders!
InFolderKey String BaseInfo Represents the internal ID of the containing folder
IsGlobal Boolean BaseInfo If set True, the object will be exposed to the entire instance scope in which it resides. Meaning this object will always pass scope wide permissions tests when being queried although other restrictions such as by type will still apply (You need at least Read on the object type to see it regardless where you are in the instance scope). This Attribute is intended for use with AccessLevelInfo objects only. Use with other model objects may cause unexpected behaviors. Particularly this should not be used with ScheduleInfos, HolidayInfos, HolidayDayInfos, or ElevatorAccessLevelInfos. In time more objects will be allowed for use with this attribute but for the time being please only use with AccessLevelInfo Objects.
Key String BaseInfo Represents the internal ID of the object.
Links List<Link> BaseInfo List of related resourcesIt is expected that a resource will have many related resources (i.e. person has many access levels) Consumers of the API are encouraged to iterate through the list of links requesting this additional information as required.
Metadata MetadataItem[] BaseInfo The set of metadata attached to this resourceMetadata is opaque to the server code. Key value pairs are saved as part of a client activity. Users of the Native windows client, are able to design custom forms to display and edit scalar values in the meta data.
Monikers MonikerItem[] BaseInfo the set of Monikers for this object
Notes NoteInfo[] BaseInfo The set of notes attached to this resourceNotes are free form text only that is stored in chronological order. All notes are retrieved as part of an OBJECT get. Notes may be added as one POST but not updated with a PUT of the primary resource. WHen the resource is deleted all the notes are also deleted.
ObjectLinks ObjectLinkItem[] BaseInfo The set of resources that are related to this resourceFrequently resources have a one to one, or one to many relationship with other resources in the system. Use this set of links to discover related resources. 2016/09/29 Href property of the related resource may be null. In which case it’s expected that a set of related objects has already been retrieved by the client and the Key value will be used to index into that set.
Tags String[] BaseInfo the set of tags for this objectTags are used to group objects together for the purposes of selection and assignment of operation rights
IsDisabled Boolean ControllerInfo Indicates that the controller is disabled. All connection attempts should be refused if true, and connected controllers should be disconnected when change to true is detected.
LastPing Nullable<DateTime> ControllerInfo Date and time of the last communication with the communication service (UTC). This property can be used to check if the last online status is valid or not.
LastUpdatedOn Nullable<DateTime> ControllerInfo Gets or sets the LastUpdatedOn value
MacAddress String ControllerInfo The Mac Address of the controller, expected format 00:00:00:00:00:00. Must be unique across DatabaseAll controllers are assumed to be IP devices, that will identify to the comm system using their MacAddress
Status ControllerStatusItem ControllerInfo Controller Status as set by the Communications Service
TimeZone String ControllerInfo String representation of the timezone the controller is in, set according to POSIX.1 TZ standardsFor example: EST5EDT,M3.2.0/2,M11.1.0/2 Use a 3 letter Abbreviation for the Standard Time and daylight saving time, plus the hours difference from UTC
Version String ControllerInfo Major Minor Build number of the firmware as reported by the controller
AccessMode SafrAccessMode SafrControllerInfo Gets or sets the required Access credentials to the SAFR Scan camera
BacklightCompensationLevel SafrBacklightCompensationLevel SafrControllerInfo Gets or sets the backlight compensating level for the SAFR Scan camera
CameraIRLight SafrAutoOnOff SafrControllerInfo Gets or sets the IR light setting on the SAFR Scan camera
CameraWhiteLight SafrAutoOnOff SafrControllerInfo Gets or sets the white light setting on the SAFR Scan camera
DisplayBrightness Int32 SafrControllerInfo Gets or sets the brightness of the SAFR Scan camera
DisplayMode SafrAutoOnOff SafrControllerInfo Gets or sets the display mode of the SAFR Scan camera. Auto - On when face is detected, ON is always on, OFF is always off
DoorStrikeRelayDurationMilliseconds Int32 SafrControllerInfo Gets or sets the number of milliseconds that the door strike relay remains open after being activated.
DoorStrikeRelayEnabled Boolean SafrControllerInfo Gets or sets if the door strike relay is enabled.
FaceActivationDistance SafrFaceActivationDistance SafrControllerInfo Gets or sets the minimum distance at which a face is scanned by the SAFR Scan Camera
FaceMatchConfidenceRequired SafrConfidenceLevel SafrControllerInfo Gets or sets the required confidence level for authorizing a face on the SAFR Scan camera
KeypadLayout SafrKeypadLayout SafrControllerInfo Gets or sets the layout of the keypad.
MobileCredentialDomainName String SafrControllerInfo Gets or sets the mobile credential domain name for SAFR Scan camera
MonitoringMode SafrMonitoringMode SafrControllerInfo Gets or sets the Monitoring Mode for the SAFR Scan Camera
SoundVolume Int32 SafrControllerInfo Gets or sets the sound volume on the SAFR Scan camera
SpoofingProtectionLevel SafrSpoofingProtectionLevel SafrControllerInfo Gets or sets the spoofing protection setting on the SAFR Scan camera
StatisticsEnabled Boolean SafrControllerInfo Gets or sets if the display should record and report statistics for this feed.
WaitTimeDenyMilliseconds Int32 SafrControllerInfo Gets or sets the Minimum number of milliseconds that a face that qualified for access needs to be present before access is denied
WaitTimeGrantMilliseconds Int32 SafrControllerInfo Gets or sets the Minimum number of milliseconds that a face that qualified for access needs to be present before access is granted
WaitTimeSecondFactorMilliseconds Int32 SafrControllerInfo Gets or sets the Minimum number of milliseconds that credentials will be retained to match up with 2nd factor credential
WiegandControllerOutputEnabled Boolean SafrControllerInfo Gets or sets if the Wiegand connection to Control Panel (output) is enabled.
WiegandReaderInputEnabled Boolean SafrControllerInfo Gets or sets if the Wiegand connection to Reader (input) is enabled.

JSON Structure of SafrControllerInfo

{
   "Href"	:	"String",
   "CommonName"	:	"String",
   "ConcurrencyVersion"	:	"Nullable\<Int64\>",
   "InFolderHref"	:	"String",
   "InFolderKey"	:	"String",
   "IsGlobal"	:	"Boolean",
   "Key"	:	"String",
   "Links"	:	"List\<[Link](/object-model/link)\>",
   "Metadata"	:	"[MetadataItem](/object-model/metadataitem)[]",
   "Monikers"	:	"[MonikerItem](/object-model/monikeritem)[]",
   "Notes"	:	"[NoteInfo](/object-model/noteinfo)[]",
   "ObjectLinks"	:	"[ObjectLinkItem](/object-model/objectlinkitem)[]",
   "Tags"	:	"String[]",
   "IsDisabled"	:	"Boolean",
   "LastPing"	:	"Nullable\<DateTime\>",
   "LastUpdatedOn"	:	"Nullable\<DateTime\>",
   "MacAddress"	:	"String",
   "Status"	:	"[ControllerStatusItem](/object-model/controllerstatusitem)",
   "TimeZone"	:	"String",
   "Version"	:	"String",
   "AccessMode"	:	"[SafrAccessMode](/object-model/safraccessmode)",
   "BacklightCompensationLevel"	:	"[SafrBacklightCompensationLevel](/object-model/safrbacklightcompensationlevel)",
   "CameraIRLight"	:	"[SafrAutoOnOff](/object-model/safrautoonoff)",
   "CameraWhiteLight"	:	"[SafrAutoOnOff](/object-model/safrautoonoff)",
   "DisplayBrightness"	:	"Int32",
   "DisplayMode"	:	"[SafrAutoOnOff](/object-model/safrautoonoff)",
   "DoorStrikeRelayDurationMilliseconds"	:	"Int32",
   "DoorStrikeRelayEnabled"	:	"Boolean",
   "FaceActivationDistance"	:	"[SafrFaceActivationDistance](/object-model/safrfaceactivationdistance)",
   "FaceMatchConfidenceRequired"	:	"[SafrConfidenceLevel](/object-model/safrconfidencelevel)",
   "KeypadLayout"	:	"[SafrKeypadLayout](/object-model/safrkeypadlayout)",
   "MobileCredentialDomainName"	:	"String",
   "MonitoringMode"	:	"[SafrMonitoringMode](/object-model/safrmonitoringmode)",
   "SoundVolume"	:	"Int32",
   "SpoofingProtectionLevel"	:	"[SafrSpoofingProtectionLevel](/object-model/safrspoofingprotectionlevel)",
   "StatisticsEnabled"	:	"Boolean",
   "WaitTimeDenyMilliseconds"	:	"Int32",
   "WaitTimeGrantMilliseconds"	:	"Int32",
   "WaitTimeSecondFactorMilliseconds"	:	"Int32",
   "WiegandControllerOutputEnabled"	:	"Boolean",
   "WiegandReaderInputEnabled"	:	"Boolean"
}