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.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Enums;

namespace BokaMera.API.ServiceModel.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 partial class ForgotUserPassword
    {
        [ApiMember(IsRequired=true)]
        public virtual string Email { 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)]
        public virtual KeyCloakRealm Realm { get; set; }
    }

    public partial class ForgotUserPasswordResponse
    {
        public virtual string Email { get; set; }
        public virtual Object ResponseStatus { get; set; }
    }

}

namespace BokaMera.API.ServiceModel.Enums
{
    public enum KeyCloakRealm
    {
        BookMore = 1,
        BookMoreAdmin = 2,
        SuperAdmin = 3,
    }

}

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