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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<WeatherReportAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <Key>String</Key>
  <WeatherReport>
    <AirTemperature>String</AirTemperature>
    <Barometer>String</Barometer>
    <Callsign>String</Callsign>
    <CloudCover>String</CloudCover>
    <Latitude>0</Latitude>
    <Longitude>0</Longitude>
    <SeaTemperature>String</SeaTemperature>
    <SwellDirection>String</SwellDirection>
    <SwellHeight>String</SwellHeight>
    <SwellPeriod>String</SwellPeriod>
    <Timestamp>0001-01-01T00:00:00</Timestamp>
    <Trend>String</Trend>
    <Visibility>String</Visibility>
    <WaveDirection>String</WaveDirection>
    <WaveHeight>String</WaveHeight>
    <WavePeriod>String</WavePeriod>
    <WindDirection>String</WindDirection>
    <WindSpeed>String</WindSpeed>
  </WeatherReport>
</WeatherReportAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WeatherReportAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</WeatherReportAddResponse>