GET v2/sites/{siteId}

Get site information for a given site

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteId

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

WaterMeterSite
NameDescriptionTypeAdditional information
accountName

Name of the Account

string

None.

siteName

Name of the site

string

None.

accountId

Account Id

integer

None.

siteId

Site Id

integer

None.

siteDescription

Site Description

string

None.

siteAddress

Street Address of the Site

string

None.

siteCity

City of the Site

string

None.

siteState

State of the Site

string

None.

siteZipCode

Postal Code of the Site

string

None.

siteCountry

Country of the Site

string

None.

siteLongitude

Site Longitude

decimal number

None.

siteLatitude

Site Latitude

decimal number

None.

siteTypeId

Site Type Id

integer

None.

siteTypeName

Site Type Name Example : Unassigned, Commercial Bldg, HOA, Residential, Park, Median, Other

string

None.

yearBuilt

Site built year

integer

None.

siteMaintainer

Name of the Site Maintainer

string

None.

waterAgencyId

Water Agency Id

integer

None.

waterAgencyName

Water Agency Name

string

None.

SiteAreaUserValue

Total Site Area

integer

None.

siteAreaUnitTypeId

Unit Id of the Site Area Value

integer

None.

siteAreaUnitTypeName

Unit Name of Site Area Example : Square Feet, Acres

string

None.

siteAreaUnitTypeAbbr

Site Unit Area Abbrivation

string

None.

totalWaterMeters

Total Water Meters for the Site

integer

None.

siteCreatedDateUtc

Site Created Date

string

None.

Response Formats

application/json, text/json

Sample:
{
  "accountName": "sample string 1",
  "siteName": "sample string 2",
  "accountId": 3,
  "siteId": 4,
  "siteDescription": "sample string 5",
  "siteAddress": "sample string 6",
  "siteCity": "sample string 7",
  "siteState": "sample string 8",
  "siteZipCode": "sample string 9",
  "siteCountry": "sample string 10",
  "siteLongitude": 11.0,
  "siteLatitude": 12.0,
  "siteTypeId": 13,
  "siteTypeName": "sample string 14",
  "yearBuilt": 15,
  "siteMaintainer": "sample string 16",
  "waterAgencyId": 17,
  "waterAgencyName": "sample string 18",
  "SiteAreaUserValue": 19,
  "siteAreaUnitTypeId": 20,
  "siteAreaUnitTypeName": "sample string 21",
  "siteAreaUnitTypeAbbr": "sample string 22",
  "totalWaterMeters": 23,
  "siteCreatedDateUtc": "sample string 24"
}

application/xml, text/xml

Sample:
<WaterMeterSite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HydroPoint.Api.WaterMeter.Resources.v2">
  <AccountId>3</AccountId>
  <AccountName>sample string 1</AccountName>
  <SiteAddress>sample string 6</SiteAddress>
  <SiteAreaUnitTypeAbbr>sample string 22</SiteAreaUnitTypeAbbr>
  <SiteAreaUnitTypeId>20</SiteAreaUnitTypeId>
  <SiteAreaUnitTypeName>sample string 21</SiteAreaUnitTypeName>
  <SiteAreaUserValue>19</SiteAreaUserValue>
  <SiteCity>sample string 7</SiteCity>
  <SiteCountry>sample string 10</SiteCountry>
  <SiteCreatedDateUtc>sample string 24</SiteCreatedDateUtc>
  <SiteDescription>sample string 5</SiteDescription>
  <SiteId>4</SiteId>
  <SiteLatitude>12</SiteLatitude>
  <SiteLongitude>11</SiteLongitude>
  <SiteMaintainer>sample string 16</SiteMaintainer>
  <SiteName>sample string 2</SiteName>
  <SiteState>sample string 8</SiteState>
  <SiteTypeId>13</SiteTypeId>
  <SiteTypeName>sample string 14</SiteTypeName>
  <SiteZipCode>sample string 9</SiteZipCode>
  <TotalWaterMeters>23</TotalWaterMeters>
  <WaterAgencyId>17</WaterAgencyId>
  <WaterAgencyName>sample string 18</WaterAgencyName>
  <YearBuilt>15</YearBuilt>
</WaterMeterSite>