GET v2/meters/{waterMeterId}

Get general info for a given water meter id

Request Information

URI Parameters

Name	Description	Type	Additional information
waterMeterId	The water meter's id.	integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of WaterMeterDevice

Name	Description	Type	Additional information
waterMeterId	Water Meter Id	integer	None.
waterMeterName	Name of the Water Meter	string	None.
deviceTypeName	Name of the device type	string	None.
deviceTypeFamilyName	Name of the device type family	string	None.
accountId	Account Id	integer	None.
waterMeterCompanyName	Water Meter Company Name	string	None.
siteId	Site Id	integer	None.
waterMeterSiteName	Name of the Water Meter Site	string	None.
usageCategories	Usage Categories	string	None.
waterMeterTypeId	Water Meter Type Id	integer	None.
waterMeterTypeName	Water Meter Type Name Example : Unassigned, Commercial, Residential, Combined, Irrigation, Custom	string	None.
waterSourceTypeId	Water SourceType Id	integer	None.
waterSourceTypeName	Water SourceType Name Example : Unassigned, Potable Water, Reclaimed Water, Condensate, Rainwater Harvest, Pond, Other	string	None.
waterMeterLatitude	Latitude of WaterMeter	decimal number	None.
waterMeterLongitude	Longitude of WaterMeter	decimal number	None.
totalFM200s	Count of Total FM200s	integer	None.
calibrationLevelId	Calibration Level Id	integer	None.
calibrationLevelName	Calibration Level Name Example : Level0, Level1, Level2	string	None.
earliestCalibratedUsageStartDateUtc	Represents the first date when calibrated (Level2) usage was available for this meter. This may include historical calibrated usage even if the current calibration level is not Level 2.	string	None.
lastCalibrationProcessDateUtc	If the current calibration is set to Level2, this field reflects the last time calibration was processed (if available). This field will not have a value if the current calibration level is not Level2. Generally, this shouldn't change very often. If it does, you may wish to requery usage data for date ranges >= earliestCalibratedUsageStartDateUtc.	string	None.
waterMeterCreateDateUtc	Water Meter Created DateTime	string	None.
sensorMode	Sensor Mode	string	None.
lastCommunicationDateUtc	Last communication date for water meter.	string	None.
lastUsageDateUtc	Last usage date for water meter.	string	None.
timeZoneName	Gets or sets the name of the time zone. Time zone is in IANA format (e.g. "America/New_York").	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "waterMeterId": 1,
    "waterMeterName": "sample string 2",
    "deviceTypeName": "sample string 3",
    "deviceTypeFamilyName": "sample string 4",
    "accountId": 5,
    "waterMeterCompanyName": "sample string 6",
    "siteId": 7,
    "waterMeterSiteName": "sample string 8",
    "usageCategories": "sample string 9",
    "waterMeterTypeId": 10,
    "waterMeterTypeName": "sample string 11",
    "waterSourceTypeId": 12,
    "waterSourceTypeName": "sample string 13",
    "waterMeterLatitude": 14.1,
    "waterMeterLongitude": 15.1,
    "totalFM200s": 16,
    "calibrationLevelId": 17,
    "calibrationLevelName": "sample string 18",
    "earliestCalibratedUsageStartDateUtc": "sample string 19",
    "lastCalibrationProcessDateUtc": "sample string 20",
    "waterMeterCreateDateUtc": "sample string 21",
    "sensorMode": "sample string 22",
    "lastCommunicationDateUtc": "sample string 23",
    "lastUsageDateUtc": "sample string 24",
    "timeZoneName": "sample string 25"
  },
  {
    "waterMeterId": 1,
    "waterMeterName": "sample string 2",
    "deviceTypeName": "sample string 3",
    "deviceTypeFamilyName": "sample string 4",
    "accountId": 5,
    "waterMeterCompanyName": "sample string 6",
    "siteId": 7,
    "waterMeterSiteName": "sample string 8",
    "usageCategories": "sample string 9",
    "waterMeterTypeId": 10,
    "waterMeterTypeName": "sample string 11",
    "waterSourceTypeId": 12,
    "waterSourceTypeName": "sample string 13",
    "waterMeterLatitude": 14.1,
    "waterMeterLongitude": 15.1,
    "totalFM200s": 16,
    "calibrationLevelId": 17,
    "calibrationLevelName": "sample string 18",
    "earliestCalibratedUsageStartDateUtc": "sample string 19",
    "lastCalibrationProcessDateUtc": "sample string 20",
    "waterMeterCreateDateUtc": "sample string 21",
    "sensorMode": "sample string 22",
    "lastCommunicationDateUtc": "sample string 23",
    "lastUsageDateUtc": "sample string 24",
    "timeZoneName": "sample string 25"
  }
]

application/xml, text/xml

Sample:

<ArrayOfWaterMeterDevice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HydroPoint.Api.WaterMeter.Resources.v2">
  <WaterMeterDevice>
    <AccountId>5</AccountId>
    <CalibrationLevelId>17</CalibrationLevelId>
    <CalibrationLevelName>sample string 18</CalibrationLevelName>
    <DeviceTypeFamilyName>sample string 4</DeviceTypeFamilyName>
    <DeviceTypeName>sample string 3</DeviceTypeName>
    <EarliestCalibratedUsageStartDateUtc>sample string 19</EarliestCalibratedUsageStartDateUtc>
    <LastCalibrationProcessDateUtc>sample string 20</LastCalibrationProcessDateUtc>
    <LastCommunicationDateUtc>sample string 23</LastCommunicationDateUtc>
    <LastUsageDateUtc>sample string 24</LastUsageDateUtc>
    <SensorMode>sample string 22</SensorMode>
    <SiteId>7</SiteId>
    <TimeZoneName>sample string 25</TimeZoneName>
    <TotalFM200s>16</TotalFM200s>
    <UsageCategories>sample string 9</UsageCategories>
    <WaterMeterCompanyName>sample string 6</WaterMeterCompanyName>
    <WaterMeterCreateDateUtc>sample string 21</WaterMeterCreateDateUtc>
    <WaterMeterId>1</WaterMeterId>
    <WaterMeterLatitude>14.1</WaterMeterLatitude>
    <WaterMeterLongitude>15.1</WaterMeterLongitude>
    <WaterMeterName>sample string 2</WaterMeterName>
    <WaterMeterSiteName>sample string 8</WaterMeterSiteName>
    <WaterMeterTypeId>10</WaterMeterTypeId>
    <WaterMeterTypeName>sample string 11</WaterMeterTypeName>
    <WaterSourceTypeId>12</WaterSourceTypeId>
    <WaterSourceTypeName>sample string 13</WaterSourceTypeName>
  </WaterMeterDevice>
  <WaterMeterDevice>
    <AccountId>5</AccountId>
    <CalibrationLevelId>17</CalibrationLevelId>
    <CalibrationLevelName>sample string 18</CalibrationLevelName>
    <DeviceTypeFamilyName>sample string 4</DeviceTypeFamilyName>
    <DeviceTypeName>sample string 3</DeviceTypeName>
    <EarliestCalibratedUsageStartDateUtc>sample string 19</EarliestCalibratedUsageStartDateUtc>
    <LastCalibrationProcessDateUtc>sample string 20</LastCalibrationProcessDateUtc>
    <LastCommunicationDateUtc>sample string 23</LastCommunicationDateUtc>
    <LastUsageDateUtc>sample string 24</LastUsageDateUtc>
    <SensorMode>sample string 22</SensorMode>
    <SiteId>7</SiteId>
    <TimeZoneName>sample string 25</TimeZoneName>
    <TotalFM200s>16</TotalFM200s>
    <UsageCategories>sample string 9</UsageCategories>
    <WaterMeterCompanyName>sample string 6</WaterMeterCompanyName>
    <WaterMeterCreateDateUtc>sample string 21</WaterMeterCreateDateUtc>
    <WaterMeterId>1</WaterMeterId>
    <WaterMeterLatitude>14.1</WaterMeterLatitude>
    <WaterMeterLongitude>15.1</WaterMeterLongitude>
    <WaterMeterName>sample string 2</WaterMeterName>
    <WaterMeterSiteName>sample string 8</WaterMeterSiteName>
    <WaterMeterTypeId>10</WaterMeterTypeId>
    <WaterMeterTypeName>sample string 11</WaterMeterTypeName>
    <WaterSourceTypeId>12</WaterSourceTypeId>
    <WaterSourceTypeName>sample string 13</WaterSourceTypeName>
  </WaterMeterDevice>
</ArrayOfWaterMeterDevice>