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 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 .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"NewPassword":"String","ConfirmPassword":"String","Token":"String","ApplianceId":"00000000-0000-0000-0000-000000000000","SubdomainName":"String"}

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

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