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

HTTP + JSV

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

POST /jsv/reply/GatewayStats HTTP/1.1 
Host: cms.winlink.org 
Content-Type: text/jsv
Content-Length: length

{
	Callsign: String,
	ServiceCodes: String,
	Period: String,
	Key: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	GatewayStats: 
	[
		{
			Timestamp: 0001-01-01,
			Callsign: String,
			Period: String,
			Channel: String,
			TcpIp: 0,
			Packet: 0,
			Pactor1: 0,
			Pactor2: 0,
			Pactor3: 0,
			Pactor4: 0,
			Winmor500: 0,
			Winmor1600: 0,
			RobustPacket: 0,
			MessagesIn: 0,
			MessagesOut: 0,
			ServiceCode: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}