CMS Web Services - v4.0.6550.31684 [cms-a]

<back to all web services

PositionReportsRecent

Returns a list the most recent position reports. Maximum request frequency - 30 minutes.

The following routes are available for this service:
POST,GET/positionReports/recent
POST,GET/position/reports/recent
PositionReportsRecent Parameters:
NameParameterData TypeRequiredDescription
HistoryHoursbodyintNoNumber of hours of history to include (default: 2 weeks)
OnePerCallsignbodyboolNoTrue to include only the latest report from each callsign
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
PositionReportsRecentResponse Parameters:
NameParameterData TypeRequiredDescription
HistoryHoursformintNo
PositionReportsformList<PositionReportRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PositionReportRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
ReportedByformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
HeadingformstringNo
SpeedformstringNo
CommentformstringNo
MarineformboolNo
YotrepsformboolNo
LatitudeNMEAformstringNo
LongitudeNMEAformstringNo

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/recent HTTP/1.1 
Host: perth.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PositionReportsRecent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <Key>String</Key>
  <HistoryHours>0</HistoryHours>
  <OnePerCallsign>false</OnePerCallsign>
</PositionReportsRecent>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PositionReportsRecentResponse 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>
  <HistoryHours>0</HistoryHours>
  <PositionReports>
    <PositionReportRecord>
      <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>
    </PositionReportRecord>
  </PositionReports>
</PositionReportsRecentResponse>