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

<back to all web services

AccountPasswordValidate

Verifies Password is correct for Callsign. Limited to 5 requests within a 5 minute period.

The following routes are available for this service:
POST/account/password/validate
AccountPasswordValidate Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesAccount callsign
PasswordbodystringYesAccount password
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
AccountPasswordValidateResponse Parameters:
NameParameterData TypeRequiredDescription
IsValidformboolNo
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 /account/password/validate HTTP/1.1 
Host: wien.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	IsValid: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}