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

<back to all web services

GatewayStatus

Returns an array of data structures showing the status of Winlink gateways.

The following routes are available for this service:
POST,GET/gateway/status
POST,GET/gatewayStatus
GatewayStatus Parameters:
NameParameterData TypeRequiredDescription
HistoryHoursbodyintNoNumber of hours of history to include (default: 6, maximun: 48)
ServiceCodesbodystringNoOne or more service codes (default: PUBLIC)
ModebodyGatewayOperatingModeNoOne of Packet, Pactor, Winmor, RobustPacket, AllHf, or AnyAll (default: AnyAll)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
GatewayStatusResponse Parameters:
NameParameterData TypeRequiredDescription
GatewaysformList<GatewayStatusRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
GatewayStatusRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
BaseCallsignformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
HoursSinceStatusformintNo
LastStatusformstringNo
CommentsformstringNo
RequestedModeformGatewayOperatingModeNo
GatewayChannelsformList<GatewayChannelRecord>No
GatewayChannelRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
SupportedModesformstringNo
ModeformintNo
GridsquareformstringNo
FrequencyformintNo
OperatingHoursformstringNo
BaudformstringNo
RadioRangeformstringNo
AntennaformstringNo
ServiceCodeformstringNo

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

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

<GatewayStatusResponse 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>
  <Gateways>
    <GatewayStatusRecord>
      <BaseCallsign>String</BaseCallsign>
      <Callsign>String</Callsign>
      <Comments>String</Comments>
      <GatewayChannels>
        <GatewayChannelRecord>
          <Antenna>String</Antenna>
          <Baud>String</Baud>
          <Frequency>0</Frequency>
          <Gridsquare>String</Gridsquare>
          <Mode>0</Mode>
          <OperatingHours>String</OperatingHours>
          <RadioRange>String</RadioRange>
          <ServiceCode>String</ServiceCode>
          <SupportedModes>String</SupportedModes>
          <Timestamp>0001-01-01T00:00:00</Timestamp>
        </GatewayChannelRecord>
      </GatewayChannels>
      <HoursSinceStatus>0</HoursSinceStatus>
      <LastStatus>String</LastStatus>
      <Latitude>0</Latitude>
      <Longitude>0</Longitude>
      <RequestedMode>AnyAll</RequestedMode>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
    </GatewayStatusRecord>
  </Gateways>
</GatewayStatusResponse>