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

<back to all web services

GatewayStats

Returns an array of data structures showing connection statistics of the gateway.

The following routes are available for this service:
POST,GET/gateway/stats
POST,GET/gatewayStats
GatewayStats Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesGateway callsign (may include SSID)
ServiceCodesbodystringNoOne or more service codes (default: PUBLIC)
PeriodbodystringNoYear and month - YYYYMM (default: current year and month)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
GatewayStatsResponse Parameters:
NameParameterData TypeRequiredDescription
GatewayStatsformList<GatewayStatsRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
GatewayStatsRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
PeriodformstringNo
ChannelformstringNo
TcpIpformintNo
PacketformintNo
Pactor1formintNo
Pactor2formintNo
Pactor3formintNo
Pactor4formintNo
Winmor500formintNo
Winmor1600formintNo
RobustPacketformintNo
MessagesInformintNo
MessagesOutformintNo
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/stats HTTP/1.1 
Host: wien.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<GatewayStatsResponse 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>
  <GatewayStats>
    <GatewayStatsRecord>
      <Callsign>String</Callsign>
      <Channel>String</Channel>
      <MessagesIn>0</MessagesIn>
      <MessagesOut>0</MessagesOut>
      <Packet>0</Packet>
      <Pactor1>0</Pactor1>
      <Pactor2>0</Pactor2>
      <Pactor3>0</Pactor3>
      <Pactor4>0</Pactor4>
      <Period>String</Period>
      <RobustPacket>0</RobustPacket>
      <ServiceCode>String</ServiceCode>
      <TcpIp>0</TcpIp>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
      <Winmor1600>0</Winmor1600>
      <Winmor500>0</Winmor500>
    </GatewayStatsRecord>
  </GatewayStats>
</GatewayStatsResponse>