efun.id.api

<back to all web services

ForgotPasswordRequest

The following routes are available for this service:
POST/api/v1/users/forgot-password
<?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 ForgotPasswordRequest implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $userName='',
        /** @var string */
        public string $email='',
        /** @var string */
        public string $session='',
        /** @var string */
        public string $captcha=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['userName'])) $this->userName = $o['userName'];
        if (isset($o['email'])) $this->email = $o['email'];
        if (isset($o['session'])) $this->session = $o['session'];
        if (isset($o['captcha'])) $this->captcha = $o['captcha'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->userName)) $o['userName'] = $this->userName;
        if (isset($this->email)) $o['email'] = $this->email;
        if (isset($this->session)) $o['session'] = $this->session;
        if (isset($this->captcha)) $o['captcha'] = $this->captcha;
        return empty($o) ? new class(){} : $o;
    }
}

PHP ForgotPasswordRequest 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 /api/v1/users/forgot-password HTTP/1.1 
Host: efun-id-api-sandbox.efun.vn 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	userName: String,
	email: String,
	session: String,
	captcha: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}