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 .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 /session/list HTTP/1.1 
Host: perth.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<SessionListResponse 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>
  <Sessions>
    <SessionRecord>
      <Application>String</Application>
      <BytesReceived>0</BytesReceived>
      <BytesSent>0</BytesSent>
      <Client>String</Client>
      <ClientGrid>String</ClientGrid>
      <Cms>String</Cms>
      <Degrees>0</Degrees>
      <Frequency>0</Frequency>
      <HoldingSeconds>0</HoldingSeconds>
      <IdTag>String</IdTag>
      <Kilometers>0</Kilometers>
      <LastCommand>String</LastCommand>
      <MessagesReceived>0</MessagesReceived>
      <MessagesSent>0</MessagesSent>
      <Mode>String</Mode>
      <Server>String</Server>
      <ServerGrid>String</ServerGrid>
      <Sid>String</Sid>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
      <Version>String</Version>
    </SessionRecord>
  </Sessions>
</SessionListResponse>