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

<back to all web services

EmailAliasList

Returns a list of all elail aliases. Maximum request frequency - 5 minutes.

The following routes are available for this service:
POST,GET/emailAlias/list
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
EmailAliasListResponse Parameters:
NameParameterData TypeRequiredDescription
AliasListformList<EmailAliasRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
EmailAliasRecord Parameters:
NameParameterData TypeRequiredDescription
CallsignformstringNo
AliasformstringNo
AddressformstringNo

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

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

{
	AliasList: 
	[
		{
			Callsign: String,
			Alias: String,
			Address: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}