CMS Web Services - v4.0.6459.17834 [cms-b]

<back to all web services

WeatherReportAdd

Submit a new weather report.

The following routes are available for this service:
POST,GET/weatherReport/add
WeatherReportAdd Parameters:
NameParameterData TypeRequiredDescription
WeatherReportbodyWeatherReportRecordYesWeather report parameters
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
WeatherReportRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
BarometerformstringNo
TrendformstringNo
VisibilityformstringNo
CloudCoverformstringNo
WindSpeedformstringNo
WindDirectionformstringNo
SwellHeightformstringNo
SwellDirectionformstringNo
SwellPeriodformstringNo
WaveHeightformstringNo
WaveDirectionformstringNo
WavePeriodformstringNo
AirTemperatureformstringNo
SeaTemperatureformstringNo
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /weatherReport/add HTTP/1.1 
Host: cms.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	WeatherReport: 
	{
		Timestamp: 0001-01-01,
		Callsign: String,
		Latitude: 0,
		Longitude: 0,
		Barometer: String,
		Trend: String,
		Visibility: String,
		CloudCover: String,
		WindSpeed: String,
		WindDirection: String,
		SwellHeight: String,
		SwellDirection: String,
		SwellPeriod: String,
		WaveHeight: String,
		WaveDirection: String,
		WavePeriod: String,
		AirTemperature: String,
		SeaTemperature: String
	},
	Key: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}