GET sites?siteNameFilter={siteNameFilter}&siteTypeFilter={siteTypeFilter}

Gets a list of all of the sites or a filtered list of sites by name

Request Information

URI Parameters

NameDescriptionTypeAdditional information
siteNameFilter

Used to filter the site's by name

string

None.

siteTypeFilter

string

None.

Body Parameters

None.

Response Information

Resource Description

A Response object with information about the result of the operation

ResponseVMOfSiteVM
NameDescriptionTypeAdditional 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",
      "Longitude": "sample string 3",
      "Latitude": "sample string 4",
      "Channels": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Unit": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Unit": "sample string 3"
        }
      ]
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Longitude": "sample string 3",
      "Latitude": "sample string 4",
      "Channels": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "Unit": "sample string 3"
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "Unit": "sample string 3"
        }
      ]
    }
  ],
  "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>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Unit>sample string 3</Unit>
        </ChannelVM>
        <ChannelVM>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Unit>sample string 3</Unit>
        </ChannelVM>
      </Channels>
      <Id>1</Id>
      <Latitude>sample string 4</Latitude>
      <Longitude>sample string 3</Longitude>
      <Name>sample string 2</Name>
    </SiteVM>
    <SiteVM>
      <Channels>
        <ChannelVM>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Unit>sample string 3</Unit>
        </ChannelVM>
        <ChannelVM>
          <Id>1</Id>
          <Name>sample string 2</Name>
          <Unit>sample string 3</Unit>
        </ChannelVM>
      </Channels>
      <Id>1</Id>
      <Latitude>sample string 4</Latitude>
      <Longitude>sample string 3</Longitude>
      <Name>sample string 2</Name>
    </SiteVM>
  </Resources>
</ResponseVMOfSiteVMFXJgzlgx>