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

<back to all web services

AccountPasswordChange

Changes the password for an existing callsign or tactical account. Password can be no less than 6 and no more than 12 characters long. Password can be blank for tactical accounts only.

The following routes are available for this service:
POST/account/password/change
AccountPasswordChange Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesAccount callsign or tactical address
OldPasswordbodystringYesCurrent account password
NewPasswordbodystringYesNew account password
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 /account/password/change HTTP/1.1 
Host: halifax.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Callsign: String,
	OldPassword: String,
	NewPassword: 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
		}
	}
}