Platform API

PasswordReset

Reset password for the specified user

The following routes are available for this service:
All Verbs	/api/account/passwordreset

import Foundation
import ServiceStack

/**
* Reset password for the specified user
*/
// @Api(Description="Reset password for the specified user")
public class PasswordReset : IPublicServiceModel, Codable
{
    /**
    * New password for the user account
    */
    // @ApiMember(Description="New password for the user account", Name="NewPassword")
    public var newPassword:String

    /**
    * Confirm the new password
    */
    // @ApiMember(Description="Confirm the new password", Name="ConfirmPassword")
    public var confirmPassword:String

    /**
    * Password Reset Token
    */
    // @ApiMember(Description="Password Reset Token", Name="Token")
    public var token:String

    public var applianceId:String
    public var subdomainName:String

    required public init(){}
}

public class PasswordResetResponse : Codable
{
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift 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
		}
	}
}