CMS Web Services - v4.0.6415.24723 [cms-a]

<back to all web services

SysopChannelsList

Returns an array of datastructures containing combined channel and sysop information. Maximum request frequency - 5 minutes.

The following routes are available for this service:
POST,GET/sysopChannels
POST,GET/sysop/channels
SysopChannelsList Parameters:
NameParameterData TypeRequiredDescription
HistoryHoursbodyintNoNumber of hours of history to include (default: 6)
OperatingModebodyGatewayOperatingModeNoOne of Packet, Pactor, Winmor, RobustPacket, or AnyAll (default: AnyAll)
ServiceCodesbodystringNoOne or more service codes (default: PUBLIC)
IncludeUnauthorizedbodyboolNoInclude informaiton for unauthorized gateways
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
SysopChannelsListResponse Parameters:
NameParameterData TypeRequiredDescription
ChannelListformList<SysopChannelsRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
SysopChannelsRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
BaseCallsignformstringNo
SysopNameformstringNo
StreetAddress1formstringNo
StreetAddress2formstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
PostalCodeformstringNo
EMailformstringNo
WebSiteformstringNo
GridsquareformstringNo
FrequencyformintNo
ModeformintNo
BaudformintNo
OperatingHoursformstringNo
ServiceCodeformstringNo
GatewayAuthorizedformboolNo
PhonesformstringNo

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 /xml/reply/SysopChannelsList HTTP/1.1 
Host: cms.winlink.org 
Content-Type: application/xml
Content-Length: length

<SysopChannelsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/winlink.cms.webservices">
  <Key>String</Key>
  <HistoryHours>0</HistoryHours>
  <IncludeUnauthorized>false</IncludeUnauthorized>
  <OperatingMode>AnyAll</OperatingMode>
  <ServiceCodes>String</ServiceCodes>
</SysopChannelsList>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SysopChannelsListResponse 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>
  <ChannelList>
    <SysopChannelsRecord>
      <BaseCallsign>String</BaseCallsign>
      <Baud>0</Baud>
      <Callsign>String</Callsign>
      <City>String</City>
      <Country>String</Country>
      <EMail>String</EMail>
      <Frequency>0</Frequency>
      <GatewayAuthorized>false</GatewayAuthorized>
      <Gridsquare>String</Gridsquare>
      <Mode>0</Mode>
      <OperatingHours>String</OperatingHours>
      <Phones>String</Phones>
      <PostalCode>String</PostalCode>
      <ServiceCode>String</ServiceCode>
      <State>String</State>
      <StreetAddress1>String</StreetAddress1>
      <StreetAddress2>String</StreetAddress2>
      <SysopName>String</SysopName>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
      <WebSite>String</WebSite>
    </SysopChannelsRecord>
  </ChannelList>
</SysopChannelsListResponse>