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

<back to all web services

ActivitySummaryGet

Returns the system activity summary for the specificed period.

The following routes are available for this service:
POST,GET/activity/summary
POST,GET/activitySummary/get
ActivitySummaryGet Parameters:
NameParameterData TypeRequiredDescription
PeriodbodystringNoSpecific period (YYYYMM) default: Current year/month
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
ActivitySummaryGetResponse Parameters:
NameParameterData TypeRequiredDescription
PeriodformstringNo
TotalReceivedPacketformintNo
TotalSentPacketformintNo
TotalReceivedAprsformintNo
TotalSentAprsformintNo
TotalReceivedWebformintNo
TotalSentWebformintNo
P1ConnectionsformintNo
P2ConnectionsformintNo
P3ConnectionsformintNo
P4ConnectionsformintNo
Winmor500ConnectionsformintNo
Winmor1600ConnectionsformintNo
RobustPacketConnectionsformintNo
Ardop200ConnectionsformintNo
Ardop500ConnectionsformintNo
Ardop1000ConnectionsformintNo
Ardop2000ConnectionsformintNo
Ardop2000FMConnectionsformintNo
HfMessagesReveivedformintNo
HfMessagesSentformintNo
HfBytesReveivedformintNo
HfBytesSentformintNo
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 /activity/summary HTTP/1.1 
Host: cms.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<ActivitySummaryGetResponse 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>
  <Ardop1000Connections>0</Ardop1000Connections>
  <Ardop2000Connections>0</Ardop2000Connections>
  <Ardop2000FMConnections>0</Ardop2000FMConnections>
  <Ardop200Connections>0</Ardop200Connections>
  <Ardop500Connections>0</Ardop500Connections>
  <HfBytesReveived>0</HfBytesReveived>
  <HfBytesSent>0</HfBytesSent>
  <HfMessagesReveived>0</HfMessagesReveived>
  <HfMessagesSent>0</HfMessagesSent>
  <P1Connections>0</P1Connections>
  <P2Connections>0</P2Connections>
  <P3Connections>0</P3Connections>
  <P4Connections>0</P4Connections>
  <Period>String</Period>
  <RobustPacketConnections>0</RobustPacketConnections>
  <TotalReceivedAprs>0</TotalReceivedAprs>
  <TotalReceivedPacket>0</TotalReceivedPacket>
  <TotalReceivedWeb>0</TotalReceivedWeb>
  <TotalSentAprs>0</TotalSentAprs>
  <TotalSentPacket>0</TotalSentPacket>
  <TotalSentWeb>0</TotalSentWeb>
  <Winmor1600Connections>0</Winmor1600Connections>
  <Winmor500Connections>0</Winmor500Connections>
</ActivitySummaryGetResponse>