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

<back to all web services

ChannelAdd

Adds a (or updates an existing) channel record to the database.

The following routes are available for this service:
POST,GET/channel/add
ChannelAdd Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesChannel callsign (may include SSID)
BaseCallsignbodystringYesSysop base callsign (no SSID)
GridSquarebodystringYes6 digit grid locator
FrequencybodydoubleYeschannel frequency in hertz
ModebodyintYesNumber indicating mode(s) the channel supports
BaudbodyintNoTypically 1200 or 9600 for packet, 200 for P1, 600 for P2 and 3200 for P3
PowerbodyintNoRadiated power in watts
HeightbodyintNoAntenna height above average terrain
GainbodyintNoAntenna gain in db
DirectionbodyintNo360 for North, 0 for omnidirectional
HoursbodystringNoHours of operation (e.g., 00-23 for 24/7 operation)
ServiceCodebodystringNoOne or more service codes (default: PUBLIC)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /channel/add HTTP/1.1 
Host: perth.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Callsign: String,
	BaseCallsign: String,
	GridSquare: String,
	Frequency: 0,
	Mode: 0,
	Baud: 0,
	Power: 0,
	Height: 0,
	Gain: 0,
	Direction: 0,
	Hours: String,
	ServiceCode: String,
	Key: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}