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.
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ForgotUserPasswordResponse() = 
        member val Email:String = null with get,set
        member val ResponseStatus:Object = null with get,set

    type KeyCloakRealm =
        | BookMore = 1
        | BookMoreAdmin = 2
        | SuperAdmin = 3

    [<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)>]
    [<AllowNullLiteral>]
    type ForgotUserPassword() = 
        [<ApiMember(IsRequired=true)>]
        member val Email:String = null with get,set

        ///<summary>
        ///The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 
        ///</summary>
        [<ApiMember(Description="The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 ", IsRequired=true)>]
        member val Realm:KeyCloakRealm = new KeyCloakRealm() with get,set

F# 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":{}}