This is the class that represents an Engage reader for a EngageDeviceInfo .
The engage reader is what identifies a card read.
Item -> BaseInfo -> EngageDeviceInfo -> EngageReaderInfo
| 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. |
| DeviceReference | String | EngageDeviceInfo | The Device Reference |
| DeviceType | String | EngageDeviceInfo | The type of EngageDevice |
| LastUpdatedOn | Nullable<DateTime> | EngageDeviceInfo | the Last time the device was updated (UTC) |
| SerialNumberLong | String | EngageDeviceInfo | The Long Serial Number value |
| SerialNumberShort | String | EngageDeviceInfo | The Short Serial Number value |
| Timestamp | String | EngageDeviceInfo | The Timestamp |
| Timezone | String | EngageDeviceInfo | The Timezone of the device in posix format (“EST5EDT,M3.2.0/2,M11.1.0/2” for Eastern Standard Time) |
| Version | String | EngageDeviceInfo | The device version |
| AdaDelay | Int32 | EngageReaderInfo | Gets or sets the ADA (Americans with Disabilities Act) door unlock delay in seconds |
| AntiTailgateEnabled | Boolean | EngageReaderInfo | Gets or sets whether anti-tailgate feature is enabled |
| AutoUnlockSchedules | AutoUnlockScheduleItem[] | EngageReaderInfo | Gets or sets the auto-unlock schedules for automatic passage/secure modes |
| BacklightTimeout | Int32 | EngageReaderInfo | Gets or sets the backlight timeout in seconds |
| BatteryFailState | Failures | EngageReaderInfo | Gets or sets the failure mode when battery fails (AsIs, Sec, or Safe) |
| BeeperEnabled | Boolean | EngageReaderInfo | Gets or sets whether the beeper/buzzer is enabled |
| BlinkLEDWhenLocked | Boolean | EngageReaderInfo | Gets or sets whether LED blinks when lock is locked |
| CentralDecisionTimeout | Int32 | EngageReaderInfo | Gets or sets the central decision timeout in seconds |
| Code | Int32 | EngageReaderInfo | Gets or sets the keypad code |
| CredentialSectorNumber | Int32 | EngageReaderInfo | Gets or sets the credential sector number for smart card credentials |
| DaylightSavingTimeEnabled | Boolean | EngageReaderInfo | Gets or sets whether daylight saving time adjustments are enabled |
| DogOnNextExit | Boolean | EngageReaderInfo | Gets or sets whether door opens on next exit (dogging feature) |
| DoorPropDelay | Int32 | EngageReaderInfo | Gets or sets the door prop delay in seconds before alarm |
| DoorPropEnabled | Boolean | EngageReaderInfo | Gets or sets whether door prop alarm is enabled |
| DPSAuditsEnabled | Boolean | EngageReaderInfo | Gets or sets whether DPS (Data Privacy Service) audits are enabled |
| DstEnd | String | EngageReaderInfo | Gets or sets the daylight saving time end date/time |
| DstStart | String | EngageReaderInfo | Gets or sets the daylight saving time start date/time |
| EngageLockType | EngageLockTypes | EngageReaderInfo | Gets or sets the Engage lock type (SC, NDE, or LE) |
| FirmwareAddress | String | EngageReaderInfo | Gets or sets the firmware update URL address |
| FirmwareDownloadTime | DateTime | EngageReaderInfo | Gets or sets the scheduled firmware download time |
| FirmwareImplementUpdateTime | DateTime | EngageReaderInfo | Gets or sets the scheduled firmware implementation/update time |
| FirstManInEnabled | Boolean | EngageReaderInfo | Gets or sets whether first man in/arming feature is enabled |
| GatewayCommFailure | Failures | EngageReaderInfo | Gets or sets the failure mode when gateway communication fails (AsIs, Sec, or Safe) |
| GroupIds | Int32[] | EngageReaderInfo | Gets or sets the array of group identifiers associated with this reader |
| IClassFormat | Boolean | EngageReaderInfo | Gets or sets whether iClass format is used |
| ImmediateWiFiAlertEnabled | String | EngageReaderInfo | Gets or sets whether immediate WiFi alerts are enabled |
| IndividualWiFiImmediateAlertSelection | String[] | EngageReaderInfo | Gets or sets the individual WiFi immediate alert selections |
| InvalidCardAuditEnabled | Boolean | EngageReaderInfo | Gets or sets whether invalid card attempts are audited |
| IPBAuditEnabled | Boolean | EngageReaderInfo | Gets or sets whether IP bridge auditing is enabled |
| JaguarSectors | Int32 | EngageReaderInfo | Gets or sets the Jaguar sectors configuration |
| KeypadFacility | Int32 | EngageReaderInfo | Gets or sets the keypad facility code |
| KeypadOutputFormat | KeypadOutputFormats | EngageReaderInfo | Gets or sets the keypad output format |
| KeysToBuffer | Int32 | EngageReaderInfo | Gets or sets the number of keys to buffer |
| KeystrokeTimeout | Int32 | EngageReaderInfo | Gets or sets the keystroke timeout in seconds |
| LinkId | String | EngageReaderInfo | Gets or sets the link identifier for this reader |
| LockId | Int32 | EngageReaderInfo | Gets or sets the lock identifier |
| MagCardLowPowerEnabled | Boolean | EngageReaderInfo | Gets or sets whether low power mode is enabled for magnetic card reader |
| MagCardTrack1Enabled | Boolean | EngageReaderInfo | Gets or sets whether magnetic card track 1 reading is enabled |
| MagCardTrack2Enabled | Boolean | EngageReaderInfo | Gets or sets whether magnetic card track 2 reading is enabled |
| MagCardTrack3Enabled | Boolean | EngageReaderInfo | Gets or sets whether magnetic card track 3 reading is enabled |
| PinEnabled | Boolean | EngageReaderInfo | Gets or sets whether PIN entry is enabled |
| PinLength | Int32 | EngageReaderInfo | Gets or sets the PIN length required |
| PIVConfig | PivConfigs | EngageReaderInfo | Gets or sets the PIV (Personal Identity Verification) configuration |
| PrivacyRapidBlick | Boolean | EngageReaderInfo | Gets or sets whether privacy rapid blink is enabled |
| ProxConfigAWID | Boolean | EngageReaderInfo | Gets or sets whether AWID prox configuration is enabled |
| ProxConfigGE4001 | Boolean | EngageReaderInfo | Gets or sets whether GE 4001 prox configuration is enabled |
| ProxConfigGE4002 | Boolean | EngageReaderInfo | Gets or sets whether GE 4002 prox configuration is enabled |
| ProxConfigGECASCI | Boolean | EngageReaderInfo | Gets or sets whether GE CASCI prox configuration is enabled |
| ProxConfigHID | Boolean | EngageReaderInfo | Gets or sets whether HID prox configuration is enabled |
| ReaderHolidays | EngageReaderHolidayItem[] | EngageReaderInfo | Gets or sets the holiday schedules for this reader |
| ReaderSensitivity | ReaderSensitivities | EngageReaderInfo | Gets or sets the reader sensitivity level (Normal, High, or Max) |
| Relock | Int32 | EngageReaderInfo | Gets or sets the relock timeout in seconds |
| ScheduleDurations | EngageScheduleDurationItem[] | EngageReaderInfo | Gets or sets the schedule durations for time-based access control |
| SmartCard14443MiFare | Boolean | EngageReaderInfo | Gets or sets whether MIFARE smart card reading is enabled |
| SmartCard14443MiFarePlus | Boolean | EngageReaderInfo | Gets or sets whether MIFARE Plus smart card reading is enabled |
| SmartCard14443NOC | Boolean | EngageReaderInfo | Gets or sets whether NOC (Nexus One Card) smart card reading is enabled |
| SmartCard14443UID | Boolean | EngageReaderInfo | Gets or sets whether ISO 14443 UID smart card reading is enabled |
| SmartCard15693IClassSE | Boolean | EngageReaderInfo | Gets or sets whether ISO 15693 iClass SE smart card reading is enabled |
| SmartCard15693UID | Boolean | EngageReaderInfo | Gets or sets whether ISO 15693 UID smart card reading is enabled |
| SmartCardIClassUID | Boolean | EngageReaderInfo | Gets or sets whether iClass UID smart card reading is enabled |
| Status | EngageReaderStatusItem | EngageReaderInfo | Gets or sets the Status value |
| TamperFailure | Failures | EngageReaderInfo | Gets or sets the failure mode when tamper is detected (AsIs, Sec, or Safe) |
| Type | LockOperationTypes | EngageReaderInfo | Gets or sets the lock operation type (StoreRoom, ClassRoom, Office, Dorm, Apartment, or Privacy) |
{
"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[]",
"DeviceReference" : "String",
"DeviceType" : "String",
"LastUpdatedOn" : "Nullable\<DateTime\>",
"SerialNumberLong" : "String",
"SerialNumberShort" : "String",
"Timestamp" : "String",
"Timezone" : "String",
"Version" : "String",
"AdaDelay" : "Int32",
"AntiTailgateEnabled" : "Boolean",
"AutoUnlockSchedules" : "[AutoUnlockScheduleItem](/object-model/autounlockscheduleitem)[]",
"BacklightTimeout" : "Int32",
"BatteryFailState" : "[Failures](/object-model/failures)",
"BeeperEnabled" : "Boolean",
"BlinkLEDWhenLocked" : "Boolean",
"CentralDecisionTimeout" : "Int32",
"Code" : "Int32",
"CredentialSectorNumber" : "Int32",
"DaylightSavingTimeEnabled" : "Boolean",
"DogOnNextExit" : "Boolean",
"DoorPropDelay" : "Int32",
"DoorPropEnabled" : "Boolean",
"DPSAuditsEnabled" : "Boolean",
"DstEnd" : "String",
"DstStart" : "String",
"EngageLockType" : "[EngageLockTypes](/object-model/engagelocktypes)",
"FirmwareAddress" : "String",
"FirmwareDownloadTime" : "DateTime",
"FirmwareImplementUpdateTime" : "DateTime",
"FirstManInEnabled" : "Boolean",
"GatewayCommFailure" : "[Failures](/object-model/failures)",
"GroupIds" : "Int32[]",
"IClassFormat" : "Boolean",
"ImmediateWiFiAlertEnabled" : "String",
"IndividualWiFiImmediateAlertSelection" : "String[]",
"InvalidCardAuditEnabled" : "Boolean",
"IPBAuditEnabled" : "Boolean",
"JaguarSectors" : "Int32",
"KeypadFacility" : "Int32",
"KeypadOutputFormat" : "[KeypadOutputFormats](/object-model/keypadoutputformats)",
"KeysToBuffer" : "Int32",
"KeystrokeTimeout" : "Int32",
"LinkId" : "String",
"LockId" : "Int32",
"MagCardLowPowerEnabled" : "Boolean",
"MagCardTrack1Enabled" : "Boolean",
"MagCardTrack2Enabled" : "Boolean",
"MagCardTrack3Enabled" : "Boolean",
"PinEnabled" : "Boolean",
"PinLength" : "Int32",
"PIVConfig" : "[PivConfigs](/object-model/pivconfigs)",
"PrivacyRapidBlick" : "Boolean",
"ProxConfigAWID" : "Boolean",
"ProxConfigGE4001" : "Boolean",
"ProxConfigGE4002" : "Boolean",
"ProxConfigGECASCI" : "Boolean",
"ProxConfigHID" : "Boolean",
"ReaderHolidays" : "[EngageReaderHolidayItem](/object-model/engagereaderholidayitem)[]",
"ReaderSensitivity" : "[ReaderSensitivities](/object-model/readersensitivities)",
"Relock" : "Int32",
"ScheduleDurations" : "[EngageScheduleDurationItem](/object-model/engagescheduledurationitem)[]",
"SmartCard14443MiFare" : "Boolean",
"SmartCard14443MiFarePlus" : "Boolean",
"SmartCard14443NOC" : "Boolean",
"SmartCard14443UID" : "Boolean",
"SmartCard15693IClassSE" : "Boolean",
"SmartCard15693UID" : "Boolean",
"SmartCardIClassUID" : "Boolean",
"Status" : "[EngageReaderStatusItem](/object-model/engagereaderstatusitem)",
"TamperFailure" : "[Failures](/object-model/failures)",
"Type" : "[LockOperationTypes](/object-model/lockoperationtypes)"
}
Example in C#
// Returns: EngageReaderInfo
var engageReaderInfo = await client.AddEngageReaderAsync(FolderInfo folder, EngageReaderInfo item);
Example in CURL
curl -X POST \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/engagereaders \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '{
"$type":"Feenics.Keep.WebApi.Model.EngageReaderInfo, Feenics.Keep.WebApi.Model",
"LinkId":null,
"EngageLockType":0,
"Type":0,
"Relock":0,
"CentralDecisionTimeout":0,
"CredentialSectorNumber":0,
"JaguarSectors":0,
"LockId":0,
"GroupIds":null,
"DoorPropDelay":0,
"DoorPropEnabled":false,
"AdaDelay":0,
"FirstManInEnabled":false,
"DogOnNextExit":false,
"BatteryFailState":0,
"BlinkLEDWhenLocked":false,
"PrivacyRapidBlick":false,
"IPBAuditEnabled":false,
"DaylightSavingTimeEnabled":false,
"DstStart":null,
"DstEnd":null,
"ImmediateWiFiAlertEnabled":null,
"IndividualWiFiImmediateAlertSelection":null,
"FirmwareAddress":null,
"FirmwareDownloadTime":"0001-01-01T00:00:00",
"FirmwareImplementUpdateTime":"0001-01-01T00:00:00",
"DPSAuditsEnabled":false,
"BeeperEnabled":false,
"ReaderSensitivity":0,
"ProxConfigHID":false,
"ProxConfigGECASCI":false,
"ProxConfigGE4001":false,
"ProxConfigGE4002":false,
"ProxConfigAWID":false,
"SmartCard14443UID":false,
"SmartCard14443MiFare":false,
"SmartCard14443MiFarePlus":false,
"SmartCard14443NOC":false,
"SmartCard15693IClassSE":false,
"SmartCard15693UID":false,
"SmartCardIClassUID":false,
"PIVConfig":0,
"IClassFormat":false,
"MagCardTrack1Enabled":false,
"MagCardTrack2Enabled":false,
"MagCardTrack3Enabled":false,
"MagCardLowPowerEnabled":false,
"BacklightTimeout":0,
"KeypadOutputFormat":0,
"KeypadFacility":0,
"Code":0,
"KeysToBuffer":0,
"KeystrokeTimeout":0,
"PinLength":0,
"PinEnabled":false,
"AntiTailgateEnabled":false,
"GatewayCommFailure":0,
"TamperFailure":0,
"InvalidCardAuditEnabled":false,
"ScheduleDurations":null,
"AutoUnlockSchedules":null,
"ReaderHolidays":null,
"Status":null,
"DeviceType":null,
"SerialNumberShort":null,
"SerialNumberLong":null,
"DeviceReference":null,
"Timestamp":null,
"Timezone":null,
"LastUpdatedOn":null,
"Version":null,
"Key":null,
"CommonName":"EngageReader_for_cURL",
"InFolderHref":null,
"InFolderKey":null,
"Links":[],
"ObjectLinks":null,
"Metadata":null,
"Notes":null,
"Tags":null,
"Monikers":null,
"Href":null
}'
Example in C#
// Returns: nothing
await client.DeleteEngageReaderAsync(EngageReaderInfo item);
Example in CURL
curl -X DELETE \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/engagereaders/ENGAGEREADER.KEY \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: IEnumerable<EngageReaderInfo>
var engageReaderInfo = await client.GetEngageReadersAsync(FolderInfo folder);
Example in CURL
curl -X GET \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/engagereaders \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: nothing
await client.UpdateEngageReaderAsync(EngageReaderInfo item);
Example in CURL
curl -X PUT \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/engagereaders/ENGAGEREADER.KEY \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-d '{
"$type":"Feenics.Keep.WebApi.Model.EngageReaderInfo, Feenics.Keep.WebApi.Model",
"LinkId":null,
"EngageLockType":0,
"Type":0,
"Relock":0,
"CentralDecisionTimeout":0,
"CredentialSectorNumber":0,
"JaguarSectors":0,
"LockId":0,
"GroupIds":[],
"DoorPropDelay":0,
"DoorPropEnabled":false,
"AdaDelay":0,
"FirstManInEnabled":false,
"DogOnNextExit":false,
"BatteryFailState":0,
"BlinkLEDWhenLocked":false,
"PrivacyRapidBlick":false,
"IPBAuditEnabled":false,
"DaylightSavingTimeEnabled":false,
"DstStart":null,
"DstEnd":null,
"ImmediateWiFiAlertEnabled":null,
"IndividualWiFiImmediateAlertSelection":[],
"FirmwareAddress":null,
"FirmwareDownloadTime":"0001-01-01T00:00:00",
"FirmwareImplementUpdateTime":"0001-01-01T00:00:00",
"DPSAuditsEnabled":false,
"BeeperEnabled":false,
"ReaderSensitivity":0,
"ProxConfigHID":false,
"ProxConfigGECASCI":false,
"ProxConfigGE4001":false,
"ProxConfigGE4002":false,
"ProxConfigAWID":false,
"SmartCard14443UID":false,
"SmartCard14443MiFare":false,
"SmartCard14443MiFarePlus":false,
"SmartCard14443NOC":false,
"SmartCard15693IClassSE":false,
"SmartCard15693UID":false,
"SmartCardIClassUID":false,
"PIVConfig":0,
"IClassFormat":false,
"MagCardTrack1Enabled":false,
"MagCardTrack2Enabled":false,
"MagCardTrack3Enabled":false,
"MagCardLowPowerEnabled":false,
"BacklightTimeout":0,
"KeypadOutputFormat":0,
"KeypadFacility":0,
"Code":0,
"KeysToBuffer":0,
"KeystrokeTimeout":0,
"PinLength":0,
"PinEnabled":false,
"AntiTailgateEnabled":false,
"GatewayCommFailure":0,
"TamperFailure":0,
"InvalidCardAuditEnabled":false,
"ScheduleDurations":[null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null],
"AutoUnlockSchedules":[null,null,null,null,null,null,null,null,null,null,null,null,null,null,null,null],
"ReaderHolidays":[],
"Status":null,
"DeviceType":null,
"SerialNumberShort":null,
"SerialNumberLong":null,
"DeviceReference":null,
"Timestamp":null,
"Timezone":null,
"LastUpdatedOn":null,
"Version":null,
"Key":"ENGAGEREADER.KEY",
"CommonName":"EngageReader_for_cURL",
"InFolderHref":"/api/f/INSTANCE.KEY",
"InFolderKey":"INSTANCE.KEY",
"Links":
[
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Schedules",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"schedules",
"Text":"Schedules"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"AutoUnlockSchedules",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"autounlockschedules","Text":"Auto Unlock Schedules"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"EngageReaderHolidays",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"readerholidays",
"Text":"Engage Reader Holidays"
}
},
{
"$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":"LinkId",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"linkid",
"Text":"LInk ID"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"LastUpdatedOn",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"lastupdatedon",
"Text":"Last Updated On"
}
},
{
"$type":"Feenics.Keep.WebApi.Model.Link, Feenics.Keep.WebApi.Model",
"Relation":"Version",
"Anchor":
{
"$type":"Feenics.Keep.WebApi.Model.Anchor, Feenics.Keep.WebApi.Model",
"Href":"version",
"Text":"Version"
}
},
{
"$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":"/api/f/INSTANCE.KEY/engagereaders/ENGAGEREADER.KEY"
}'
Example in C#
// Returns: nothing
await client.UpdateEngageReaderLinkIdAsync(EngageReaderInfo reader, String linkId);
Example in CURL
curl -X PUT \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/engagereaders/ENGAGEREADERS/linkid \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '"THE_LINK_ID"'
Example in C#
// Returns: nothing
await client.UpdateEngageReaderStatusAsync(EngageReaderInfo reader, EngageReaderStatusItem status);
Example in CURL
curl -X PUT \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/engagereaders/ENGAGEREADERS.KEY/status \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d ENGAGEREADER.STATUSITEM
Example in C#
// Returns: EngageReaderInfo
var engageReaderInfo = await client.UpdateEngageReadeScheduleAsync(EngageReaderInfo reader, Int32 index, EngageScheduleDurationItem scheduleItem);
Example in CURL
curl -X PUT \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/engagereaders/ENGAGEREADER.KEY/schedules/0 \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '{
"$type":"Feenics.Keep.WebApi.Model.EngageScheduleDurationItem, Feenics.Keep.WebApi.Model",
"DayMask":7, #0000111 -> the day mask works the same in this schedule as the one used for Mercury Controllers
"StartingAt":"00:00:00",
"EndingAtMinutes":0
}'