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.

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class ForgotUserPasswordResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Email=null,
        /** @var Object|null */
        public ?Object $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Email'])) $this->Email = $o['Email'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('Object', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Email)) $o['Email'] = $this->Email;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('Object', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

enum KeyCloakRealm : int
{
    case BookMore = 1;
    case BookMoreAdmin = 2;
    case 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)
class ForgotUserPassword implements JsonSerializable
{
    public function __construct(
        // @ApiMember(IsRequired=true)
        /** @var string */
        public string $Email='',

        /** @description The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2  */
        // @ApiMember(Description="The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 ", IsRequired=true)
        /** @var KeyCloakRealm|null */
        public ?KeyCloakRealm $Realm=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Email'])) $this->Email = $o['Email'];
        if (isset($o['Realm'])) $this->Realm = JsonConverters::from('KeyCloakRealm', $o['Realm']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Email)) $o['Email'] = $this->Email;
        if (isset($this->Realm)) $o['Realm'] = JsonConverters::to('KeyCloakRealm', $this->Realm);
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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: testapi.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: {}
}