Represents an input peripheral (sensor, contact, etc.) in the access control system
Overview of InputInfo goes here.
Item -> BaseInfo -> PeripheralInfo -> InputInfo
InputInfo -> AscInputInfo -> iStarInputInfo -> SafrInputInfo
| 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. |
{
"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[]"
}
Example in C#
// Returns: InputInfo
var inputInfo = await client.AddInputAsync(FolderInfo folder, InputInfo item);
Example in CURL
curl -X POST \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/inputs \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '{
"$type": "Feenics.Keep.WebApi.Model.InputInfo, Feenics.Keep.WebApi.Model",
"CommonName": "Lobby Motion Sensor",
"InFolderKey": "INSTANCE.KEY"
}'
Example in C#
// Returns: InputScannerInfo
var inputScannerInfo = await client.AddInputScannerAsync(FolderInfo folder, InputScannerInfo item);
Example in CURL
curl -X POST \
http://qa-v3.feenicsdev.com/api/f/5b61d62492dacd062c424424/inputscanners \
-H 'Content-Type: application/json' \
-d
'{
"$type":"Feenics.Keep.WebApi.Model.InputScannerInfo, Feenics.Keep.WebApi.Model",
"NonSettlingErrorPriority":0,
"NonSettlingErrorStatus":0,
"InputScannerReportingPriorities":
[
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, shorted circuit",
"Priority":1,
"StatusCode":3,
"MinResistanceCode":-2,
"MaxResistanceCode":50
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, foreign voltage",
"Priority":1,
"StatusCode":5,
"MinResistanceCode":50,
"MaxResistanceCode":850
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Inactive, normal state of circuit",
"Priority":2,
"StatusCode":0,
"MinResistanceCode":850,
"MaxResistanceCode":1150
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, foreign voltage",
"Priority":1,
"StatusCode":5,
"MinResistanceCode":1150,
"MaxResistanceCode":1800
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Active",
"Priority":0,
"StatusCode":1,
"MinResistanceCode":1800,
"MaxResistanceCode":2200
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, foreign voltage",
"Priority":1,
"StatusCode":5,
"MinResistanceCode":2200,
"MaxResistanceCode":25000
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, open circuit",
"Priority":1,
"StatusCode":4,
"MinResistanceCode":25000,
"MaxResistanceCode":-1
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, ground fault",
"Priority":1,
"StatusCode":2,
"MinResistanceCode":-4,
"MaxResistanceCode":-3
}
],
"Key":null,
"CommonName":"InputScannerRestAPIIntegrationTestingPreExisiting",
"InFolderHref":null,
"InFolderKey":null,
"Links":[],
"ObjectLinks":null,
"Metadata":null,
"Notes":null,
"Tags":null,
"Monikers":null,
"Href":null
}'
Example in C#
// Returns: nothing
await client.DeleteInputAsync(InputInfo item);
Example in CURL
curl -X DELETE \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/inputs/INPUT.KEY \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: nothing
await client.DeleteInputScannerAsync(InputScannerInfo item);
Example in CURL
curl -X DELETE \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/inputscanners/INPUTSCANNER.KEY \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: IEnumerable<InputInfo>
var inputInfo = await client.GetInputsAsync(FolderInfo folder);
Example in CURL
curl -X GET \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/inputs \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: IEnumerable<InputScannerInfo>
var inputScannerInfo = await client.GetInputScannersAsync(FolderInfo folder);
Example in CURL
curl -X GET \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/inputscanners \
-H 'Authorization: Bearer TOKEN_GOES_HERE'
Example in C#
// Returns: nothing
await client.UpdateInputAsync(InputInfo item);
Example in CURL
curl -X PUT \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/inputs/INPUT.KEY \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '{
"$type": "Feenics.Keep.WebApi.Model.InputInfo, Feenics.Keep.WebApi.Model",
"Key": "INPUT.KEY",
"CommonName": "Updated Input Name",
"InFolderKey": "INSTANCE.KEY"
}'
Example in C#
// Returns: nothing
await client.UpdateInputScannerAsync(InputScannerInfo item);
Example in CURL
curl -X PUT \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/inputscanners/INPUTSCANNER.KEY \
-H 'Content-Type: application/json' \
-d
'{
"$type":"Feenics.Keep.WebApi.Model.InputScannerInfo, Feenics.Keep.WebApi.Model",
"NonSettlingErrorPriority":0,
"NonSettlingErrorStatus":0,
"InputScannerReportingPriorities":
[
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, shorted circuit",
"Priority":1,
"StatusCode":3,
"MinResistanceCode":-2,
"MaxResistanceCode":50
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, foreign voltage",
"Priority":1,
"StatusCode":5,
"MinResistanceCode":50,
"MaxResistanceCode":850
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Inactive, normal state of circuit",
"Priority":2,
"StatusCode":0,
"MinResistanceCode":850,
"MaxResistanceCode":1150
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, foreign voltage",
"Priority":1,
"StatusCode":5,
"MinResistanceCode":1150,
"MaxResistanceCode":1800
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Active",
"Priority":0,
"StatusCode":1,
"MinResistanceCode":1800,
"MaxResistanceCode":2200
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, foreign voltage",
"Priority":1,
"StatusCode":5,
"MinResistanceCode":2200,
"MaxResistanceCode":25000
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, open circuit",
"Priority":1,
"StatusCode":4,
"MinResistanceCode":25000,
"MaxResistanceCode":-1
},
{
"$type":"Feenics.Keep.WebApi.Model.InputScannerReportingPriority, Feenics.Keep.WebApi.Model",
"CommonName":"Supervisory fault, ground fault",
"Priority":1,
"StatusCode":2,
"MinResistanceCode":-4,
"MaxResistanceCode":-3
}
],
"Key":"INPUTSCANNER.KEY",
"CommonName":"INPUTSCANNER",
"InFolderHref":"/api/f/FOLDER.KEY",
"InFolderKey":"FOLDER.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":"INSTANCE.KEY",
"CommonName":"Instance",
"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",
"Relation":"InstanceScope",
"MetaDataBson":
{
"$type":"System.Byte[], mscorlib",
"$value":""
}
}
],
"Metadata":[],
"Notes":[],
"Tags":[],
"Monikers":[],
"Href":"/api/f/INSTANCE.KEY/inputscanners/INPUTSCANNER.KEY"
}'
Example in C#
// Returns: nothing
await client.UpdateInputStatusAsync(InputInfo input, InputStatusItem status);
Example in CURL
curl -X PUT \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/inputs/INPUT.KEY/status \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '{
"$type":"Feenics.Keep.WebApi.Model.InputStatusItem, Feenics.Keep.WebApi.Model"
}'