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

<back to all web services

ActivityGet

Returns a list of activity records for the specified callsign.

The following routes are available for this service:
POST,GET/activity/get
ActivityGet Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesCallsign
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
ActivityGetResponse Parameters:
NameParameterData TypeRequiredDescription
ActivityformList<ActivityRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ActivityRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
SourceformstringNo
ChannelformstringNo
ClientTypeformintNo
LinkTypeformintNo
ProtocolformintNo
MessagesInboundformintNo
MessagesOutboundformintNo
BytesInboundformintNo
BytesOutboundformintNo
ConnectTimeformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /activity/get HTTP/1.1 
Host: cms.winlink.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Callsign":"String","Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Activity":[{"Timestamp":"\/Date(-62135596800000-0000)\/","Callsign":"String","Source":"String","Channel":"String","ClientType":0,"LinkType":0,"Protocol":0,"MessagesInbound":0,"MessagesOutbound":0,"BytesInbound":0,"BytesOutbound":0,"ConnectTime":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}