OnTheSnow.com Web Service V2.0 Documentation

The SnowReport Web Service offered by OnTheSnow.com allows media organizations to add real time snow reports and resort information for ski resorts throughout the world.

Supported Interfaces

REST

Our REST services support both XML and JSON responses.

WDSL 2.0: http://services.onthesnow.com/axis2/services/SnowReport2009.wsdl

The REST urls are located in the WSDL SnowReport2009HttpBinding

We are currently in the process of building out tools to help in the parsing and accessing of our web services.

SOAP

Our SOAP services support both SOAP 1 and SOAP 2 bindings

WDSL 1.1: http://services.onthesnow.com/axis2/services/SnowReport2009SOAP.wsdl

Axis2 is the current platform we are running our webservice on. We use Document/Literal encoding.

The SOAP service is for advanced users. The document below is geared towards RESTful users, however the fields and objects returned are identical for each service.

The WSDL is the document for the SOAP service. This should be used to build your applications.

We use SOAPSonar Personal (SOAP client GUI) to validate and test our service, from CrossCheck Networks. You can learn about their Free Personal version at CrossCheck Networks

Authentication

Authentication is handled soley in the URL of the request. NO STATE information is preserved by there service.

Getting my Tokens

When you sign up for the webservice you will receive and email and a password. You can get your tokens by using the tokens request by using the URL below.

Authentication Parameters

Authentication Errors

Check your password and username

Check your token/domain to make sure they are correct.

Languages And Metrics

The default language for the service is English with imperial units.

The language and metric can be changed by using the parameters

Note: You must include both language and metric in your query string to override the default language. You need to check the signature of the method to ensure you have the correct ordering.

We currently support the following lanugages:

Credit Lines

Credit line and attribution links on any application, page, screen or window presentation of the data.

Global Attribution information is available via the getSiteAttribution method.

Resort Attribution information is avalable via the getResortAttribution method.

Request Methods Index

• getRegion
• getRegionCams
• getRegionPhotos
• getRegionResortsLastUpdated
• getRegionSnowReportMobile
• getRegionSnowReportMobilePlus
• getRegionSnowReportWeb
• getRegions
• getResortAttribution
• getResortCams
• getResortInfoLite
• getResortInfoMobile
• getResortInfoMobilePlus
• getResortInfoWeb
• getResortInformation
• getResortPhotos
• getResortSnowReportLite
• getResortSnowReportMobile
• getResortSnowReportMobilePlus
• getResortSnowReportWeb
• getResortsSnowReportLite
• getResortsSnowReportMobile
• getResortsSnowReportMobilePlus
• getResortsSnowReportWeb
• getSiteAttribution
• getTokens
• searchResortsByGeocode
• searchResortsByName
• template

Response Objects Index

• Attribution
• Cam
• Forecast
• Photo
• Region
• ResortAttribution
• ResortInfoLite
• ResortInfoMobile
• ResortInfoMobilePlus
• ResortInfoWeb
• ResortSearch
• ResortSnowReportLite
• ResortSnowReportMobile
• ResortSnowReportMobilePlus
• ResortSnowReportWeb
• ResortUpdateRecord
• State
• Weather

Request Methods

getRegion

Objects | Methods | _top

Request
Response
Response Object
Optional Parameters
Signature	token #in domain #in region_id #in lang #in met #in return #return
Address	region/states/{region_id}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/region/states/10/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getRegion Response

getRegionCams

Objects | Methods | _top

Gets a list of snow cams for a state.

NOTE:Requires access to the OTS Cams service

Request	Requires a state_abbrev and optional resort_id[].
Response	Returns upto 5 cams per resort.
Response Object	Cam[]
Optional Parameters	?resort_id=[resort_id]&lang=[lang]&met=>[met]
Signature	token #in domain #in state_abbrev #in resort_id #in lang #in met #in return #return
Address	state/cams/{state_abbrev}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/state/cams/CN/DOMAIN/TOKEN?&resort_id=5&resort_id=419&resort_id=21&lang=en&met=imp&&
XML Response	Sample getRegionCams Response

getRegionPhotos

Objects | Methods | _top

Gets a list of photos for a state. .

NOTE:Requires access to the OTS Cams service

Request	Requires a state_abbrev and optional resort_id[].
Response	List of Photo objects
Response Object	Photo[]
Optional Parameters	?resort_id=[resort_id]&lang=[lang]&met=>[met]
Signature	token #in domain #in state_abbrev #in resort_id #in lang #in met #in return #return
Address	state/photos/{state_abbrev}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/state/photos/CN/DOMAIN/TOKEN?&resort_id=5&resort_id=419&resort_id=21&lang=en&met=imp&&
XML Response	Sample getRegionPhotos Response

getRegionResortsLastUpdated

Objects | Methods | _top

Get a list of ResortUpdateRecord objects which tells when the last time a resort's info and snowreport was updated.

NOTE:Available to all subscribers to the service.

Request	Requires a state_abbrev element to pull down the list of resort in the state.
Response	Receives a list of ResortUpdateRecord.
Response Object	ResortUpdateRecord
Optional Parameters	?lang=[lang]&met=>[met]&[ resort_id=[] ...]
Signature	token #in domain #in state_abbrev #in lang #in met #in resort_id #in return #return
Address	region/{state_abbrev}/resorts/lastupdate/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/region/CN/resorts/lastupdate/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getRegionResortsLastUpdated Response

getRegionSnowReportMobile

Objects | Methods | _top

Get a more detailed SnowReport for resorts in a State/Region.

NOTE:Requires access to the Mobile services

Request	The method has an optional list of resort_id parameters, which limits the response to only resorts in the list.
Response	Returns a list ResortSnowReportMobile objects.
Response Object	ResortSnowReportMobile[]
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in state_abbrev #in lang #in met #in resort_id #in return #return
Address	mobile/region/resorts/snow/{state_abbrev}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/mobile/region/resorts/snow/CN/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getRegionSnowReportMobile Response

getRegionSnowReportMobilePlus

Objects | Methods | _top

Get the most detailed SnowReport for resorts in a State/Region.

NOTE:Requires access to the MobilePlus services

Request	The method has an optional list of resort_id parameters, which limits the response to only resorts in the list.
Response	Returns a list ResortSnowReportMobilePlus objects.
Response Object	ResortSnowReportMobilePlus[]
Optional Parameters	?lang=[lang]&met=>[met]&resort_id
Signature	token #in domain #in state_abbrev #in lang #in met #in resort_id #in return #return
Address	plus/region/resorts/snow/{state_abbrev}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/plus/region/resorts/snow/CN/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getRegionSnowReportMobilePlus Response

getRegionSnowReportWeb

Objects | Methods | _top

Request
Response
Response Object
Optional Parameters
Signature	token #in domain #in state_abbrev #in lang #in met #in resort_id #in return #return
Address	web/region/resorts/snow/{state_abbrev}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/web/region/resorts/snow/CN/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getRegionSnowReportWeb Response

getRegions

Objects | Methods | _top

Gets a list of Region elements which contain all the State/Provinces listed by OTS. The method can be used to retrieve the list of state names and state abbrev to pull down information from the region specific servcies.

Request
Response	The getRegions request will return a list of Region elements.
Response Object
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in lang #in met #in return #return
Address	regions/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/regions/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getRegions Response

getResortAttribution

Objects | Methods | _top

Gets the credit line data for resortd in SnowReport service.

Request	Requires a resort_id.
Response	Returns an ResortAttribution object.
Response Object	ResortAttribution
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in resort_id #in lang #in met #in return #return
Address	attribution/resort/{resort_id}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/attribution/resort/330/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getResortAttribution Response

getResortCams

Objects | Methods | _top

Gets a list of snow cams for a given resort.

NOTE:Requires access to the OTS Cams service.

Request	Requires a resort_id parameter.
Response	Returns a maximum of 5 Cam Objects.
Response Object	Cam[]
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in resort_id #in lang #in met #in return #return
Address	resort/cams/{resort_id}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/resort/cams/330/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getResortCams Response

getResortInfoLite

Objects | Methods | _top

Gets a minimal view of the resorts information.

NOTE:Available to all subscribers to the service.

Request
Response	Returns a ResortInfoLite object
Response Object	ResortInfoLite
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in resort_id #in lang #in met #in return #return
Address	lite/resort/info/{resort_id}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/lite/resort/info/330/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getResortInfoLite Response

getResortInfoMobile

Objects | Methods | _top

Gets a more detailed view of the resort's information.

NOTE:Requires access to the Mobile services

Request	The method requires a resort element with value of resort_id.
Response	Returns a ResortInfoMobile object.
Response Object	ResortInfoMobile
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in resort_id #in lang #in met #in return #return
Address	mobile/resort/info/{resort_id}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/mobile/resort/info/330/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getResortInfoMobile Response

getResortInfoMobilePlus

Objects | Methods | _top

Gets the most detailed view of a resort's information.

NOTE:Requires access to the MobilePlus services.

Request	The method requires a resort element with value of resort_id.
Response	Returns a ResortInfoMobilePlus object.
Response Object	ResortInfoMobilePlus
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in resort_id #in lang #in met #in return #return
Address	plus/resort/info/{resort_id}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/plus/resort/info/330/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getResortInfoMobilePlus Response

getResortInfoWeb

Objects | Methods | _top

Gets a detailed view of the resorts information

NOTE:Requires access to the "Web" services.

Request	Requires a resort_id.
Response	Returns a ResortInfoWeb object
Response Object	ResortInfoWeb
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in resort_id #in lang #in met #in return #return
Address	web/resort/info/{resort_id}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/web/resort/info/330/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getResortInfoWeb Response

getResortInformation

Objects | Methods | _top

Request
Response
Response Object
Optional Parameters
Signature	token #in domain #in resort_id #in lang #in met #in return #return
Address	getResortInformation
Example URI
XML Response	Sample getResortInformation Response

getResortPhotos

Objects | Methods | _top

Gets a list of resort provided photos for a given resort.

NOTE:Requires access to the OTS Cams service.

Request	Requires a resort_id parameter.
Response	Returns a maximum of 5 Photo Objects.
Response Object	Photo[]
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in resort_id #in lang #in met #in return #return
Address	resort/photos/{resort_id}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/resort/photos/120/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getResortPhotos Response

getResortSnowReportLite

Objects | Methods | _top

Get a minimal SnowReport for a resort.

NOTE:Available to all subscribers to the service.

Request	The method requires a resort element with value of resort_id.
Response	Returns a ResortSnowReportLite object.
Response Object	ResortSnowReportLite
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in resort_id #in lang #in met #in return #return
Address	lite/resort/snow/{resort_id}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/lite/resort/snow/330/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getResortSnowReportLite Response

getResortSnowReportMobile

Objects | Methods | _top

Get a more detailed SnowReport for a resort. Includes weather, a cam, and all our snowreporting data points.

NOTE:Requires access to the Mobile services

Request	The method requires a resort element with value of resort_id.
Response	Returns a ResortSnowReportMobile object.
Response Object	ResortSnowReportMobile
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in resort_id #in lang #in met #in return #return
Address	mobile/resort/snow/{resort_id}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/mobile/resort/snow/330/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getResortSnowReportMobile Response

getResortSnowReportMobilePlus

Objects | Methods | _top

Get the most detailed SnowReport for a resort. Includes weather, forecasts, a cam and all our snowreporting data points.

NOTE:Requires access to the MobilePlus services

Request	The method requires a resort element with value of resort_id.
Response	Returns a ResortSnowReportMobilePlus object.
Response Object	ResortSnowReportMobilePlus
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in resort_id #in lang #in met #in return #return
Address	plus/resort/snow/{resort_id}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/plus/resort/snow/330/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getResortSnowReportMobilePlus Response

getResortSnowReportWeb

Objects | Methods | _top

Get the most detailed SnowReport for a resort Can be bundled with Weather and Cams.

NOTE:Requires access to the "Web" services

Request	The method requires a resort element with value of resort_id.
Response	Returns a ResortSnowReportWeb object.
Response Object	ResortSnowReportWeb
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in resort_id #in lang #in met #in return #return
Address	web/resort/snow/{resort_id}/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/web/resort/snow/330/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getResortSnowReportWeb Response

getResortsSnowReportLite

Objects | Methods | _top

Get a minimal SnowReport for a resort.

NOTE:Available to all subscribers to the service.

Request	The method requires a list of resort_id parameters.
Response	Returns a list of ResortSnowReportLite objects.
Response Object	ResortSnowReportLite[]
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in resort_id #in lang #in met #in return #return
Address	lite/resorts/snow/{domain}/{token}
Example URI
XML Response	Sample getResortsSnowReportLite Response

getResortsSnowReportMobile

Objects | Methods | _top

Get a more detailed SnowReport for a resort. Includes weather, a cam, and all our snowreporting data points.

NOTE:Requires access to the Mobile services

Request	The method requires a list of resort_id parameters.
Response	Returns a list ResortSnowReportMobile objects.
Response Object	ResortSnowReportMobile[]
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in resort_id #in lang #in met #in return #return
Address	mobile/resorts/snow/{domain}/{token}
Example URI
XML Response	Sample getResortsSnowReportMobile Response

getResortsSnowReportMobilePlus

Objects | Methods | _top

Get the most detailed SnowReport for up to 50 resorts. Includes weather, forecasts, a cam and all our snowreporting data points.

NOTE:Requires access to the MobilePlus services

Request	The method requires a list of resort_id parameters.
Response	Returns a list ResortSnowReportMobilePlus objects.
Response Object	ResortSnowReportMobilePlus[]
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in resort_id #in lang #in met #in return #return
Address	plus/resorts/snow/{domain}/{token}
Example URI
XML Response	Sample getResortsSnowReportMobilePlus Response

getResortsSnowReportWeb

Objects | Methods | _top

Get the most detailed SnowReport for up to 50 resorts. Can be bundled with weather, forecasts, and cam.

NOTE:Requires access to the "Web" services

Request	The method requires a list of resort_id parameters. ?resort_id=&resort_id=
Response	Returns a list ResortSnowReportWeb objects.
Response Object	ResortSnowReportWeb[]
Optional Parameters	&lang=[lang]&met=>[met]
Signature	token #in domain #in resort_id #in lang #in met #in return #return
Address	web/resorts/snow/{domain}/{token}
Example URI
XML Response	Sample getResortsSnowReportWeb Response

getSiteAttribution

Objects | Methods | _top

Gets the credit line data for the SnowReport service.

Request
Response	Returns an Attribution object.
Response Object	Attribution
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in lang #in met #in return #return
Address	attribution/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/attribution/DOMAIN/TOKEN?lang=en&met=imp&&
XML Response	Sample getSiteAttribution Response

getTokens

Objects | Methods | _top

Gets all the tokens and domain keys any web sites registered under your account. The tokens/domain keys are used authenticate with the SnowReport.

NOTE:The token/domain combination is the only way to authenticate with our V2009 web service. Email and password are no longer used.

Request
Response	You will receive a token response containing an array of Tokens with domain and token as elements
Response Object
Optional Parameters	?lang=[lang]&met=>[met]
Signature	email #in password #in language #in return #return
Address	tokens/{email}/{password}
Example URI
XML Response	Sample getTokens Response

searchResortsByGeocode

Objects | Methods | _top

Searches for resorts by distance from a provided latitude and longitude. The distance is either in miles or km as determined by met.

NOTE:Max return is 50 resorts.

Request	Requires a lat and lon [double,float,decimal], distance integer < 500, and string and a get_n to limit results to n.
Response	Returns a list of ResortSearch objects. Distance is rounded to nearest KM/MI. Orderd by distance ASC
Response Object	ResortSearch[]
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in lat #in lon #in distance #in get_n #in lang #in met #in return #return
Address	find/resorts/geo/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/find/resorts/geo/DOMAIN/TOKEN?lang=en&met=imp&&lat=38.00&lon=-121.00&get_n=10&distance=200
XML Response	Sample searchResortsByGeocode Response

searchResortsByName

Objects | Methods | _top

Searches for resorts by name, matchining search string as %search%. Orders by name.

NOTE:Max return is 50 resorts.

Request	Requires a search string and a get_n to limit results to n.
Response	Returns a list of ResortSearch objects.
Response Object	ResortSearch[]
Optional Parameters	?lang=[lang]&met=>[met]
Signature	token #in domain #in search #in get_n #in lang #in met #in return #return
Address	find/resorts/name/{domain}/{token}
Example URI	http://services.onthesnow.com/axis2/services/SnowReport2009/find/resorts/name/DOMAIN/TOKEN?lang=en&met=imp&&search=mammoth&get_n=10
XML Response	Sample searchResortsByName Response

template

Objects | Methods | _top

Request
Response
Response Object
Optional Parameters	?lang=[lang]&met=>[met]
Signature
Address
Example URI
XML Response	Sample template Response

Response Object