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

<back to all web services

ActivitySummaryGet

Returns the system activity summary for the specificed period.

The following routes are available for this service:
POST,GET/activity/summary
POST,GET/activitySummary/get
ActivitySummaryGet Parameters:
NameParameterData TypeRequiredDescription
PeriodbodystringNoSpecific period (YYYYMM) default: Current year/month
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
ActivitySummaryGetResponse Parameters:
NameParameterData TypeRequiredDescription
PeriodformstringNo
TotalReceivedPacketformintNo
TotalSentPacketformintNo
TotalReceivedAprsformintNo
TotalSentAprsformintNo
TotalReceivedWebformintNo
TotalSentWebformintNo
P1ConnectionsformintNo
P2ConnectionsformintNo
P3ConnectionsformintNo
P4ConnectionsformintNo
Winmor500ConnectionsformintNo
Winmor1600ConnectionsformintNo
RobustPacketConnectionsformintNo
Ardop200ConnectionsformintNo
Ardop500ConnectionsformintNo
Ardop1000ConnectionsformintNo
Ardop2000ConnectionsformintNo
Ardop2000FMConnectionsformintNo
HfMessagesReveivedformintNo
HfMessagesSentformintNo
HfBytesReveivedformintNo
HfBytesSentformintNo
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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 /activity/summary HTTP/1.1 
Host: wien.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	Period: String,
	TotalReceivedPacket: 0,
	TotalSentPacket: 0,
	TotalReceivedAprs: 0,
	TotalSentAprs: 0,
	TotalReceivedWeb: 0,
	TotalSentWeb: 0,
	P1Connections: 0,
	P2Connections: 0,
	P3Connections: 0,
	P4Connections: 0,
	Winmor500Connections: 0,
	Winmor1600Connections: 0,
	RobustPacketConnections: 0,
	Ardop200Connections: 0,
	Ardop500Connections: 0,
	Ardop1000Connections: 0,
	Ardop2000Connections: 0,
	Ardop2000FMConnections: 0,
	HfMessagesReveived: 0,
	HfMessagesSent: 0,
	HfBytesReveived: 0,
	HfBytesSent: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}