GET v2/sites/{siteId}/meters

Get the list of water meters a user has access to based on site

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteId

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of WaterMeterBasicInfo
NameDescriptionTypeAdditional information
waterMeterId

Id of WaterMeter

integer

None.

waterMeterName

Name of the WaterMeter

string

None.

deviceTypeName

Name of the device type

string

None.

timeZoneName

Name of the device's time zone

string

None.

deviceTypeFamilyName

Name of the device type family

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "deviceTypeFamilyName": "sample string 1",
    "waterMeterId": 1,
    "waterMeterName": "sample string 2",
    "deviceTypeName": "sample string 3",
    "timeZoneName": "sample string 4"
  },
  {
    "deviceTypeFamilyName": "sample string 1",
    "waterMeterId": 1,
    "waterMeterName": "sample string 2",
    "deviceTypeName": "sample string 3",
    "timeZoneName": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfWaterMeterBasicInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HydroPoint.Api.WaterMeter.Resources.v1">
  <WaterMeterBasicInfo>
    <DeviceTypeFamilyName>sample string 1</DeviceTypeFamilyName>
    <DeviceTypeName>sample string 3</DeviceTypeName>
    <TimeZoneName>sample string 4</TimeZoneName>
    <WaterMeterId>1</WaterMeterId>
    <WaterMeterName>sample string 2</WaterMeterName>
  </WaterMeterBasicInfo>
  <WaterMeterBasicInfo>
    <DeviceTypeFamilyName>sample string 1</DeviceTypeFamilyName>
    <DeviceTypeName>sample string 3</DeviceTypeName>
    <TimeZoneName>sample string 4</TimeZoneName>
    <WaterMeterId>1</WaterMeterId>
    <WaterMeterName>sample string 2</WaterMeterName>
  </WaterMeterBasicInfo>
</ArrayOfWaterMeterBasicInfo>