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 'package:servicestack/servicestack.dart';

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

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

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

    String? ApplianceId;
    String? SubdomainName;

    PasswordReset({this.NewPassword,this.ConfirmPassword,this.Token,this.ApplianceId,this.SubdomainName});
    PasswordReset.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        NewPassword = json['NewPassword'];
        ConfirmPassword = json['ConfirmPassword'];
        Token = json['Token'];
        ApplianceId = json['ApplianceId'];
        SubdomainName = json['SubdomainName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'NewPassword': NewPassword,
        'ConfirmPassword': ConfirmPassword,
        'Token': Token,
        'ApplianceId': ApplianceId,
        'SubdomainName': SubdomainName
    };

    getTypeName() => "PasswordReset";
    TypeContext? context = _ctx;
}

class PasswordResetResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;

    PasswordResetResponse({this.ResponseStatus});
    PasswordResetResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "PasswordResetResponse";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'PasswordReset': TypeInfo(TypeOf.Class, create:() => PasswordReset()),
    'PasswordResetResponse': TypeInfo(TypeOf.Class, create:() => PasswordResetResponse()),
});

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