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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ReportType: SystemSummary,
	HistoryDays: 0,
	HistoryHours: 0,
	Callsign: String,
	ServiceCodes: String,
	Key: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Report: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}