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

<back to all web services

PositionReportsNearby

Returns a list of position reports near the last reported position of the specificed callsign.

The following routes are available for this service:
POST,GET/position/reports/nearby
PositionReportsNearby Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesStation callsign
DistanceLimitNmbodyintNoDistance from source in nautical miles (default: 100)
ReportAgeLimitDaysbodyintNoMaximum age (in days) of position reports to include (default: 14)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
PositionReportsNearbyResponse Parameters:
NameParameterData TypeRequiredDescription
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 /position/reports/nearby HTTP/1.1 
Host: perth.winlink.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Callsign":"String","DistanceLimitNm":0,"ReportAgeLimitDays":0,"Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"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"}}}