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

<back to all web services

PositionReportsAdd

Submit a new position report.

The following routes are available for this service:
POST,GET/positionReports/submit
POST,GET/positionReports/add
POST,GET/position/reports/add
PositionReportsAdd Parameters:
NameParameterData TypeRequiredDescription
PositionReportbodyPositionReportRecordYesPosition report parameters
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
PositionReportRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
ReportedByformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
HeadingformstringNo
SpeedformstringNo
CommentformstringNo
MarineformboolNo
YotrepsformboolNo
LatitudeNMEAformstringNo
LongitudeNMEAformstringNo
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 /positionReports/submit HTTP/1.1 
Host: cms.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PositionReportsAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <Key>String</Key>
  <PositionReport>
    <Callsign>String</Callsign>
    <Comment>String</Comment>
    <Heading>String</Heading>
    <Latitude>0</Latitude>
    <LatitudeNMEA>String</LatitudeNMEA>
    <Longitude>0</Longitude>
    <LongitudeNMEA>String</LongitudeNMEA>
    <Marine>false</Marine>
    <ReportedBy>String</ReportedBy>
    <Speed>String</Speed>
    <Timestamp>0001-01-01T00:00:00</Timestamp>
    <Yotreps>false</Yotreps>
  </PositionReport>
</PositionReportsAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PositionReportsAddResponse 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>
</PositionReportsAddResponse>