ReaderInfo

Represents a reader peripheral in the access control system

Overview of ReaderInfo goes here.

ReaderInfo Properties

Item -> BaseInfo -> PeripheralInfo -> ReaderInfo

ReaderInfo -> AscendReaderInfo -> AscReaderInfo -> AssaAbloyLockInfo -> IsonasReaderInfo -> iStarReaderInfo -> SafrReaderInfo

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.

JSON Structure of ReaderInfo

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

Add Reader Async

Example in C#

// Returns: ReaderInfo
var readerInfo = await client.AddReaderAsync(FolderInfo folder, ReaderInfo item);

Example in CURL



           curl -X POST \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/readers \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '{
                   "$type": "Feenics.Keep.WebApi.Model.ReaderInfo, Feenics.Keep.WebApi.Model",
                   "CommonName": "Main Entrance Reader",
                   "InFolderKey": "INSTANCE.KEY"
               }'

Add Reader To Local Area Async

Example in C#

// Returns: nothing
await client.AddReaderToLocalAreaAsync(LocalAreaInfo localArea, MercuryReaderInfo reader, LocalAreaReaderDirections direction);

Example in CURL



           curl -X PUT \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/controllers/CONTROLLER.KEY/localareas/LOCALAREA.KEY/readers?direction=In \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '"/api/f/INSTANCE.KEY/peripherals/READER.KEY"'

Change Reader Type Async

Example in C#

// Returns: nothing
await client.ChangeReaderTypeAsync(MercuryReaderInfo reader, String newType);

Example in CURL



           curl -X PUT \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/readers/READER.KEY/type \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '"NewReaderType"'

Delete Reader Async

Example in C#

// Returns: nothing
await client.DeleteReaderAsync(ReaderInfo item);

Example in CURL



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

Get Readers Async

Example in C#

// Returns: IEnumerable<ReaderInfo>
var readerInfo = await client.GetReadersAsync(FolderInfo folder);

Example in CURL



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

Remove Reader From Local Area Async

Example in C#

// Returns: nothing
await client.RemoveReaderFromLocalAreaAsync(LocalAreaInfo localArea, ObjectLinkItem readerLink);

Example in CURL



           curl -X DELETE \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/controllers/CONTROLLER.KEY/localareas/LOCALAREA.KEY/readers/READER.KEY \
               -H 'Authorization: Bearer TOKEN_GOES_HERE'

Set Version For Reader Async

Example in C#

// Returns: nothing
await client.SetVersionForReaderAsync(MercuryReaderInfo reader, String version);

Example in CURL


 
           curl -X PUT \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/peripherals/READER.KEY/version
               -H 'Authorization: Bearer TOKEN_GOES_HERE'
               -d "VERSION"

Update Reader Async

Example in C#

// Returns: nothing
await client.UpdateReaderAsync(ReaderInfo item);

Example in CURL



           curl -X PUT \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/readers/READER.KEY \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '{
                   "$type": "Feenics.Keep.WebApi.Model.ReaderInfo, Feenics.Keep.WebApi.Model",
                   "Key": "READER.KEY",
                   "CommonName": "Updated Reader Name",
                   "InFolderKey": "INSTANCE.KEY"
               }'

Update Reader Status Async

Example in C#

// Returns: nothing
await client.UpdateReaderStatusAsync(AssaAbloyIPLockInfo reader, AssaAbloyIPLockStatusItem status);

Example in CURL



           curl -X PUT \
               https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/readers/READER.KEY/status \
               -H 'Authorization: Bearer TOKEN_GOES_HERE' \
               -H 'Content-Type: application/json' \
               -d '{
                       "$type":"Feenics.Keep.WebApi.Model.AssaAbloyIPLockStatusItem, Feenics.Keep.WebApi.Model"
                   }'