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

<back to all web services

RadioNetworkParamsAdd

Adds or replaces a parameter and value for the specified callsign.

The following routes are available for this service:
POST,GET/radioNetwork/params/add
POST,GET/radioNetwork/params/replace
POST,GET/radioNetwork/params/update
RadioNetworkParamsAdd Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesStation callsign
PasswordbodystringYesAccount password
ParambodystringYesParameter name
ValuebodystringNoParameter value
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 /radioNetwork/params/add HTTP/1.1 
Host: halifax.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Callsign: String,
	Password: String,
	Param: String,
	Value: 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
		}
	}
}