CMS Web Services - v4.0.6532.13712 [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 .jsv suffix or ?format=jsv

HTTP + JSV

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

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

{
	PositionReports: 
	[
		{
			Timestamp: 0001-01-01,
			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
		}
	}
}