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

<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 .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 /sysopChannels HTTP/1.1 
Host: cms.winlink.org 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"HistoryHours":0,"OperatingMode":"AnyAll","ServiceCodes":"String","IncludeUnauthorized":false,"Key":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ChannelList":[{"Timestamp":"\/Date(-62135596800000-0000)\/","Callsign":"String","BaseCallsign":"String","SysopName":"String","StreetAddress1":"String","StreetAddress2":"String","City":"String","State":"String","Country":"String","PostalCode":"String","EMail":"String","WebSite":"String","Gridsquare":"String","Frequency":0,"Mode":0,"Baud":0,"OperatingHours":"String","ServiceCode":"String","GatewayAuthorized":false,"Phones":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}