CMS Web Services - v5.0.6589.15362 [cms-b]

<back to all web services

SessionList

Returns a list of session records matching the request parameters

The following routes are available for this service:
POST,GET/session/list
SessionList Parameters:
NameParameterData TypeRequiredDescription
HistoryHoursbodyintNoNumber of hours of history to include (default: 24)
ApplicationbodystringNoName of application (gateway)
ServerbodystringNoSpecific server (gateway) callsign
ModebodystringNoConnection mode (default: all modes)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
SessionListResponse Parameters:
NameParameterData TypeRequiredDescription
SessionsformList<SessionRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
SessionRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
ApplicationformstringNo
VersionformstringNo
CmsformstringNo
ServerformstringNo
ServerGridformstringNo
ClientformstringNo
ClientGridformstringNo
SidformstringNo
ModeformstringNo
FrequencyformintNo
KilometersformintNo
DegreesformintNo
LastCommandformstringNo
MessagesSentformintNo
MessagesReceivedformintNo
BytesSentformintNo
BytesReceivedformintNo
HoldingSecondsformintNo
IdTagformstringNo

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

HTTP + CSV

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

POST /session/list HTTP/1.1 
Host: halifax.winlink.org 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"HistoryHours":0,"Application":"String","Server":"String","Mode":"String","Key":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Sessions":[{"Timestamp":"\/Date(-62135596800000-0000)\/","Application":"String","Version":"String","Cms":"String","Server":"String","ServerGrid":"String","Client":"String","ClientGrid":"String","Sid":"String","Mode":"String","Frequency":0,"Kilometers":0,"Degrees":0,"LastCommand":"String","MessagesSent":0,"MessagesReceived":0,"BytesSent":0,"BytesReceived":0,"HoldingSeconds":0,"IdTag":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}