BazeField Services

<back to all web services

GetAlarmStatistics

Alarm API
Requires Authentication
The following routes are available for this service:
GET,POST/api/turbines/alarmlog/statistics/from/{From}/to/{To}Obsolete
GET,POST/api/turbines/{TurbineIds}/alarmlog/statistics/from/{From}/to/{To}Obsolete
GET,POST/api/objects/alarmlog/statistics
GetAlarmStatistics Parameters:
NameParameterData TypeRequiredDescription
TurbineIdspathList<string>NoAssets contributing to total count and total duration. Will also define the return values in the case when TurbineToDrillInto is not specified
TurbineToDrillIntobodystringNoOptional. Specify additionally to parameter TurbineIds when drilling into the alarm codes for one specific asset.
FrompathstringNo
TopathstringNo
TypebodyAlarmType?No
OrderBybodystringNo
Takebodyint?No
IncludeOkAlarmsbodyboolNo
ChartGroupbodystringNo
AlarmIdbodyint?No
SourceIdsbodyList<int>No
AlarmCodebodyint?No
AllocationTypeIdbodyint?No
Parameter1bodyint?No
VendorEventTypebodystringNo
AlarmDescriptionbodystringNo
AlarmType Enum:
NameValue
Warning0
Alarm1
Status2
Auto4
ConfigPending8
AlarmStatsReplyList Parameters:
NameParameterData TypeRequiredDescription
AlarmStatsformList<AlarmStats>No
TotalDurationformdoubleNo
TotalCountformdoubleNo
MTTRformdoubleNo
MTBFformdoubleNo
MostFrequentformAlarmStatsNo
LongestDurationformAlarmStatsNo
TotalLostProductionformdoubleNo
TotalLostMoneyformdoubleNo
AlarmStats Parameters:
NameParameterData TypeRequiredDescription
CodeformintNo
AlarmTypeformintNo
AlarmIdformintNo
AlarmDescriptionformstringNo
DurationformdoubleNo
DurationPercentageformdoubleNo
CountformintNo
TurbinesformintNo
FrequencyformdoubleNo
ErrorRatePercentageformdoubleNo
MTBFformdoubleNo
MTTRformdoubleNo
SourceIdformintNo
LostProductionformdouble?No
LostMoneyformdouble?No
Parameter1formstringNo
VendorEventTypeformstringNo
StatItemIdformintNo
StatItemNameformstringNo
TypeformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/turbines/alarmlog/statistics/from/{From}/to/{To} HTTP/1.1 
Host: mdn.bazefield.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetAlarmStatistics xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BazeField.WindAssets.WebService">
  <AlarmCode>0</AlarmCode>
  <AlarmDescription>String</AlarmDescription>
  <AlarmId>0</AlarmId>
  <AllocationTypeId>0</AllocationTypeId>
  <ChartGroup>String</ChartGroup>
  <From>String</From>
  <IncludeOkAlarms>false</IncludeOkAlarms>
  <OrderBy>String</OrderBy>
  <Parameter1>0</Parameter1>
  <SourceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </SourceIds>
  <Take>0</Take>
  <To>String</To>
  <TurbineIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TurbineIds>
  <TurbineToDrillInto>String</TurbineToDrillInto>
  <Type>Warning</Type>
  <VendorEventType>String</VendorEventType>
</GetAlarmStatistics>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AlarmStatsReplyList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BazeField.WindAssets.WebService">
  <AlarmStats xmlns:d2p1="http://schemas.datacontract.org/2004/07/BazeField.WindAssets.DataModel.Entities">
    <d2p1:AlarmStats>
      <d2p1:AlarmDescription>String</d2p1:AlarmDescription>
      <d2p1:AlarmId>0</d2p1:AlarmId>
      <d2p1:AlarmType>0</d2p1:AlarmType>
      <d2p1:Code>0</d2p1:Code>
      <d2p1:Count>0</d2p1:Count>
      <d2p1:Duration>0</d2p1:Duration>
      <d2p1:DurationPercentage>0</d2p1:DurationPercentage>
      <d2p1:ErrorRatePercentage>0</d2p1:ErrorRatePercentage>
      <d2p1:Frequency>0</d2p1:Frequency>
      <d2p1:LostMoney>0</d2p1:LostMoney>
      <d2p1:LostProduction>0</d2p1:LostProduction>
      <d2p1:MTBF>0</d2p1:MTBF>
      <d2p1:MTTR>0</d2p1:MTTR>
      <d2p1:Parameter1>String</d2p1:Parameter1>
      <d2p1:SourceId>0</d2p1:SourceId>
      <d2p1:StatItemId>0</d2p1:StatItemId>
      <d2p1:StatItemName>String</d2p1:StatItemName>
      <d2p1:Turbines>0</d2p1:Turbines>
      <d2p1:VendorEventType>String</d2p1:VendorEventType>
    </d2p1:AlarmStats>
  </AlarmStats>
  <LongestDuration xmlns:d2p1="http://schemas.datacontract.org/2004/07/BazeField.WindAssets.DataModel.Entities">
    <d2p1:AlarmDescription>String</d2p1:AlarmDescription>
    <d2p1:AlarmId>0</d2p1:AlarmId>
    <d2p1:AlarmType>0</d2p1:AlarmType>
    <d2p1:Code>0</d2p1:Code>
    <d2p1:Count>0</d2p1:Count>
    <d2p1:Duration>0</d2p1:Duration>
    <d2p1:DurationPercentage>0</d2p1:DurationPercentage>
    <d2p1:ErrorRatePercentage>0</d2p1:ErrorRatePercentage>
    <d2p1:Frequency>0</d2p1:Frequency>
    <d2p1:LostMoney>0</d2p1:LostMoney>
    <d2p1:LostProduction>0</d2p1:LostProduction>
    <d2p1:MTBF>0</d2p1:MTBF>
    <d2p1:MTTR>0</d2p1:MTTR>
    <d2p1:Parameter1>String</d2p1:Parameter1>
    <d2p1:SourceId>0</d2p1:SourceId>
    <d2p1:StatItemId>0</d2p1:StatItemId>
    <d2p1:StatItemName>String</d2p1:StatItemName>
    <d2p1:Turbines>0</d2p1:Turbines>
    <d2p1:VendorEventType>String</d2p1:VendorEventType>
  </LongestDuration>
  <MTBF>0</MTBF>
  <MTTR>0</MTTR>
  <MostFrequent xmlns:d2p1="http://schemas.datacontract.org/2004/07/BazeField.WindAssets.DataModel.Entities">
    <d2p1:AlarmDescription>String</d2p1:AlarmDescription>
    <d2p1:AlarmId>0</d2p1:AlarmId>
    <d2p1:AlarmType>0</d2p1:AlarmType>
    <d2p1:Code>0</d2p1:Code>
    <d2p1:Count>0</d2p1:Count>
    <d2p1:Duration>0</d2p1:Duration>
    <d2p1:DurationPercentage>0</d2p1:DurationPercentage>
    <d2p1:ErrorRatePercentage>0</d2p1:ErrorRatePercentage>
    <d2p1:Frequency>0</d2p1:Frequency>
    <d2p1:LostMoney>0</d2p1:LostMoney>
    <d2p1:LostProduction>0</d2p1:LostProduction>
    <d2p1:MTBF>0</d2p1:MTBF>
    <d2p1:MTTR>0</d2p1:MTTR>
    <d2p1:Parameter1>String</d2p1:Parameter1>
    <d2p1:SourceId>0</d2p1:SourceId>
    <d2p1:StatItemId>0</d2p1:StatItemId>
    <d2p1:StatItemName>String</d2p1:StatItemName>
    <d2p1:Turbines>0</d2p1:Turbines>
    <d2p1:VendorEventType>String</d2p1:VendorEventType>
  </MostFrequent>
  <TotalCount>0</TotalCount>
  <TotalDuration>0</TotalDuration>
  <TotalLostMoney>0</TotalLostMoney>
  <TotalLostProduction>0</TotalLostProduction>
</AlarmStatsReplyList>