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

<back to all web services

ChannelList

Returns a list of channel records matching to the request crtiera.

The following routes are available for this service:
POST,GET/channel/list
ChannelList Parameters:
NameParameterData TypeRequiredDescription
ModesbodyList<int>NoOne or more operating modes (default: all)
HistoryHoursbodyintNoNumber of hours of history to include (default: 6)
ServiceCodesbodystringNoOne or more service codes (default: PUBLIC)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
ChannelListResponse Parameters:
NameParameterData TypeRequiredDescription
ChannelsformList<ChannelRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ChannelRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
BaseCallsignformstringNo
GridSquareformstringNo
FrequencyformintNo
ModeformintNo
BaudformintNo
PowerformintNo
HeightformintNo
GainformintNo
DirectionformintNo
OperatingHoursformstringNo
ServiceCodeformstringNo

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 /channel/list HTTP/1.1 
Host: cms.winlink.org 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Modes":[0],"HistoryHours":0,"ServiceCodes":"String","Key":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Channels":[{"Timestamp":"\/Date(-62135596800000-0000)\/","Callsign":"String","BaseCallsign":"String","GridSquare":"String","Frequency":0,"Mode":0,"Baud":0,"Power":0,"Height":0,"Gain":0,"Direction":0,"OperatingHours":"String","ServiceCode":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}