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

HTTP + XML

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: perth.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SystemStats xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <Key>String</Key>
</SystemStats>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SystemStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <AvailableRam>String</AvailableRam>
  <QueueCounts>
    <ActivityCount>0</ActivityCount>
    <MessagesPendingDelivery>0</MessagesPendingDelivery>
    <PrQueueCount>0</PrQueueCount>
    <RmsInboundCount>0</RmsInboundCount>
    <RpQueueCount>0</RpQueueCount>
    <SmtpInboundCount>0</SmtpInboundCount>
    <SmtpQueueCount>0</SmtpQueueCount>
  </QueueCounts>
  <Timestamp>0001-01-01T00:00:00</Timestamp>
  <WebServiceVersion>String</WebServiceVersion>
</SystemStatusResponse>