svcTC2API


Click here for a complete list of operations.

GetForecastWeather

Retrieve the five days forecast weather condition

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionID:
LocationID:
LanguageCode:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /tc21api/tc2.asmx HTTP/1.1
Host: rs.alarmnet.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.alarmnet.com/TC2/GetForecastWeather"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetForecastWeather xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <LocationID>long</LocationID>
      <LanguageCode>string</LanguageCode>
    </GetForecastWeather>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetForecastWeatherResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetForecastWeatherResult>
        <WeatherData>
          <Unit>int</Unit>
          <Time>string</Time>
          <ForecastWeatherList>
            <ForecastWeatherRecord xsi:nil="true" />
            <ForecastWeatherRecord xsi:nil="true" />
          </ForecastWeatherList>
        </WeatherData>
      </GetForecastWeatherResult>
    </GetForecastWeatherResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /tc21api/tc2.asmx HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetForecastWeather xmlns="https://services.alarmnet.com/TC2/">
      <SessionID>string</SessionID>
      <LocationID>long</LocationID>
      <LanguageCode>string</LanguageCode>
    </GetForecastWeather>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetForecastWeatherResponse xmlns="https://services.alarmnet.com/TC2/">
      <GetForecastWeatherResult>
        <WeatherData>
          <Unit>int</Unit>
          <Time>string</Time>
          <ForecastWeatherList>
            <ForecastWeatherRecord xsi:nil="true" />
            <ForecastWeatherRecord xsi:nil="true" />
          </ForecastWeatherList>
        </WeatherData>
      </GetForecastWeatherResult>
    </GetForecastWeatherResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /tc21api/tc2.asmx/GetForecastWeather?SessionID=string&LocationID=string&LanguageCode=string HTTP/1.1
Host: rs.alarmnet.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ForecastWeatherResult xmlns="https://services.alarmnet.com/TC2/">
  <WeatherData>
    <Unit>int</Unit>
    <Time>string</Time>
    <ForecastWeatherList>
      <ForecastWeatherRecord>
        <Day>int</Day>
        <DayCode>string</DayCode>
        <Date>string</Date>
        <WeatherText>string</WeatherText>
        <WeatherIcon>int</WeatherIcon>
        <HighTemperature>int</HighTemperature>
        <LowTemperature>int</LowTemperature>
      </ForecastWeatherRecord>
      <ForecastWeatherRecord>
        <Day>int</Day>
        <DayCode>string</DayCode>
        <Date>string</Date>
        <WeatherText>string</WeatherText>
        <WeatherIcon>int</WeatherIcon>
        <HighTemperature>int</HighTemperature>
        <LowTemperature>int</LowTemperature>
      </ForecastWeatherRecord>
    </ForecastWeatherList>
  </WeatherData>
</ForecastWeatherResult>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /tc21api/tc2.asmx/GetForecastWeather HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&LocationID=string&LanguageCode=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ForecastWeatherResult xmlns="https://services.alarmnet.com/TC2/">
  <WeatherData>
    <Unit>int</Unit>
    <Time>string</Time>
    <ForecastWeatherList>
      <ForecastWeatherRecord>
        <Day>int</Day>
        <DayCode>string</DayCode>
        <Date>string</Date>
        <WeatherText>string</WeatherText>
        <WeatherIcon>int</WeatherIcon>
        <HighTemperature>int</HighTemperature>
        <LowTemperature>int</LowTemperature>
      </ForecastWeatherRecord>
      <ForecastWeatherRecord>
        <Day>int</Day>
        <DayCode>string</DayCode>
        <Date>string</Date>
        <WeatherText>string</WeatherText>
        <WeatherIcon>int</WeatherIcon>
        <HighTemperature>int</HighTemperature>
        <LowTemperature>int</LowTemperature>
      </ForecastWeatherRecord>
    </ForecastWeatherList>
  </WeatherData>
</ForecastWeatherResult>