GET v1/sites/{siteId}/alerts/site-summary?startDate={startDate}&endDate={endDate}

Provides a water meter alert site summary for the given site.

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId	Alert summary will be provided for this site id.	integer	Required
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

WaterMeterAlertSiteSummary

Name	Description	Type	Additional information
AccountId	Account Id	integer	None.
AccountName	Account Name	string	None.
SiteId	The parent site's id.	integer	None.
SiteName	The parent site's 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",
  "SiteId": 3,
  "SiteName": "sample string 4",
  "ContinousUsageAlertCount": 5,
  "HighHourlyUsageAlertCount": 6,
  "HighDailyUsageAlertCount": 7,
  "TotalUsageAlertCount": 8
}

application/xml, text/xml

Sample:

<WaterMeterAlertSiteSummary 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>5</ContinousUsageAlertCount>
  <HighDailyUsageAlertCount>7</HighDailyUsageAlertCount>
  <HighHourlyUsageAlertCount>6</HighHourlyUsageAlertCount>
  <SiteId>3</SiteId>
  <SiteName>sample string 4</SiteName>
  <TotalUsageAlertCount>8</TotalUsageAlertCount>
</WaterMeterAlertSiteSummary>