iStarDoorInfo

Overview of iStarDoorInfo goes here.

iStarDoorInfo Properties

Item -> BaseInfo -> DoorInfo -> iStarDoorInfo

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
AltShuntTime Int32 iStarDoorInfo The number of hours, minutes, and seconds the Door can remain open before a door held open alert is generated after a valid card swipe by a cardholder with the Alternate Shunt flag set in their personnel recordThis value is used only if it is set to a greater time than the Shunt time value.
DoorCloseDebounceTime Int32 iStarDoorInfo Setting this value to 0 indicates that there is no timer. The range is from 0 to 25.5 seconds in units of 0.1 seconds
DoorOpenGraceTime Int32 iStarDoorInfo Also known as Door Open Debounce Time. Setting this value to 0 indicates that there is no timer; as soon as the door opens, door forced open is reported. The range is from 0 to 25.5 seconds in units of 0.1 seconds
DoorUnlockGraceTime Int32 iStarDoorInfo Specifies the time that the system waits for a door open signal after the door unlock time has expired. This timing prevents a false door forced message in situations where signals are nearly simultaneous. The range is from 0 to 100 seconds in units of 0.1 seconds.
IsContinuousActive Boolean iStarDoorInfo Enable/Disable continuous reader activity, enabling readers to read and process cards even when the doors associated with them are unlocked or open because of another card access request.This mode is typically used for turnstiles or other high traffic situations that would result in unacceptable delays if the reader went through its normal sequence of read-open-close for each cardholder.
IsGroup Boolean iStarDoorInfo Gets or sets the IsGroup value
NonAlarmToHost Boolean iStarDoorInfo Set to “true” to instruct the system to send non-alarm input status to the host.
RelockDelay Int32 iStarDoorInfo The number of seconds to delay door re-lock after the door is opened (after a request to exit, for example). The range in seconds is 0 to 999 seconds (0:16:39); the default is 0.
ShuntOnRTE Boolean iStarDoorInfo set to “true” to Shunt Door Switch Monitor While Request to Exit is Active
ShuntTime Int32 iStarDoorInfo The number of seconds that the door can remain open before a door held open alert is generated within the range of 00.00.00 to 2:46:00 (2 hours and forty-six minutes), the default is 0
UnlockOnRTE Boolean iStarDoorInfo Set to “true” to unlock the door at a Request to Exit
UnlockTime Int32 iStarDoorInfo The number of seconds the Door remains unlocked after a valid card swipe, RTE activation, or momentary unlock within the range of 0 to 255 seconds; the default is 5 seconds

JSON Structure of iStarDoorInfo

{
   "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[]",
   "AltShuntTime"	:	"Int32",
   "DoorCloseDebounceTime"	:	"Int32",
   "DoorOpenGraceTime"	:	"Int32",
   "DoorUnlockGraceTime"	:	"Int32",
   "IsContinuousActive"	:	"Boolean",
   "IsGroup"	:	"Boolean",
   "NonAlarmToHost"	:	"Boolean",
   "RelockDelay"	:	"Int32",
   "ShuntOnRTE"	:	"Boolean",
   "ShuntTime"	:	"Int32",
   "UnlockOnRTE"	:	"Boolean",
   "UnlockTime"	:	"Int32"
}