AssaAbloyIPLockModeInfo

Represents an ASSA ABLOY IP lock mode configuration defining lock behavior (unlock, first person through, credential requirements) on a schedule. An IPLockMode is the glue that connects a AssaAbloyIPLockModeType , a ScheduleInfo and an AssaAbloyIPLockInfo . If a FirstPersonThrough and an Unlock mode overlap in schedule, the access point will unlock. If any AccessMode* modes overlap in schedule, results are unpredictable. (Excluding the default access mode configured by the AccessMode property of AssaAbloyIPLockInfo ) Expected ObjectLinks: Link to 1 Schedule with Relation “Schedule”, Linked to by 0-* AssaAbloyIPLocks with Relation “AssaAbloyIPLockMode”

Overview of AssaAbloyIPLockModeInfo goes here.

AssaAbloyIPLockModeInfo Properties

Item -> BaseInfo -> AssaAbloyIPLockModeInfo

AssaAbloyIPLockModeInfo -> LocalAssaAbloyIPLockModeInfo

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.
IPLockModeType AssaAbloyIPLockModeType AssaAbloyIPLockModeInfo Gets or sets the IPLockModeType value

JSON Structure of AssaAbloyIPLockModeInfo

{
   "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[]",
   "IPLockModeType"	:	"[AssaAbloyIPLockModeType](/object-model/assaabloyiplockmodetype)"
}

Add Assa Abloy IPLock Mode Async

Example in C#

// Returns: AssaAbloyIPLockModeInfo
var assaAbloyIPLockModeInfo = await client.AddAssaAbloyIPLockModeAsync(FolderInfo folder, ScheduleInfo schedule, AssaAbloyIPLockModeInfo item);

Example in CURL



           curl -X POST \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/assaabloyiplockmodes?scheduleId=SCHEDULE.KEY \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '{
                   "$type":"Feenics.Keep.WebApi.Model.AssaAbloyIPLockModeInfo, Feenics.Keep.WebApi.Model",
                   "IPLockModeType":0,
                   "Key":null,
                   "CommonName":"Example_for_cURL",
                   "InFolderHref":null,
                   "InFolderKey":null,
                   "Links":[],
                   "ObjectLinks":null,
                   "Metadata":null,
                   "Notes":null,
                   "Tags":null,
                   "Monikers":null,
                   "Href":null
              }'

Delete Assa Abloy IPLock Mode Async

Example in C#

// Returns: nothing
await client.DeleteAssaAbloyIPLockModeAsync(AssaAbloyIPLockModeInfo item);

Example in CURL



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

Get Assa Abloy IPLock Modes Async

Example in C#

// Returns: IEnumerable<AssaAbloyIPLockModeInfo>
var assaAbloyIPLockModeInfo = await client.GetAssaAbloyIPLockModesAsync(FolderInfo folder);

Example in CURL



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

Get Assa Abloy IPLock Modes For IPLock Async

Example in C#

// Returns: IEnumerable<AssaAbloyIPLockModeInfo>
var assaAbloyIPLockModeInfo = await client.GetAssaAbloyIPLockModesForIPLockAsync(AssaAbloyIPLockInfo item);

Example in CURL



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

Remove Assa Abloy IPLock Mode From IPLock Async

Example in C#

// Returns: nothing
await client.RemoveAssaAbloyIPLockModeFromIPLockAsync(AssaAbloyIPLockInfo item, AssaAbloyIPLockModeInfo mode);

Example in CURL



           curl -X DELETE \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/readers2/READER2.KEY/assaabloyiplockmodes/ASSAABLOYIPLOCKMODE.KEY \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'

Set Assa Abloy IPLock Mode For IPLock Async

Example in C#

// Returns: nothing
await client.SetAssaAbloyIPLockModeForIPLockAsync(AssaAbloyIPLockInfo item, AssaAbloyIPLockModeInfo mode);

Example in CURL



           curl -X PUT \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/readers2/READER2.KEY/assaabloyiplockmodes \
               -H 'Content-Type: application/javascript' \
               -d '"/api/f/INSTANCE.KEY/assaabloyiplockmodes/ASSAABLOYIPLOCKMODE.KEY"'

Update Assa Abloy IPLock Mode Async

Example in C#

// Returns: nothing
await client.UpdateAssaAbloyIPLockModeAsync(AssaAbloyIPLockModeInfo item);

Example in CURL



           curl -X PUT \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/assaabloyiplockmodes/ASSAABLOYIPLOCKMODE.KEY \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '{
               "$type":"Feenics.Keep.WebApi.Model.AssaAbloyIPLockModeInfo, Feenics.Keep.WebApi.Model",
               "IPLockModeType":1,
               "Key":"ASSAABLOYIPLOCKMODE.KEY",
               "CommonName":"Example_for_cURL",
               "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":"SCHEDULE.KEY",
                       "CommonName":"ScheduleFor_cUrl",
                       "Relation":"Schedule",
                       "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":"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":"/api/f/INSTANCE.KEY/assaabloyiplockmodes/ASSAABLOYIPLOCKMODE.KEY"
               }'