GET v1/accounts/{accountId}/alerts/account-summary?startDate={startDate}&endDate={endDate}

Provides a water meter alert summary for an account.

Request Information

URI Parameters

Name	Description	Type	Additional information
accountId	Account Id	integer	Default value is 0
startDate	Only alerts raised after this time will be included.	date	None.
endDate	Only alerts raised before this time will be included.	date	None.

Body Parameters

None.

Response Information

Resource Description

WaterMeterAlertAccountSummary

Name	Description	Type	Additional information
AccountId	Account Id	integer	None.
AccountName	Account Name	string	None.
ContinousUsageAlertCount	Total number of continuous usage alerts.	integer	None.
HighHourlyUsageAlertCount	Total number of high hourly usage alerts.	integer	None.
HighDailyUsageAlertCount	Total number of high daily usage alerts.	integer	None.
TotalUsageAlertCount	Total number of usage alerts.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "AccountId": 1,
  "AccountName": "sample string 2",
  "ContinousUsageAlertCount": 3,
  "HighHourlyUsageAlertCount": 4,
  "HighDailyUsageAlertCount": 5,
  "TotalUsageAlertCount": 6
}

application/xml, text/xml

Sample:

<WaterMeterAlertAccountSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HydroPoint.Api.WaterMeter.Resources.v1">
  <AccountId>1</AccountId>
  <AccountName>sample string 2</AccountName>
  <ContinousUsageAlertCount>3</ContinousUsageAlertCount>
  <HighDailyUsageAlertCount>5</HighDailyUsageAlertCount>
  <HighHourlyUsageAlertCount>4</HighHourlyUsageAlertCount>
  <TotalUsageAlertCount>6</TotalUsageAlertCount>
</WaterMeterAlertAccountSummary>