Platform API

<back to all web services

GetResetPasswordToken

Generate password reset token and send email

The following routes are available for this service:
All Verbs/api/account/{UserName}/passwordresettoken
import 'package:servicestack/servicestack.dart';

/**
* Generate password reset token and send email
*/
// @Api(Description="Generate password reset token and send email")
class GetResetPasswordToken implements IPublicServiceModel, IConvertible
{
    /**
    * Get password reset token for the specified user name
    */
    // @ApiMember(Description="Get password reset token for the specified user name", Name="UserName")
    String? UserName;

    String? ApplianceId;
    String? SubdomainName;
    String? SuiteId;
    /**
    * Appliance Url for the appliance
    */
    // @ApiMember(Description="Appliance Url for the appliance", Name="ApplianceLoginUrl")
    String? ApplianceLoginUrl;

    GetResetPasswordToken({this.UserName,this.ApplianceId,this.SubdomainName,this.SuiteId,this.ApplianceLoginUrl});
    GetResetPasswordToken.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        UserName = json['UserName'];
        ApplianceId = json['ApplianceId'];
        SubdomainName = json['SubdomainName'];
        SuiteId = json['SuiteId'];
        ApplianceLoginUrl = json['ApplianceLoginUrl'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'UserName': UserName,
        'ApplianceId': ApplianceId,
        'SubdomainName': SubdomainName,
        'SuiteId': SuiteId,
        'ApplianceLoginUrl': ApplianceLoginUrl
    };

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

class GetResetPasswordTokenResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;

    GetResetPasswordTokenResponse({this.ResponseStatus});
    GetResetPasswordTokenResponse.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() => "GetResetPasswordTokenResponse";
    TypeContext? context = _ctx;
}

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

Dart GetResetPasswordToken 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/{UserName}/passwordresettoken HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UserName: String,
	SubdomainName: String,
	ApplianceLoginUrl: 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
		}
	}
}