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

<back to all web services

CmsStatusGet

Returns usage information for all or the specified system node.

The following routes are available for this service:
POST,GET/cms/status/get
CmsStatusGet Parameters:
NameParameterData TypeRequiredDescription
NodeNamebodystringNoSpecific node name
HistoryHoursbodyintNoNumber of hours of history (default: 30 days)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
CmsStatusGetResponse Parameters:
NameParameterData TypeRequiredDescription
ActiveNodeNamesformList<string>No
TelnetConnectionsTotalformintNo
TelentConnectTimeAverageformdoubleNo
TelnetMessagesDeliveredformintNo
TelnetMessagesReceivedformintNo
SmtpMailConnectionsformintNo
PopMailConnectionsformintNo
InquiryConnectionsformintNo
InquiryConnectionsByTypeformDictionary<string, int>No
SmtpMessagesReceivedformintNo
SmtpMessagesDeliveredformintNo
PositionReportsReceivedformintNo
PositionRequestsReceivedformintNo
HistoryHoursformintNo
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 /cms/status/get HTTP/1.1 
Host: wien.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	ActiveNodeNames: 
	[
		String
	],
	TelnetConnectionsTotal: 0,
	TelentConnectTimeAverage: 0,
	TelnetMessagesDelivered: 0,
	TelnetMessagesReceived: 0,
	SmtpMailConnections: 0,
	PopMailConnections: 0,
	InquiryConnections: 0,
	InquiryConnectionsByType: 
	{
		String: 0
	},
	SmtpMessagesReceived: 0,
	SmtpMessagesDelivered: 0,
	PositionReportsReceived: 0,
	PositionRequestsReceived: 0,
	HistoryHours: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}