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

HTTP + XML

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

<GatewayProximity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <Key>String</Key>
  <GridSquare>String</GridSquare>
  <HistoryHours>0</HistoryHours>
  <MaxDistance>0</MaxDistance>
  <OperatingMode>AnyAll</OperatingMode>
  <ServiceCodes>String</ServiceCodes>
</GatewayProximity>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GatewayProximityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <GatewayList>
    <GatewayPositionsRecord>
      <Baud>String</Baud>
      <Callsign>String</Callsign>
      <Distance>0</Distance>
      <Frequency>0</Frequency>
      <Gridsquare>String</Gridsquare>
      <Heading>0</Heading>
      <Mode>0</Mode>
      <ServiceCode>String</ServiceCode>
    </GatewayPositionsRecord>
  </GatewayList>
</GatewayProximityResponse>