GET sites/{id}?includeChannels={includeChannels}

Gets the site with the specified site id. Optionally includes the site's channels in the response if includeChannels is set to true.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Site id of the site to retrieve.	integer	Required
includeChannels	If true, the response will include the list of channels for the site. Defaults to false.	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

ResponseVMOfSiteVM

Name	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",
      "SiteTypes": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "InternalName": "sample string 3",
      "Longitude": "sample string 4",
      "Latitude": "sample string 5",
      "SiteTypes": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "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>
      <Id>1</Id>
      <InternalName>sample string 3</InternalName>
      <Latitude>sample string 5</Latitude>
      <Longitude>sample string 4</Longitude>
      <Name>sample string 2</Name>
      <SiteTypes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </SiteTypes>
    </SiteVM>
    <SiteVM>
      <Id>1</Id>
      <InternalName>sample string 3</InternalName>
      <Latitude>sample string 5</Latitude>
      <Longitude>sample string 4</Longitude>
      <Name>sample string 2</Name>
      <SiteTypes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </SiteTypes>
    </SiteVM>
  </Resources>
</ResponseVMOfSiteVMFXJgzlgx>