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

<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 .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 /json/reply/PositionReportsAdd HTTP/1.1 
Host: cms.winlink.org 
Content-Type: application/json
Content-Length: length

{"PositionReport":{"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"},"Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}