AddInputScannerAsync

Add InputScanners as an asynchronous operation. Returns (Task)

Name Description
folder
item

Add Input Scanner Async

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
                   }'
            

        This is an example of how to add an input scanner with reporting priorities.

Example in C#



           var inputScannerInfo = await client.AddInputScannerAsync(currentInstance, new InputScannerInfo
           {
               CommonName = "InputScanner",
               InputScannerReportingPriorities = new[]
              {
                   new InputScannerReportingPriority()
                   {
                       CommonName = "Supervisory fault, shorted circuit",
                       MaxResistanceCode = 50,
                       MinResistanceCode = -2,
                       Priority = 1,
                       StatusCode = InputScannerStatusCodes.ShortedCircuit
                   },
                   new InputScannerReportingPriority()
                   {
                       CommonName = "Supervisory fault, foreign voltage",
                       MaxResistanceCode = 850,
                       MinResistanceCode = 50,
                       Priority = 1,
                       StatusCode = InputScannerStatusCodes.ForeignVoltage
                   },
                   new InputScannerReportingPriority()
                   {
                       CommonName = "Inactive, normal state of circuit",
                       MaxResistanceCode = 1150,
                       MinResistanceCode = 850,
                       Priority = 2,
                       StatusCode = InputScannerStatusCodes.Inactive
                   },
                   new InputScannerReportingPriority()
                   {
                       CommonName = "Supervisory fault, foreign voltage",
                       MaxResistanceCode = 1800,
                       MinResistanceCode = 1150,
                       Priority = 1,
                       StatusCode = InputScannerStatusCodes.ForeignVoltage
                   },
                   new InputScannerReportingPriority()
                   {
                       CommonName = "Active",
                       MaxResistanceCode = 2200,
                       MinResistanceCode = 1800,
                       Priority = 0,
                       StatusCode = InputScannerStatusCodes.Active
                   },
                   new InputScannerReportingPriority()
                   {
                       CommonName = "Supervisory fault, foreign voltage",
                       MaxResistanceCode = 25000,
                       MinResistanceCode = 2200,
                       Priority = 1,
                       StatusCode = InputScannerStatusCodes.ForeignVoltage
                   },
                   new InputScannerReportingPriority()
                   {
                       CommonName = "Supervisory fault, open circuit",
                       MaxResistanceCode = -1,
                       MinResistanceCode = 25000,
                       Priority = 1,
                       StatusCode = InputScannerStatusCodes.OpenCircuit
                   },
                   new InputScannerReportingPriority()
                   {
                       CommonName = "Supervisory fault, ground fault",
                       MaxResistanceCode = -3,
                       MinResistanceCode = -4,
                       Priority = 1,
                       StatusCode = InputScannerStatusCodes.GroundFault
                   }
               }
           });