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

<back to all web services

SystemStatus

Returns status of several CMS queues.

The following routes are available for this service:
POST,GET/systemStatus
POST,GET/queue/status
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 .csv suffix or ?format=csv

HTTP + CSV

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

POST /systemStatus HTTP/1.1 
Host: halifax.winlink.org 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

{"Timestamp":"\/Date(-62135596800000-0000)\/","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"}}}