Represents an Acre intrusion detection panel controller
Overview of AcreIntrusionPanelInfo goes here.
Item -> BaseInfo -> ControllerInfo -> AcreIntrusionPanelInfo
| 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. |
| IsDisabled | Boolean | ControllerInfo | Indicates that the controller is disabled. All connection attempts should be refused if true, and connected controllers should be disconnected when change to true is detected. |
| LastPing | Nullable<DateTime> | ControllerInfo | Date and time of the last communication with the communication service (UTC). This property can be used to check if the last online status is valid or not. |
| LastUpdatedOn | Nullable<DateTime> | ControllerInfo | Gets or sets the date and time (UTC) when the controller was last updated. |
| MacAddress | String | ControllerInfo | The Mac Address of the controller, expected format 00:00:00:00:00:00. Must be unique across Database. All controllers are assumed to be IP devices, that will identify to the comm system using their MacAddress. |
| Status | ControllerStatusItem | ControllerInfo | Controller Status as set by the Communications Service |
| TimeZone | String | ControllerInfo | String representation of the timezone the controller is in, set according to POSIX.1 TZ standards. For example: EST5EDT,M3.2.0/2,M11.1.0/2 Use a 3 letter Abbreviation for the Standard Time and daylight saving time, plus the hours difference from UTC. |
| Version | String | ControllerInfo | Major Minor Build number of the firmware as reported by the controller |
| EncIV | Byte[] | AcreIntrusionPanelInfo | Gets or sets the encrypted initialization vector for encryption |
| EncKeyBin | Byte[] | AcreIntrusionPanelInfo | Gets or sets the encrypted encryption key (binary format) |
| LastEvent | Nullable<DateTime> | AcreIntrusionPanelInfo | Gets or sets the timestamp of the last event received from the panel |
| LastNetworkEvent | Nullable<DateTime> | AcreIntrusionPanelInfo | Gets or sets the timestamp of the last network event from the panel |
| LastPoll | Nullable<DateTime> | AcreIntrusionPanelInfo | Gets or sets the last time the panel was polled for data |
| Password | String | AcreIntrusionPanelInfo | Gets or sets the password for panel authentication |
| ProductTitle | String | AcreIntrusionPanelInfo | Gets or sets the product title/model of the intrusion panel |
| SerialNumber | String | AcreIntrusionPanelInfo | Gets or sets the serial number of the intrusion panel |
| SessionId | Int32 | AcreIntrusionPanelInfo | Gets or sets the current session ID for the connection to the panel |
| UserName | String | AcreIntrusionPanelInfo | Gets or sets the username for panel authentication |
{
"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[]",
"IsDisabled" : "Boolean",
"LastPing" : "Nullable\<DateTime\>",
"LastUpdatedOn" : "Nullable\<DateTime\>",
"MacAddress" : "String",
"Status" : "[ControllerStatusItem](/object-model/controllerstatusitem)",
"TimeZone" : "String",
"Version" : "String",
"EncIV" : "Byte[]",
"EncKeyBin" : "Byte[]",
"LastEvent" : "Nullable\<DateTime\>",
"LastNetworkEvent" : "Nullable\<DateTime\>",
"LastPoll" : "Nullable\<DateTime\>",
"Password" : "String",
"ProductTitle" : "String",
"SerialNumber" : "String",
"SessionId" : "Int32",
"UserName" : "String"
}
Example in C#
// Returns: AcreIntrusionPanelInfo
var acreIntrusionPanelInfo = await client.AddAcreIntrusionPanelAsync(FolderInfo folder, AcreIntrusionPanelInfo acreIntrusionPanel);
Example in CURL
curl -X POST \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/acreintrusionpanels \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '{
"$type":"Feenics.Keep.WebApi.Model.AcreIntrusionPanelInfo, Feenics.Keep.WebApi.Model",
"CommonName":"AcreIntrusionPanel_for_cURL",
"RegistrationId":"REG123",
"SessionId":1
}'
Example in C#
// Returns: nothing
await client.DeleteAcreIntrusionPanelAsync(AcreIntrusionPanelInfo acreIntrusionPanel);
Example in CURL
curl -X DELETE \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/acreintrusionpanels/PANEL.KEY \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: AcreIntrusionPanelInfo
var acreIntrusionPanelInfo = await client.GetAcreIntrusionPanelByRegistrationIdAsync(FolderInfo folder, String RegistrationId);
Example in CURL
curl -X GET \
'https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/acreintrusionpanels?RegistrationId=REG_ID' \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: AcreIntrusionPanelInfo
var acreIntrusionPanelInfo = await client.GetAcreIntrusionPanelBySessionIdAsync(FolderInfo folder, Int32 SessionId);
Example in CURL
curl -X GET \
'https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/acreintrusionpanels?SessionId=123' \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: IEnumerable<AcreIntrusionPanelInfo>
var acreIntrusionPanelInfo = await client.GetAcreIntrusionPanelsAsync(FolderInfo folder);
Example in CURL
curl -X GET \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/acreintrusionpanels \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: nothing
await client.UpdateAcreIntrusionPanelAsync(AcreIntrusionPanelInfo acreIntrusionPanel);
Example in CURL
curl -X PUT \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/acreintrusionpanels/PANEL.KEY \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '{
"$type":"Feenics.Keep.WebApi.Model.AcreIntrusionPanelInfo, Feenics.Keep.WebApi.Model",
"Key":"PANEL.KEY",
"CommonName":"Updated_Panel",
"RegistrationId":"REG123"
}'
Example in C#
// Returns: nothing
await client.UpdateAcreIntrusionPanelLastEventAsync(AcreIntrusionPanelInfo acreIntrusionPanel);
Example in CURL
curl -X PUT \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/acreintrusionpanels/PANEL.KEY/lastevent \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '""'
Example in C#
// Returns: nothing
await client.UpdateAcreIntrusionPanelLastNetworkEventAsync(AcreIntrusionPanelInfo acreIntrusionPanel);
Example in CURL
curl -X PUT \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/acreintrusionpanels/PANEL.KEY/lastnetworkevent \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '""'
Example in C#
// Returns: nothing
await client.UpdateAcreIntrusionPanelLastPollAsync(AcreIntrusionPanelInfo acreIntrusionPanel);
Example in CURL
curl -X PUT \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/acreintrusionpanels/PANEL.KEY/lastpoll \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '""'
Example in C#
// Returns: nothing
await client.UpdateAcreIntrusionPanelStatusAsync(AcreIntrusionPanelInfo acreIntrusionPanel, ControllerStatusItem Status);
Example in CURL
curl -X PUT \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/acreintrusionpanels/PANEL.KEY/status \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '{
"$type":"Feenics.Keep.WebApi.Model.ControllerStatusItem, Feenics.Keep.WebApi.Model",
"StatusCode":1,
"Message":"Panel Online"
}'