GET v1/meters/{waterMeterId}/events?startDateUtc={startDateUtc}&endDateUtc={endDateUtc}&convertDatesToUtc={convertDatesToUtc}

Get the list of usage data update events

Request Information

URI Parameters

NameDescriptionTypeAdditional information
waterMeterId

integer

Required

startDateUtc

Event data will be retrieved beginning with this date.

date

Required

endDateUtc

Event data will be retrieved up through this date.

date

Required

convertDatesToUtc

If set to true, UsageStartTime and UsageEndTime dates will be be returned as UTC values. Default value is false.

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of WaterMeterEventDataModel
NameDescriptionTypeAdditional information
waterMeterId

integer

None.

eventDateUtc

date

None.

usageSource

string

None.

recordCount

integer

None.

usageStartTime

date

None.

usageEndTime

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "waterMeterId": 1,
    "eventDateUtc": "2026-04-05T07:34:52.8679547-07:00",
    "usageSource": "sample string 3",
    "recordCount": 4,
    "usageStartTime": "2026-04-05T07:34:52.8679547-07:00",
    "usageEndTime": "2026-04-05T07:34:52.8679547-07:00"
  },
  {
    "waterMeterId": 1,
    "eventDateUtc": "2026-04-05T07:34:52.8679547-07:00",
    "usageSource": "sample string 3",
    "recordCount": 4,
    "usageStartTime": "2026-04-05T07:34:52.8679547-07:00",
    "usageEndTime": "2026-04-05T07:34:52.8679547-07:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfWaterMeterEventDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HydroPoint.Core.Models.Data.WaterMeter">
  <WaterMeterEventDataModel>
    <EventDateUtc>2026-04-05T07:34:52.8679547-07:00</EventDateUtc>
    <RecordCount>4</RecordCount>
    <UsageEndTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-04-05T14:34:52.8679547Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-420</d3p1:OffsetMinutes>
    </UsageEndTime>
    <UsageSourceTypeName>sample string 3</UsageSourceTypeName>
    <UsageStartTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-04-05T14:34:52.8679547Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-420</d3p1:OffsetMinutes>
    </UsageStartTime>
    <WaterMeterId>1</WaterMeterId>
  </WaterMeterEventDataModel>
  <WaterMeterEventDataModel>
    <EventDateUtc>2026-04-05T07:34:52.8679547-07:00</EventDateUtc>
    <RecordCount>4</RecordCount>
    <UsageEndTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-04-05T14:34:52.8679547Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-420</d3p1:OffsetMinutes>
    </UsageEndTime>
    <UsageSourceTypeName>sample string 3</UsageSourceTypeName>
    <UsageStartTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-04-05T14:34:52.8679547Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-420</d3p1:OffsetMinutes>
    </UsageStartTime>
    <WaterMeterId>1</WaterMeterId>
  </WaterMeterEventDataModel>
</ArrayOfWaterMeterEventDataModel>