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

<back to all web services

GatewayProximity

Returns a list of gateways correspanding to the request parameters. The list is sorted by distance from the supplied grid square. Maximum request frequency - 5 minutes.

The following routes are available for this service:
POST,GET/gateway/proximity
POST,GET/gatewayProximity
GatewayProximity Parameters:
NameParameterData TypeRequiredDescription
GridSquarebodystringYesGrid location
ServiceCodesbodystringNoOne or more service codes (default: PUBLIC)
HistoryHoursbodyintNoNumber of hours of history to include (default: 6)
MaxDistancebodyintNoDistance in miles to search (default: 0 - all)
OperatingModebodyGatewayOperatingModeNoOne of Packet, Pactor, Winmor, RobustPacket, or AnyAll (default: AnyAll)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
GatewayProximityResponse Parameters:
NameParameterData TypeRequiredDescription
GatewayListformList<GatewayPositionsRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
GatewayPositionsRecord Parameters:
NameParameterData TypeRequiredDescription
CallsignformstringNo
GridsquareformstringNo
FrequencyformintNo
ModeformintNo
BaudformstringNo
ServiceCodeformstringNo
DistanceformintNo
HeadingformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /gateway/proximity HTTP/1.1 
Host: halifax.winlink.org 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"GridSquare":"String","ServiceCodes":"String","HistoryHours":0,"MaxDistance":0,"OperatingMode":"AnyAll","Key":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"GatewayList":[{"Callsign":"String","Gridsquare":"String","Frequency":0,"Mode":0,"Baud":"String","ServiceCode":"String","Distance":0,"Heading":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}