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

<back to all web services

WhitelistGet

Returns a list of allowed and disallowed addresses for the specified callsign. Maximum request frequency - 30 minutes.

The following routes are available for this service:
POST,GET/whitelist/get
POST,GET/whitelist/list
WhitelistGet Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesAccount callsign (no SSID)
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
WhitelistGetResponse Parameters:
NameParameterData TypeRequiredDescription
AccessListformList<WhitelistRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
WhitelistRecord Parameters:
NameParameterData TypeRequiredDescription
AddressformstringNo
AllowformboolNo

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 /whitelist/get HTTP/1.1 
Host: wien.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

{
	AccessList: 
	[
		{
			Address: String,
			Allow: False
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}