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

<back to all web services

AprsPosition

Inserts an APRS object into the APRS-IS data stream using Callsign as the object name.

The following routes are available for this service:
POST,GET/aprs/position/send
AprsPosition Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesStation callsign (may include SSID)
LocationbodyCoordinatesRecordYesCurrent location (Gridsquare and/or lat/lon)
SymbolCharbodystringNoSymbol character (default: '>')
OverlayCharbodystringNoSymbol table or overlay character (default: '/')
CommentbodystringNoShort comment relating to position report
AlternateFromCallbodystringNoAlternate from call - default: WINLINK
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
CoordinatesRecord Parameters:
NameParameterData TypeRequiredDescription
LatitudeformdoubleNo
LongitudeformdoubleNo
GridsquareformstringNo
AprsPositionResponse Parameters:
NameParameterData TypeRequiredDescription
PacketformstringNo
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 /aprs/position/send HTTP/1.1 
Host: cms.winlink.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Callsign":"String","Location":{"Latitude":0,"Longitude":0,"Gridsquare":"String"},"SymbolChar":"String","OverlayChar":"String","Comment":"String","AlternateFromCall":"String","Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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