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.
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
AdminEmailAddress String InstanceSettingsInfo Gets or sets the admin email address.
CharacterMask Int32 InstanceSettingsInfo Gets or sets the character mask.
DisconnectTimeout Nullable<Int32> InstanceSettingsInfo Gets or sets the disconnect timeout.
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.
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
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.
PinLength Int32 InstanceSettingsInfo Gets or sets the length of the pin.
SecurityLevel SecurityLevels InstanceSettingsInfo Gets or sets the security level.
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",
   "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",
   "CharacterMask"	:	"Int32",
   "DisconnectTimeout"	:	"Nullable\<Int32\>",
   "DuressMode"	:	"Int32",
   "ElevatorPushButtonTime"	:	"Int32",
   "ElevatorRelayTime"	:	"Int32",
   "HostResponseTimeout"	:	"Int32",
   "IssueCodeSize"	:	"Byte",
   "MasterHolidayOptIn"	:	"Boolean",
   "MaxAccessLevels"	:	"Int32",
   "MaxAccessLevelsPerCardHolder"	:	"Int32",
   "MaxCardHolders"	:	"Int32",
   "MaxElevatorAccessLevels"	:	"Int32",
   "MaxElevatorFloors"	:	"Int32",
   "PinLength"	:	"Int32",
   "SecurityLevel"	:	"[SecurityLevels](/object-model/securitylevels)",
   "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://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/settings \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'
            

Save Settings For Instance Async

Example in C#

// Returns: nothing
await client.SaveSettingsForInstanceAsync(InstanceInfo instanceInfo, InstanceSettingsInfo instanceSettingsInfo)

Example in CURL



           curl -X PUT \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/settings \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -D'{
                       "$type":"Feenics.Keep.WebApi.Model.InstanceSettingsInfo, Feenics.Keep.WebApi.Model",
                       "SecurityLevel":3,
                       "MaxCardHolders":10000,
                       "MaxAccessLevelsPerCardHolder":8,
                       "MaxAccessLevels":128,
                       "MaxElevatorAccessLevels":128,
                       "MaxElevatorFloors":128,
                       "IssueCodeSize":0,
                       "PinLength":4,
                       "DuressMode":0,
                       "CharacterMask":1,
                       "AdminEmailAddress":null,
                       "ElevatorRelayTime":3,
                       "ElevatorPushButtonTime":3,
                       "DisconnectTimeout":60,
                       "TransactionNumber":10000,
                       "UseCountIsEnabled":false,
                       "Key":"SETTING.KEY",
                       "CommonName":null,
                       "InFolderHref":"/api/f/INSTANCE.KEY",
                       "InFolderKey":"INSTANCE.KEY",
                       "Links":
                       [
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"Meta",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"meta",
                                   "Text":"Metadata"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"Monikers",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"monikers",
                                   "Text":"Monikers"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"CommonName",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"commonname",
                                   "Text":"Common Name"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"Images",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"images",
                                   "Text":"Images"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"TakeOwnership",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"takeownership",
                                   "Text":"Take Ownership"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"Connections",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"connections",
                                   "Text":"Connected Objects"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"References",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"references",
                                   "Text":"Referencing Objects"
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"Notes",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"notes",
                                   "Text":"Notes"
                               }
                           }
                       ],
                       "ObjectLinks":
                       [
                           {
                               "$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
                               "Href":null,
                               "LinkedObjectKey":"INSTANCE.KEY",
                               "CommonName":"INSTANCE_NAME",
                               "Relation":"InInstance",
                               "MetaDataBson":
                               {
                                   "$type":"System.Byte[], mscorlib",
                                   "$value":""
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
                               "Href":null,
                               "LinkedObjectKey":"INSTANCE.KEY",
                               "CommonName":"INSTANCE_NAME",
                               "Relation":"InstanceScope",
                               "MetaDataBson":
                               {
                                   "$type":"System.Byte[], mscorlib",
                                   "$value":""
                               }
                           }
                       ],
                       "Metadata":[],
                       "Notes":[],
                       "Tags":[],
                       "Monikers":[],
                       "Href":null
                   }'