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

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: cms.winlink.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"HistoryHours":0,"OnePerCallsign":false,"Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"HistoryHours":0,"PositionReports":[{"Timestamp":"\/Date(-62135596800000-0000)\/","Callsign":"String","ReportedBy":"String","Latitude":0,"Longitude":0,"Heading":"String","Speed":"String","Comment":"String","Marine":false,"Yotreps":false,"LatitudeNMEA":"String","LongitudeNMEA":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}