PeripheralInfo

Base class of all Peripherals connected to a downstream interface

There are many different types of peripheral devices: Controllers, Downstreams, Readers, Inputs, and Outputs.

Readers are used to receive binary data from credentials in order allow Access Requests to be processed by Intelligent Controllers.

Inputs & Outputs are not only used to support contacts, rex, and strikes, but can be implemented to accomplish many tasks.

PeripheralInfo Properties

Item -> BaseInfo -> PeripheralInfo

PeripheralInfo -> MercuryPeripheralInfo

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

JSON Structure of PeripheralInfo

{
   "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[]"
}

Add Peripheral To Down Stream Async

Example in C#

// Returns: T
var item = await client.AddPeripheralToDownStreamAsync<T>(DownstreamInfo downstream, T item)

Example in CURL



           curl -X POST \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/controllers/CONTROLLER.KEY/downstream/DOWNSTREAM.KEY/peripherals \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -D '{
                       "$type":"Feenics.Keep.WebApi.Model.MercuryPeripheralInfo, Feenics.Keep.WebApi.Model",
                       "ControllerIndex":0,
                       "SioNumber":0,
                       "SioIndex":0,
                       "ControllerKey":null,
                       "ControllerCommonName":null,
                       "ControllerHref":null,
                       "Status":null,
                       "BacnetReadOnly":null,
                       "Key":null,
                       "CommonName":"PeripheralExampleFor_cUrl",
                       "InFolderHref":null,
                       "InFolderKey":null,
                       "Links":[],
                       "ObjectLinks":null,
                       "Metadata":null,
                       "Notes":null,
                       "Tags":null,
                       "Monikers":null,
                       "Href":null
                   }'
            

Add Peripheral To Reader Async

Example in C#

// Returns: PeripheralInfo
var peripheralInfo = await client.AddPeripheralToReaderAsync(MercuryReaderInfo reader, ReaderPeripheralTypes peripheralType, MercuryPeripheralInfo item)

Example in CURL



           curl -X POST \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/peripherals/Strike \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -D '{
                       "$type":"Feenics.Keep.WebApi.Model.MercuryPeripheralInfo, Feenics.Keep.WebApi.Model",
                       "ControllerIndex":0,
                       "SioNumber":0,
                       "SioIndex":0,
                       "ControllerKey":null,
                       "ControllerCommonName":null,
                       "ControllerHref":null,
                       "Status":null,
                       "BacnetReadOnly":null,
                       "Key":null,
                       "CommonName":"PeripheralExampleFor_cUrl",
                       "InFolderHref":null,
                       "InFolderKey":null,
                       "Links":[],
                       "ObjectLinks":null,
                       "Metadata":null,
                       "Notes":null,
                       "Tags":null,
                       "Monikers":null,
                       "Href":null
                   }'
            

Delete Peripheral Async

Example in C#

// Returns: nothing
await client.DeletePeripheralAsync(MercuryPeripheralInfo peripheral)

Example in CURL



           curl -X DELETE \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/peripherals/PERIPHERAL.KEY \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' 
            

Get Peripheral Of Reader Async

Example in C#

// Returns: PeripheralInfo
var peripheralInfo = await client.GetPeripheralOfReaderAsync(MercuryReaderInfo reader, ReaderPeripheralTypes peripheralType)

Example in CURL



           curl -X POST \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/peripherals/Strike \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -D '{
                       "$type":"Feenics.Keep.WebApi.Model.MercuryPeripheralInfo, Feenics.Keep.WebApi.Model",
                       "ControllerIndex":0,
                       "SioNumber":0,
                       "SioIndex":0,
                       "ControllerKey":null,
                       "ControllerCommonName":null,
                       "ControllerHref":null,
                       "Status":null,
                       "BacnetReadOnly":null,
                       "Key":null,
                       "CommonName":"PeripheralExampleFor_cUrl",
                       "InFolderHref":null,
                       "InFolderKey":null,
                       "Links":[],
                       "ObjectLinks":null,
                       "Metadata":null,
                       "Notes":null,
                       "Tags":null,
                       "Monikers":null,
                       "Href":null
                   }'
            

Get Peripherals For Controller Async

Example in C#

// Returns: IEnumerable<PeripheralInfo>
var peripheralInfo = await client.GetPeripheralsForControllerAsync(ControllerInfo controller)

Example in CURL



           curl -X GET \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/controllers/CONTROLLER.KEY/peripherals \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' 
            

Get Peripherals For Downstream Async

Example in C#

// Returns: IEnumerable<PeripheralInfo>
var peripheralInfo = await client.GetPeripheralsForDownstreamAsync(DownstreamInfo downstream)

Example in CURL



           curl -X GET \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/controllers/CONTROLLER.KEY/downstream/DOWNSTREAM.KEY/peripherals \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' 
            

Update Peripheral Async

Example in C#

// Returns: nothing
await client.UpdatePeripheralAsync(MercuryPeripheralInfo peripheral)

Example in CURL



           curl -X PUT \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/peripherals/PERIPHERAL.KEY \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -D '{
                       "$type":"Feenics.Keep.WebApi.Model.MercuryInputInfo, Feenics.Keep.WebApi.Model",
                       "LatchMode":0,
                       "EntryDelay":null,
                       "ExitDelay":null,
                       "Debounce":2,
                       "Behaviour":1,
                       "HoldTime":null,
                       "IsDisabled":false,
                       "ControllerIndex":0,
                       "SioNumber":0,
                       "SioIndex":1,
                       "ControllerKey":"CONTROLLER.KEY",
                       "ControllerCommonName":"CONTROLLER_NAME",
                       "ControllerHref":"/api/f/INSTANCE.KEY/controllers/CONTROLLER.KEY",
                       "Status":null,
                       "BacnetReadOnly":null,
                       "Key":"PERIPHERAL.KEY",
                       "CommonName":"REX for CONTROLLER_NAME",
                       "InFolderHref":"/api/f/INSTANCE.KEY",
                       "InFolderKey":"INSTANCE.KEY",
                       "Links":
                       [
                           {
                               "$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
                               "Relation":"Status",
                               "Anchor":
                               {
                                   "$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
                                   "Href":"status",
                                   "Text":"Status"
                               }
                           },
                           {
                               "$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":DOWNSTREAM.KEY",
                               "CommonName":"DOWNSTREAM_NAME",
                               "Relation":"Downstream",
                               "MetaDataBson":
                               {
                                   "$type":"System.Byte[], mscorlib",
                                   "$value":""
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
                               "Href":null,
                               "LinkedObjectKey":"CONTROLLER.KEY",
                               "CommonName":"CONTROLLER_NAME",
                               "Relation":"Controller",
                               "MetaDataBson":
                               {
                                   "$type":"System.Byte[], mscorlib",
                                   "$value":""
                               }
                           },
                           {
                               "$type":"Feenics.Keep.WebApi.Model.ObjectLinkItem, Feenics.Keep.WebApi.Model",
                               "Href":null,
                               "LinkedObjectKey":"READER.KEY",
                               "CommonName":"READER_NAME",
                               "Relation":"Reader",
                               "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/peripherals/PERIPHERALS.KEY"
                   }'
            

Update Peripheral Status Async

Example in C#

// Returns: nothing
await client.UpdatePeripheralStatusAsync(MercuryPeripheralInfo peripheral, PeripheralStatusItem status)

Example in CURL



           curl -X PUT \
               https://keepapi.feenicshosting.com/api/f/INSTANCE.KEY/peripherals/Status \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -D '{"$type":"Feenics.Keep.WebApi.Model.PeripheralStatusItem, Feenics.Keep.WebApi.Model"}'