Platform API

<back to all web services

GetResetPasswordToken

Generate password reset token and send email

<?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};


/** @description Generate password reset token and send email */
// @Api(Description="Generate password reset token and send email")
class GetResetPasswordToken implements IPublicServiceModel, JsonSerializable
{
    public function __construct(
        /** @description Get password reset token for the specified user name */
        // @ApiMember(Description="Get password reset token for the specified user name", Name="UserName")
        /** @var string|null */
        public ?string $UserName=null,

        /** @var string */
        public string $ApplianceId='',
        /** @var string|null */
        public ?string $SubdomainName=null,
        /** @var string */
        public string $SuiteId='',
        /** @description Appliance Url for the appliance */
        // @ApiMember(Description="Appliance Url for the appliance", Name="ApplianceLoginUrl")
        /** @var string|null */
        public ?string $ApplianceLoginUrl=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['UserName'])) $this->UserName = $o['UserName'];
        if (isset($o['ApplianceId'])) $this->ApplianceId = $o['ApplianceId'];
        if (isset($o['SubdomainName'])) $this->SubdomainName = $o['SubdomainName'];
        if (isset($o['SuiteId'])) $this->SuiteId = $o['SuiteId'];
        if (isset($o['ApplianceLoginUrl'])) $this->ApplianceLoginUrl = $o['ApplianceLoginUrl'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->UserName)) $o['UserName'] = $this->UserName;
        if (isset($this->ApplianceId)) $o['ApplianceId'] = $this->ApplianceId;
        if (isset($this->SubdomainName)) $o['SubdomainName'] = $this->SubdomainName;
        if (isset($this->SuiteId)) $o['SuiteId'] = $this->SuiteId;
        if (isset($this->ApplianceLoginUrl)) $o['ApplianceLoginUrl'] = $this->ApplianceLoginUrl;
        return empty($o) ? new class(){} : $o;
    }
}

class GetResetPasswordTokenResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

PHP GetResetPasswordToken DTOs

POST /api/account/{UserName}/passwordresettoken HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UserName: String,
	SubdomainName: String,
	ApplianceLoginUrl: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}