GET sites?siteNameFilter={siteNameFilter}&siteTypeFilter={siteTypeFilter}
Gets a list of sites. With no filter, this will return all available sites. Optionally, the list can be filtered by the site name or site type. The site name filter can partially match multiple sites, or exactly match a single site. For example, "sitenamefilter=ANG" would match sites 'ANG001', 'ANG002', and 'Langford'. The site type filter will match all sites with the type provided. For example, "siteTypeFilter=Sewer" would match all sites whose type is sewer. Both filters can be used invidually or in combination.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
siteNameFilter |
Filter the site list by this site name (partial or complete). |
string |
None. |
siteTypeFilter |
Filter the site list by this site type. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
ResponseVMOfSiteVMName | Description | Type | Additional information |
---|---|---|---|
Resources | Collection of SiteVM |
None. |
|
ResultCode | FwApiResultCode |
None. |
|
ResultMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Resources": [ { "Id": 1, "Name": "sample string 2", "InternalName": "sample string 3", "Longitude": "sample string 4", "Latitude": "sample string 5", "Channels": [ { "Id": 1, "Name": "sample string 2", "Unit": "sample string 3", "ChannelType": "sample string 4", "IsVisible": true, "IsRainfallEnabled": true }, { "Id": 1, "Name": "sample string 2", "Unit": "sample string 3", "ChannelType": "sample string 4", "IsVisible": true, "IsRainfallEnabled": true } ] }, { "Id": 1, "Name": "sample string 2", "InternalName": "sample string 3", "Longitude": "sample string 4", "Latitude": "sample string 5", "Channels": [ { "Id": 1, "Name": "sample string 2", "Unit": "sample string 3", "ChannelType": "sample string 4", "IsVisible": true, "IsRainfallEnabled": true }, { "Id": 1, "Name": "sample string 2", "Unit": "sample string 3", "ChannelType": "sample string 4", "IsVisible": true, "IsRainfallEnabled": true } ] } ], "ResultCode": 0, "ResultMessage": "sample string 1" }
application/xml, text/xml
Sample:
<ResponseVMOfSiteVMFXJgzlgx xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FW.WebApi2.ViewModels"> <ResultCode>Ok</ResultCode> <ResultMessage>sample string 1</ResultMessage> <Resources> <SiteVM> <Channels> <ChannelVM> <ChannelType>sample string 4</ChannelType> <Id>1</Id> <IsRainfallEnabled>true</IsRainfallEnabled> <IsVisible>true</IsVisible> <Name>sample string 2</Name> <Unit>sample string 3</Unit> </ChannelVM> <ChannelVM> <ChannelType>sample string 4</ChannelType> <Id>1</Id> <IsRainfallEnabled>true</IsRainfallEnabled> <IsVisible>true</IsVisible> <Name>sample string 2</Name> <Unit>sample string 3</Unit> </ChannelVM> </Channels> <Id>1</Id> <InternalName>sample string 3</InternalName> <Latitude>sample string 5</Latitude> <Longitude>sample string 4</Longitude> <Name>sample string 2</Name> </SiteVM> <SiteVM> <Channels> <ChannelVM> <ChannelType>sample string 4</ChannelType> <Id>1</Id> <IsRainfallEnabled>true</IsRainfallEnabled> <IsVisible>true</IsVisible> <Name>sample string 2</Name> <Unit>sample string 3</Unit> </ChannelVM> <ChannelVM> <ChannelType>sample string 4</ChannelType> <Id>1</Id> <IsRainfallEnabled>true</IsRainfallEnabled> <IsVisible>true</IsVisible> <Name>sample string 2</Name> <Unit>sample string 3</Unit> </ChannelVM> </Channels> <Id>1</Id> <InternalName>sample string 3</InternalName> <Latitude>sample string 5</Latitude> <Longitude>sample string 4</Longitude> <Name>sample string 2</Name> </SiteVM> </Resources> </ResponseVMOfSiteVMFXJgzlgx>