BokaMera.API.Host

ForgotUserPassword

The following routes are available for this service:
POST	/users/forgotpassword	Forgot Password for user	Will send a restore password link to the user by the email provided.

import 'package:servicestack/servicestack.dart';

class ForgotUserPasswordResponse implements IConvertible
{
    String? Email;
    dynamic? ResponseStatus;

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

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

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

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

enum KeyCloakRealm
{
    BookMore,
    BookMoreAdmin,
    SuperAdmin,
}

// @ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
class ForgotUserPassword implements IConvertible
{
    // @ApiMember(IsRequired=true)
    String? Email;

    /**
    * The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 
    */
    // @ApiMember(Description="The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 ", IsRequired=true)
    KeyCloakRealm? Realm;

    ForgotUserPassword({this.Email,this.Realm});
    ForgotUserPassword.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
    'ForgotUserPasswordResponse': TypeInfo(TypeOf.Class, create:() => ForgotUserPasswordResponse()),
    'KeyCloakRealm': TypeInfo(TypeOf.Enum, enumValues:KeyCloakRealm.values),
    'ForgotUserPassword': TypeInfo(TypeOf.Class, create:() => ForgotUserPassword()),
});

Dart ForgotUserPassword 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 /users/forgotpassword HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Email: String,
	Realm: BookMore
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Email: String,
	ResponseStatus: {}
}