Platform API

<back to all web services

PasswordReset

Reset password for the specified user

The following routes are available for this service:
All Verbs/api/account/passwordreset
<?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 Reset password for the specified user */
// @Api(Description="Reset password for the specified user")
class PasswordReset implements IPublicServiceModel, JsonSerializable
{
    public function __construct(
        /** @description New password for the user account */
        // @ApiMember(Description="New password for the user account", Name="NewPassword")
        /** @var string|null */
        public ?string $NewPassword=null,

        /** @description Confirm the new password */
        // @ApiMember(Description="Confirm the new password", Name="ConfirmPassword")
        /** @var string|null */
        public ?string $ConfirmPassword=null,

        /** @description Password Reset Token */
        // @ApiMember(Description="Password Reset Token", Name="Token")
        /** @var string|null */
        public ?string $Token=null,

        /** @var string */
        public string $ApplianceId='',
        /** @var string|null */
        public ?string $SubdomainName=null
    ) {
    }

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

class PasswordResetResponse 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 PasswordReset 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/account/passwordreset HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	NewPassword: String,
	ConfirmPassword: String,
	Token: String,
	SubdomainName: 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
		}
	}
}