BokaMera.API.Host

<back to all web services

ForgotUserPassword

The following routes are available for this service:
POST/users/forgotpasswordForgot Password for userWill send a restore password link to the user by the email provided.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @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)
    public static class ForgotUserPassword
    {
        @ApiMember(IsRequired=true)
        public String Email = null;

        /**
        * The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 
        */
        @ApiMember(Description="The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 ", IsRequired=true)
        public KeyCloakRealm Realm = null;
        
        public String getEmail() { return Email; }
        public ForgotUserPassword setEmail(String value) { this.Email = value; return this; }
        public KeyCloakRealm getRealm() { return Realm; }
        public ForgotUserPassword setRealm(KeyCloakRealm value) { this.Realm = value; return this; }
    }

    public static enum KeyCloakRealm
    {
        BookMore(1),
        BookMoreAdmin(2),
        SuperAdmin(3);

        private final int value;
        KeyCloakRealm(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    public static class ForgotUserPasswordResponse
    {
        public String Email = null;
        public Object ResponseStatus = null;
        
        public String getEmail() { return Email; }
        public ForgotUserPasswordResponse setEmail(String value) { this.Email = value; return this; }
        public Object getResponseStatus() { return ResponseStatus; }
        public ForgotUserPasswordResponse setResponseStatus(Object value) { this.ResponseStatus = value; return this; }
    }

}

Java ForgotUserPassword 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/forgotpassword HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Email":"String","Realm":"BookMore"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Email":"String","ResponseStatus":{}}