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
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Reset password for the specified user
    ///</summary>
    [<Api(Description="Reset password for the specified user")>]
    [<AllowNullLiteral>]
    type PasswordReset() = 
        ///<summary>
        ///New password for the user account
        ///</summary>
        [<ApiMember(Description="New password for the user account", Name="NewPassword")>]
        member val NewPassword:String = null with get,set

        ///<summary>
        ///Confirm the new password
        ///</summary>
        [<ApiMember(Description="Confirm the new password", Name="ConfirmPassword")>]
        member val ConfirmPassword:String = null with get,set

        ///<summary>
        ///Password Reset Token
        ///</summary>
        [<ApiMember(Description="Password Reset Token", Name="Token")>]
        member val Token:String = null with get,set

        member val ApplianceId:Guid = new Guid() with get,set
        member val SubdomainName:String = null with get,set

    [<AllowNullLiteral>]
    type PasswordResetResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set

F# 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"}}}