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
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Reset password for the specified user
    */
    @Api(Description="Reset password for the specified user")
    public static class PasswordReset implements IPublicServiceModel
    {
        /**
        * New password for the user account
        */
        @ApiMember(Description="New password for the user account", Name="NewPassword")
        public String NewPassword = null;

        /**
        * Confirm the new password
        */
        @ApiMember(Description="Confirm the new password", Name="ConfirmPassword")
        public String ConfirmPassword = null;

        /**
        * Password Reset Token
        */
        @ApiMember(Description="Password Reset Token", Name="Token")
        public String Token = null;

        public UUID ApplianceId = null;
        public String SubdomainName = null;
        
        public String getNewPassword() { return NewPassword; }
        public PasswordReset setNewPassword(String value) { this.NewPassword = value; return this; }
        public String getConfirmPassword() { return ConfirmPassword; }
        public PasswordReset setConfirmPassword(String value) { this.ConfirmPassword = value; return this; }
        public String getToken() { return Token; }
        public PasswordReset setToken(String value) { this.Token = value; return this; }
        public UUID getApplianceId() { return ApplianceId; }
        public PasswordReset setApplianceId(UUID value) { this.ApplianceId = value; return this; }
        public String getSubdomainName() { return SubdomainName; }
        public PasswordReset setSubdomainName(String value) { this.SubdomainName = value; return this; }
    }

    public static class PasswordResetResponse
    {
        public ResponseStatus ResponseStatus = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public PasswordResetResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java PasswordReset DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<PasswordReset xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ApplianceId>00000000-0000-0000-0000-000000000000</ApplianceId>
  <ConfirmPassword>String</ConfirmPassword>
  <NewPassword>String</NewPassword>
  <SubdomainName>String</SubdomainName>
  <Token>String</Token>
</PasswordReset>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PasswordResetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</PasswordResetResponse>