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

<back to all web services

SystemStats

Returns assorted system statistics.

The following routes are available for this service:
All Verbs/system/stats
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
SystemStatusResponse Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
AvailableRamformstringNo
QueueCountsformQueueCountsNo
WebServiceVersionformstringNo
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
QueueCounts Parameters:
NameParameterData TypeRequiredDescription
RmsInboundCountformintNo
SmtpInboundCountformintNo
ActivityCountformintNo
SmtpQueueCountformintNo
RpQueueCountformintNo
PrQueueCountformintNo
MessagesPendingDeliveryformintNo

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 /system/stats HTTP/1.1 
Host: cms.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	Timestamp: 0001-01-01,
	AvailableRam: String,
	QueueCounts: 
	{
		RmsInboundCount: 0,
		SmtpInboundCount: 0,
		ActivityCount: 0,
		SmtpQueueCount: 0,
		RpQueueCount: 0,
		PrQueueCount: 0,
		MessagesPendingDelivery: 0
	},
	WebServiceVersion: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}