Foundry API

<back to all web services

InitiatePasswordResetRequest

The following routes are available for this service:
POST/users/passwords/reset/initiate
import 'package:servicestack/servicestack.dart';

abstract class PostOperationUnTenanted<TResponse> implements IPost
{
    PostOperationUnTenanted();
    PostOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "PostOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class InitiatePasswordResetResponse implements IConvertible
{
    ResponseStatus? responseStatus;

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

class InitiatePasswordResetRequest extends PostOperationUnTenanted<InitiatePasswordResetResponse> implements IConvertible
{
    String? emailAddress;

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

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        emailAddress = json['emailAddress'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'emailAddress': emailAddress
    });

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

TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
    'PostOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'InitiatePasswordResetResponse': TypeInfo(TypeOf.Class, create:() => InitiatePasswordResetResponse()),
    'InitiatePasswordResetRequest': TypeInfo(TypeOf.Class, create:() => InitiatePasswordResetRequest()),
});

Dart InitiatePasswordResetRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /users/passwords/reset/initiate HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"emailAddress":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}