YM REST Services

<back to all web services

MemberPasswordReset

The following routes are available for this service:
POST/Ams/MemberPasswordResetSend member password reset instructions to client via email.
MemberPasswordReset Parameters:
NameParameterData TypeRequiredDescription
UsernamebodystringNo
EmailbodystringNo
ClientIDbodyintNo
MobilebodyboolNo
ResetTokenbodystringNo
NewPasswordbodystringNo
MemberPasswordResetResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseCodeformResponseCodeNo
ResponseTextformstringNo
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 /Ams/MemberPasswordReset HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Username: String,
	Email: String,
	ClientID: 0,
	Mobile: False,
	ResetToken: String,
	NewPassword: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseCode: Success,
	ResponseText: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Username: String,
	Email: String,
	ClientID: 0,
	Mobile: False,
	ResetToken: String,
	NewPassword: String
}