Introduction > acre Access Control Object Model > InstanceSettingsInfo

InstanceSettingsInfo

Class InstanceSettingsInfo.

Instance Settings are set using this object. It designates default behaviors for an instance.

InstanceSettingsInfo Properties

Item -> BaseInfo -> InstanceSettingsInfo

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 resource. Frequently 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 object. Tags are used to group objects together for the purposes of selection and assignment of operation rights.
AdminEmailAddress	String	InstanceSettingsInfo	Gets or sets the admin email address.
AllowDuplicatePins	Boolean	InstanceSettingsInfo	Gets or sets the value indicating if the instance should allow duplicate PinCodes to be used.Possible Values (true, false)
CharacterMask	Int32	InstanceSettingsInfo	Gets or sets the character mask.
CleanExpiredCards	Boolean	InstanceSettingsInfo	Gets or sets the value indicating if cards that have expired for more than a month will be deleted or kept.Possible Values (true, false)
ClearAntiPassbackIsActive	Nullable<Boolean>	InstanceSettingsInfo	When set to true this will clear down the antipassback when clearing down the muster
ClearAreaCountsIsActive	Nullable<Boolean>	InstanceSettingsInfo	When set to true this will clear down the area counts when clearing down the muster
ClearMusterIsActive	Nullable<Boolean>	InstanceSettingsInfo	If set true, the muster report will clear out any muster participants at the set clear muster time
ClearMusterTimeInMinutes	Nullable<Int32>	InstanceSettingsInfo	Clear muster time is when the muster participants will be cleared at if the clear muster active is set
CopyOperatorTags	Nullable<Boolean>	InstanceSettingsInfo	If set true, the tags of the operator will be added to all new objects created by that operator. (Default value is true for new instances)
DaysOfPersonAuditTrailRetention	Nullable<Int32>	InstanceSettingsInfo	Number of days to audit trails are saved
DaysOfPersonLogEventRetention	Nullable<Int32>	InstanceSettingsInfo	Number of days to log events are saved
DisconnectTimeout	Nullable<Int32>	InstanceSettingsInfo	Gets or sets the disconnect timeout.
DoNotRememberPassword	Nullable<Boolean>	InstanceSettingsInfo	When set to true login screen will not persist password for auto login workflow.
DuressMode	Int32	InstanceSettingsInfo	Gets or sets the duress mode.
ElevatorPushButtonTime	Int32	InstanceSettingsInfo	Gets or sets the elevator push button time.
ElevatorRelayTime	Int32	InstanceSettingsInfo	Gets or sets the elevator relay time.
EnforceBoschDuressCodes	Boolean	InstanceSettingsInfo	Gets or sets the value indicating if Bosch Duress Codes should be enforced.Possible Values (true, false)
HostResponseTimeout	Int32	InstanceSettingsInfo	Gets or sets the number of seconds (between 2 and 30) that the controller will wait on the host to respond for access request
IndividualCleardownIsActive	Nullable<Boolean>	InstanceSettingsInfo	If set to true this will clear out individual muster participants if onsite for more than the specified individual cleardown length
IndividualCleardownLengthHours	Nullable<Int32>	InstanceSettingsInfo	The amount of time that an individual can be onsite before they are cleared from the muster
IssueCodeSize	Byte	InstanceSettingsInfo	Gets or sets the size of the issue code.
MasterHolidayOptIn	Boolean	InstanceSettingsInfo	Gets or sets a value indicating whether to accept updates to HolidayDays from the VAR instance
MaxAccessLevels	Int32	InstanceSettingsInfo	Gets or sets the maximum access levels.
MaxAccessLevelsPerCardHolder	Int32	InstanceSettingsInfo	Gets or sets the maximum access levels per card holder.
MaxCardHolders	Int32	InstanceSettingsInfo	Gets or sets the maximum card holders.
MaxElevatorAccessLevels	Int32	InstanceSettingsInfo	Gets or sets the maximum elevator access levels.
MaxElevatorFloors	Int32	InstanceSettingsInfo	Gets or sets the maximum elevator floors.
NotifyMusterRecipients	Nullable<Boolean>	InstanceSettingsInfo	When set to true this will signify that all recipients of the muster report will be notified
OverlappingDoorModesOptIn	Nullable<Boolean>	InstanceSettingsInfo	When set to true door/ reader modes will always follow the most recently active schedule instead of returning to online mode.
PinAllowDigitMoreThanTwice	Boolean	InstanceSettingsInfo	Required for OSDP EN grade 3. Must be false for grade 3 instances. Use of same digit more than twice shall not be allowed.
PinAllowSequentialDigits	Boolean	InstanceSettingsInfo	Required for OSDP EN grade 3. Must be false for grade 3 instances. Sequential ascending or descending pass-code digits shall not be allowed.
PinLength	Int32	InstanceSettingsInfo	Gets or sets the length of the pin.
PurgeAuditTrailOnPersonDelete	Nullable<Boolean>	InstanceSettingsInfo	When set to true this will delete the audit trail of a Person when deleted
PurgeLogEventsOnPersonDelete	Nullable<Boolean>	InstanceSettingsInfo	When set to true this will delete all card holder information from their log events when a Person is deleted
SecurityLevel	SecurityLevels	InstanceSettingsInfo	Gets or sets the security level.
SessionTimeoutMinutes	Nullable<Int32>	InstanceSettingsInfo	Session Timeout in Minutes for aAC. Default is 20 minutes, when set to 0, session timeout is disabled.
TransactionNumber	Int32	InstanceSettingsInfo	Gets or sets the transaction number.
UseCountIsEnabled	Boolean	InstanceSettingsInfo	Gets or sets a value indicating whether the Use Count feature should be enabled on the controllersPossible Values (true, false)

JSON Structure of InstanceSettingsInfo

{
   "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[]",
   "AdminEmailAddress"	:	"String",
   "AllowDuplicatePins"	:	"Boolean",
   "CharacterMask"	:	"Int32",
   "CleanExpiredCards"	:	"Boolean",
   "ClearAntiPassbackIsActive"	:	"Nullable\<Boolean\>",
   "ClearAreaCountsIsActive"	:	"Nullable\<Boolean\>",
   "ClearMusterIsActive"	:	"Nullable\<Boolean\>",
   "ClearMusterTimeInMinutes"	:	"Nullable\<Int32\>",
   "CopyOperatorTags"	:	"Nullable\<Boolean\>",
   "DaysOfPersonAuditTrailRetention"	:	"Nullable\<Int32\>",
   "DaysOfPersonLogEventRetention"	:	"Nullable\<Int32\>",
   "DisconnectTimeout"	:	"Nullable\<Int32\>",
   "DoNotRememberPassword"	:	"Nullable\<Boolean\>",
   "DuressMode"	:	"Int32",
   "ElevatorPushButtonTime"	:	"Int32",
   "ElevatorRelayTime"	:	"Int32",
   "EnforceBoschDuressCodes"	:	"Boolean",
   "HostResponseTimeout"	:	"Int32",
   "IndividualCleardownIsActive"	:	"Nullable\<Boolean\>",
   "IndividualCleardownLengthHours"	:	"Nullable\<Int32\>",
   "IssueCodeSize"	:	"Byte",
   "MasterHolidayOptIn"	:	"Boolean",
   "MaxAccessLevels"	:	"Int32",
   "MaxAccessLevelsPerCardHolder"	:	"Int32",
   "MaxCardHolders"	:	"Int32",
   "MaxElevatorAccessLevels"	:	"Int32",
   "MaxElevatorFloors"	:	"Int32",
   "NotifyMusterRecipients"	:	"Nullable\<Boolean\>",
   "OverlappingDoorModesOptIn"	:	"Nullable\<Boolean\>",
   "PinAllowDigitMoreThanTwice"	:	"Boolean",
   "PinAllowSequentialDigits"	:	"Boolean",
   "PinLength"	:	"Int32",
   "PurgeAuditTrailOnPersonDelete"	:	"Nullable\<Boolean\>",
   "PurgeLogEventsOnPersonDelete"	:	"Nullable\<Boolean\>",
   "SecurityLevel"	:	"[SecurityLevels](/object-model/securitylevels)",
   "SessionTimeoutMinutes"	:	"Nullable\<Int32\>",
   "TransactionNumber"	:	"Int32",
   "UseCountIsEnabled"	:	"Boolean"
}

Get Settings For Instance

Example in C#

// Returns: InstanceSettingsInfo
var instanceSettingsInfo = await client.GetSettingsForInstance(InstanceInfo instanceInfo);

Example in CURL



           curl -X GET \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/settings \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'

Save Settings For Instance Async