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

<back to all web services

ChannelGet

Returns a list of all channel records for the specified callsign (most recent first).

The following routes are available for this service:
POST,GET/channel/get
ChannelGet Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesGateway Callsign (may include SSID)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
ChannelGetResponse 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 .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 /channel/get HTTP/1.1 
Host: wien.winlink.org 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<ChannelGetResponse 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>
  <Channels>
    <ChannelRecord>
      <BaseCallsign>String</BaseCallsign>
      <Baud>0</Baud>
      <Callsign>String</Callsign>
      <Direction>0</Direction>
      <Frequency>0</Frequency>
      <Gain>0</Gain>
      <GridSquare>String</GridSquare>
      <Height>0</Height>
      <Mode>0</Mode>
      <OperatingHours>String</OperatingHours>
      <Power>0</Power>
      <ServiceCode>String</ServiceCode>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
    </ChannelRecord>
  </Channels>
</ChannelGetResponse>