Connectors Reference

MSN Weather

MSN Weather gets you the very latest weather forecast, including temperature, humidity, precipitation for your location.

 

Status: Production

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

CurrentWeather (string Location, string units)

Get current weather

TodaysForecast (string Location, string units)

Get forecast for today

TomorrowsForecast (string Location, string units)

Get the forecast for tomorrow

GetMeasureUnits (string Location, string Measure, string units)

Get Measure Units

 

Triggers:

Name

Summary

OnCurrentWeatherChange (string Location, string Measure, string When, number Target, string units)

When the current weather changes

OnCurrentConditionsChange (string Location, string units)

When the current conditions change

 

Objects:

Name

Summary

CurrentWeather

 

GetMeasureUnitsResponseItem

 

WeatherForecast

 

 

Actions:

CurrentWeather

Summary: Get current weather

Description: Get the current weather for a location.

 

Syntax:

MSNWeather.CurrentWeather (string Location, string units)

 

Parameters:

Name

Type

Summary

Required

Related Action

Location

string

(Location)

The location search query.  Valid inputs are City, Region, State, Country, Landmark, PostalCode, and Lat.Long.

True

units

string

(Units)Values: [Imperial, Metric]

The measurement system used for all the meausre values in the request and response. Valid options are 'Imperial' and 'Metric'.

True

 

Returns:

          Type:CurrentWeather

 

TodaysForecast

Summary: Get forecast for today

Description: Get the forecast for the current day in the specified location.

 

Syntax:

MSNWeather.TodaysForecast (string Location, string units)

 

Parameters:

Name

Type

Summary

Required

Related Action

Location

string

(Location)

The location search query.  Valid inputs are City, Region, State, Country, Landmark, PostalCode, and Lat.Long.

True

units

string

(Units)Values: [Imperial, Metric]

The measurement system used for all the meausre values in the request and response. Valid options are 'Imperial' and 'Metric'.

True

 

Returns:

          Type:WeatherForecast

 

TomorrowsForecast

Summary: Get the forecast for tomorrow

Description: Get the forecast for tomorrow in the specified location.

 

Syntax:

MSNWeather.TomorrowsForecast (string Location, string units)

 

Parameters:

Name

Type

Summary

Required

Related Action

Location

string

(Location)

The location search query.  Valid inputs are City, Region, State, Country, Landmark, PostalCode, and Lat.Long.

True

units

string

(Units)Values: [Imperial, Metric]

The measurement system used for all the meausre values in the request and response. Valid options are 'Imperial' and 'Metric'.

True

 

Returns:

          Type:WeatherForecast

 

GetMeasureUnits

Summary: Get Measure Units

Description: Get Measure Units

 

Syntax:

MSNWeather.GetMeasureUnits (string Location, string Measure, string units)

 

Parameters:

Name

Type

Summary

Required

Related Action

Location

string

(Location)

The location search query.  Valid inputs are City, Region, State, Country, Landmark, PostalCode, and Lat.Long.

True

Measure

string

(Measure)Values: [Temperature, UV Index, Humidity, Wind Speed]

The weather measure used for this operation. Valid options are 'Temperature', 'UV Index', 'Humidity' or 'Wind Speed'.

True

units

string

(Units)Values: [Imperial, Metric]

The measurement system used for all the meausre values in the request and response. Valid options are 'Imperial' and 'Metric'.

True

 

Returns:

          Type:array of (GetMeasureUnitsResponseItem)

 

Triggers:

Trigger OnCurrentWeatherChange

Summary: When the current weather changes

Description: Triggers a new flow when the specified weather measure changes for a location.

 

Syntax:

MSNWeather.OnCurrentWeatherChange (string Location, string Measure, string When, number Target, string units)

 

Parameters:

Name

Type

Summary

Required

Related Action

Location

string

(Location)

The location search query.  Valid inputs are City, Region, State, Country, Landmark, PostalCode, and Lat.Long.

True

Measure

string

(Measure)Values: [Temperature, UV Index, Humidity, Wind Speed]

The weather measure used for this operation. Valid options are 'Temperature', 'UV Index', 'Humidity' or 'Wind Speed'.

True

When

string

(When the measure...)Values: [Is equal to, Goes over, Goes below]

The condition the trigger will be checking. Valid options are 'Is equal to', 'Goes over', or 'Goes below'. For example, if the measure is 'temperature' and this parameter is set to 'Goes below' then the trigger will fire when the temperature goes below the target value.

True

Target

number(float)

(Target)

The target value for the specified measure.

True

units

string

(Units)

The units for the measure value and the target value.

True

GetMeasureUnits

 

Returns:

          Type:CurrentWeather

 

Trigger OnCurrentConditionsChange

Summary: When the current conditions change

Description: Triggers a new flow when the conditions change for a location.

 

Syntax:

MSNWeather.OnCurrentConditionsChange (string Location, string units)

 

Parameters:

Name

Type

Summary

Required

Related Action

Location

string

(Location)

The location search query.  Valid inputs are City, Region, State, Country, Landmark, PostalCode, and Lat.Long.

True

units

string

(Units)Values: [Imperial, Metric]

The measurement system used for all the meausre values in the request and response. Valid options are 'Imperial' and 'Metric'.

True

 

Returns:

          Type:CurrentWeather

 


 

CurrentWeather

Summary:

Description:

 

          Properties:

Name

Type

Summary

responses

Responses

 

 

units

Units

 

 

 

Responses

Summary:

Description:

 

          Properties:

Name

Type

Summary

weather

Weather

 

 

source

Source

 

 

 

Weather

Summary:

Description:

 

          Properties:

Name

Type

Summary

current

Current

 

 

 

Current

Summary:

Description:

 

          Properties:

Name

Type

Summary

baro

number(float)

Pressure

The atmospheric pressure.

cap

string

Conditions

A caption of weather conditions such as rainy, sunny, etc.

dewPt

number(float)

Dewpoint

The temperature at which dew forms.

feels

number(float)

Apparent Temperature

The apparent temperature, or feels-like temperature.

rh

number(float)

Humidity

The relative humidity percentage.

wx

string

METAR weather conditions

The METAR code of weather conditions.

sky

string

METAR Sky Conditions

The METAR code of sky conditions.

temp

number(float)

Temperature

The current temperature.

uv

number(float)

UV Index

The numerical UV index.

uvDesc

string

UV Index Description

A description of the meaning of the UV index.

vis

number(float)

Visibility Distance

The visibility distance.

windDir

integer(int32)

Wind Direction

The wind direction in degrees clockwise from north.

windSpd

number(float)

Wind Speed

The wind speed.

windGust

number(float)

Wind Gust Speed

The wind gust speed.

created

string(date-time)

Last Updated

The datetime at which provider created the current condition.

 

Source

Summary:

Description:

 

          Properties:

Name

Type

Summary

coordinates

Coordinates

 

 

clickThrough

string

Click-through Link

The URL to the full weather details.

location

string

Location

The location for which provider created the current condition.

 

Coordinates

Summary:

Description:

 

          Properties:

Name

Type

Summary

lat

number(float)

Latitude

The latitude of the location.

lon

number(float)

Longitude

The longitude of the location.

 

Units

Summary:

Description:

 

          Properties:

Name

Type

Summary

system

string

Unit System

Units used in data set (metric or imperial).

pressure

string

Pressure Units

Units used for pressure measurements.

temperature

string

Temperature Units

Units used for temperature measurements.

speed

string

Speed Units

Units used for speed measurements.

distance

string

Distance Units

Units used for distance measurements.

 


 

GetMeasureUnitsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayText

string

 

 

units

string

 

 


 

WeatherForecast

Summary:

Description:

 

          Properties:

Name

Type

Summary

responses

Responses

 

 

units

Units

 

 

 

Responses

Summary:

Description:

 

          Properties:

Name

Type

Summary

daily

Daily

 

 

almanac

Almanac

 

 

source

Source

 

 

 

Daily

Summary:

Description:

 

          Properties:

Name

Type

Summary

day

Day

Day

 

night

Night

Night

 

pvdrCap

string

Conditions

The caption of weather conditions such as rainy, sunny, etc.

valid

string(date-time)

Date

The datetime at which the forecast is valid.

precip

number(float)

Rain Chance

The chance of precipitation (%).

windMax

number(float)

Max Wind Speed

The peak wind speed for the day.

windMaxDir

integer(int32)

Max Wind Direction

The direction of the peak wind for the day.

rhHi

number(float)

Humidity High

The high relative humidity point for the day.

rhLo

number(float)

Humidity Low

The low relative humidity point for the day.

tempHi

number(float)

Temperature High

The high temperature.

tempLo

number(float)

Temperature Low

The low temperature.

uv

number(float)

UV Index

The numerical UV index.

uvDesc

string

UV Index Description

A description of the meaning of the UV index.

created

string(date-time)

Forecast Date

The datetime at which the daily forecast was dervied.

 

Day

Summary: Day

Description:

 

          Properties:

Name

Type

Summary

cap

string

Conditions

The caption of weather conditions such as rainy, sunny, etc.

precip

number(float)

Rain Chance

The chance of precipitation (%).

wx

string

METAR Weather Conditions

The METAR code of weather conditions.

sky

string

METAR Sky Conditions

The METAR code of sky conditions.

windDir

integer(int32)

Wind Direction

The wind direction in degrees clockwise from north.

windSpd

number(float)

Wind Speed

The wind speed.

summary

string

Summary

A text summary of the forecast.

 

Night

Summary: Night

Description:

 

          Properties:

Name

Type

Summary

cap

string

Conditions

The caption of weather conditions such as rainy, sunny, etc.

precip

number(float)

Rain Chance

The chance of precipitation (%).

wx

string

METAR Weather Conditions

The METAR code of weather conditions.

sky

string

METAR Sky Conditions

The METAR code of sky conditions.

windDir

integer(int32)

Wind Direction

The wind direction in degrees clockwise from north.

windSpd

number(float)

Wind Speed

The wind speed.

summary

string

Summary

A text summary of the forecast.

 

Almanac

Summary:

Description:

 

          Properties:

Name

Type

Summary

sunrise

string(date-time)

Sunrise Time

Time of sunrise on the day of this forecast.

sunset

string(date-time)

Sunset Time

Time of sunset on the day of this forecast.

moonrise

string(date-time)

Moonrise Time

Time of moonrise on the day of this forecast.

moonset

string(date-time)

Moonset Time

Time of moonset on the day of this forecast.

moonPhase

string

Moon Phase

The phase of the moon the day of this forecast.

moonPhaseCode

string

Moon Phase Code

The code representing the phase of the moon.

 

Source

Summary:

Description:

 

          Properties:

Name

Type

Summary

coordinates

Coordinates

 

 

clickThrough

string

Click-through Link

The URL back to the full weather details.

location

string

Location

The location for which provider created the forecast.

 

Coordinates

Summary:

Description:

 

          Properties:

Name

Type

Summary

lat

number(float)

Latitude

The latitude of the location.

lon

number(float)

Longitude

The longitude of the location.

 

Units

Summary:

Description:

 

          Properties:

Name

Type

Summary

system

string

Unit System

Units used in data set (metric or imperial).

pressure

string

Pressure Units

Units used for pressure measurements.

temperature

string

Temperature Units

Units used for temperature measurements.

speed

string

Speed Units

Units used for speed measurements.

distance

string

Distance Units

Units used for distance measurements.