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 .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 /cms/status/get HTTP/1.1 
Host: perth.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<CmsStatusGetResponse 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>
  <ActiveNodeNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ActiveNodeNames>
  <HistoryHours>0</HistoryHours>
  <InquiryConnections>0</InquiryConnections>
  <InquiryConnectionsByType xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringint>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:KeyValueOfstringint>
  </InquiryConnectionsByType>
  <PopMailConnections>0</PopMailConnections>
  <PositionReportsReceived>0</PositionReportsReceived>
  <PositionRequestsReceived>0</PositionRequestsReceived>
  <SmtpMailConnections>0</SmtpMailConnections>
  <SmtpMessagesDelivered>0</SmtpMessagesDelivered>
  <SmtpMessagesReceived>0</SmtpMessagesReceived>
  <TelentConnectTimeAverage>0</TelentConnectTimeAverage>
  <TelnetConnectionsTotal>0</TelnetConnectionsTotal>
  <TelnetMessagesDelivered>0</TelnetMessagesDelivered>
  <TelnetMessagesReceived>0</TelnetMessagesReceived>
</CmsStatusGetResponse>