Platform API

<back to all web services

PasswordReset

Reset password for the specified user

The following routes are available for this service:
All Verbs/api/account/passwordreset
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Reset password for the specified user
    */
    @Api(Description="Reset password for the specified user")
    public static class PasswordReset implements IPublicServiceModel
    {
        /**
        * New password for the user account
        */
        @ApiMember(Description="New password for the user account", Name="NewPassword")
        public String NewPassword = null;

        /**
        * Confirm the new password
        */
        @ApiMember(Description="Confirm the new password", Name="ConfirmPassword")
        public String ConfirmPassword = null;

        /**
        * Password Reset Token
        */
        @ApiMember(Description="Password Reset Token", Name="Token")
        public String Token = null;

        public UUID ApplianceId = null;
        public String SubdomainName = null;
        
        public String getNewPassword() { return NewPassword; }
        public PasswordReset setNewPassword(String value) { this.NewPassword = value; return this; }
        public String getConfirmPassword() { return ConfirmPassword; }
        public PasswordReset setConfirmPassword(String value) { this.ConfirmPassword = value; return this; }
        public String getToken() { return Token; }
        public PasswordReset setToken(String value) { this.Token = value; return this; }
        public UUID getApplianceId() { return ApplianceId; }
        public PasswordReset setApplianceId(UUID value) { this.ApplianceId = value; return this; }
        public String getSubdomainName() { return SubdomainName; }
        public PasswordReset setSubdomainName(String value) { this.SubdomainName = value; return this; }
    }

    public static class PasswordResetResponse
    {
        public ResponseStatus ResponseStatus = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public PasswordResetResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java PasswordReset DTOs

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 /api/account/passwordreset HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	NewPassword: String,
	ConfirmPassword: String,
	Token: String,
	SubdomainName: 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
		}
	}
}