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

<back to all web services

SysopAdd

Add/update a sysop record. Limited to 5 requests within a 30 minute period.

The following routes are available for this service:
POST,GET/status/sysop/add
POST,GET/sysop/add
SysopAdd Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesSysop callsign (no SSID)
PasswordbodystringYesAccount password
GridSquarebodystringYes6 digit grid locator
SysopNamebodystringYes
StreetAddress1bodystringNo
StreetAddress2bodystringNo
CitybodystringNo
StatebodystringNo
CountrybodystringNo
PostalCodebodystringNo
EmailbodystringYes
PhonesbodystringNo
WebsitebodystringNo
CommentsbodystringNo
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 /status/sysop/add HTTP/1.1 
Host: wien.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Callsign: String,
	Password: String,
	GridSquare: String,
	SysopName: String,
	StreetAddress1: String,
	StreetAddress2: String,
	City: String,
	State: String,
	Country: String,
	PostalCode: String,
	Email: String,
	Phones: String,
	Website: String,
	Comments: 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
		}
	}
}