POST sites

Creates a new site

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
DisplaySiteName	The name displayed to the user to identify the site.	string	None.
InternalSiteName	The internal Site name that is referenced as data arrives.	string	None.
SiteType	Each type is represented by a unique icon that helps you visually identify sites in many areas, such as Map View and Graphing. Valid values include: Water Sewer Hydrometric Drainage Rainfall Visual Facility Precipitation Climate OverflowOutfall	string	None.
Longitude	Longitude coordinate of your site.	decimal number	None.
Latitude	Latitude coordinate of your site.	decimal number	None.
Address	You may wish to include an address if you use the product to establish Work Orders. This can help you provide clearer directions for maintenance crews who must physically visit the site.	string	None.
UnitsMode	Select the Default UnitsMode for this site. You can choose between US Standard and Metric. This establishes a unit standard that is used throughout the product when you are working with this site. US Metric	string	None.
TimeZone	Enter a Time Zone within which your new site resides, offset from GMT.	decimal number	None.
ExpectedSchedule	This field refers to the number of expected minutes between data collections.	integer	None.
Channels	A list of channels that will be added as part of this site.	Collection of CreateChannelVM	None.

Request Formats

application/json, text/json

Sample:

{
  "DisplaySiteName": "sample string 1",
  "InternalSiteName": "sample string 2",
  "SiteType": "sample string 3",
  "Longitude": 1.1,
  "Latitude": 1.1,
  "Address": "sample string 4",
  "UnitsMode": "sample string 5",
  "TimeZone": 6.1,
  "ExpectedSchedule": 1,
  "Channels": [
    {
      "ChannelName": "sample string 1",
      "Unit": "sample string 2"
    },
    {
      "ChannelName": "sample string 1",
      "Unit": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<CreateSiteVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FW.WebApi2.ViewModels">
  <Address>sample string 4</Address>
  <Channels>
    <CreateChannelVM>
      <ChannelName>sample string 1</ChannelName>
      <Unit>sample string 2</Unit>
    </CreateChannelVM>
    <CreateChannelVM>
      <ChannelName>sample string 1</ChannelName>
      <Unit>sample string 2</Unit>
    </CreateChannelVM>
  </Channels>
  <DisplaySiteName>sample string 1</DisplaySiteName>
  <ExpectedSchedule>1</ExpectedSchedule>
  <InternalSiteName>sample string 2</InternalSiteName>
  <Latitude>1.1</Latitude>
  <Longitude>1.1</Longitude>
  <SiteType>sample string 3</SiteType>
  <TimeZone>6.1</TimeZone>
  <UnitsMode>sample string 5</UnitsMode>
</CreateSiteVM>

application/x-www-form-urlencoded

Sample:

Sample not available.

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",
      "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>