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

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

    /** @description Confirm the new password */
    // @ApiMember(Description="Confirm the new password", Name="ConfirmPassword")
    public ConfirmPassword: string;

    /** @description Password Reset Token */
    // @ApiMember(Description="Password Reset Token", Name="Token")
    public Token: string;

    public ApplianceId: string;
    public SubdomainName: string;

    public constructor(init?: Partial<PasswordReset>) { (Object as any).assign(this, init); }
}

export class PasswordResetResponse
{
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<PasswordResetResponse>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	}
}