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

<back to all web services

ActivityReport

Returns one of several activity reports for the specificed period and callsign.

The following routes are available for this service:
POST,GET/activity/report
ActivityReport Parameters:
NameParameterData TypeRequiredDescription
ReportTypebodyActivityReportTypeYesReport Type: SystemSummary - requires HistoryDays > 0 and no more than 365. GatewaySummary - requires Callsign, HistoryDays > 0 and no more than 365. SystemActivity - requires HistoryDays > 0 and no more than 21. GatewayActivity - requires Callsign, HistoryDays > 0 and no more than 21. GatewayFrequency - requires ServiceCodes. UserActivity - requires Callsign, HistoryDays > 0 and no more than 21.
HistoryDaysbodyintNoNumber of days of history to include (default: 1)
HistoryHoursbodyintNoNumber of hours of history to include (default: 0)
CallsignbodystringYesStation Callsign (required sometimes)
ServiceCodesbodystringNoOne or more service codes (default: PUBLIC)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
ActivityReportResponse Parameters:
NameParameterData TypeRequiredDescription
ReportformstringNo
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/report HTTP/1.1 
Host: cms.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<ActivityReportResponse 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>
  <Report>String</Report>
</ActivityReportResponse>