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

<back to all web services

SysopGet

Returns a sysop record.

The following routes are available for this service:
POST,GET/status/sysop/get
POST,GET/sysop/get
SysopGet Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesSysop callsign (no SSID)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
SysopGetResponse Parameters:
NameParameterData TypeRequiredDescription
SysopformSysopRecordNo
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
SysopRecord Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CallsignformstringNo
GridSquareformstringNo
SysopNameformstringNo
StreetAddress1formstringNo
StreetAddress2formstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
PostalCodeformstringNo
EmailformstringNo
PhonesformstringNo
WebsiteformstringNo
CommentsformstringNo

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/get HTTP/1.1 
Host: halifax.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Callsign: String,
	Key: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Sysop: 
	{
		Timestamp: 0001-01-01,
		Callsign: 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
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}