Platform API

PasswordReset

Reset password for the specified user

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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel

Namespace Global

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Reset password for the specified user
        '''</Summary>
        <Api(Description:="Reset password for the specified user")>
        Public Partial Class PasswordReset
            Implements IPublicServiceModel
            '''<Summary>
            '''New password for the user account
            '''</Summary>
            <ApiMember(Description:="New password for the user account", Name:="NewPassword")>
            Public Overridable Property NewPassword As String

            '''<Summary>
            '''Confirm the new password
            '''</Summary>
            <ApiMember(Description:="Confirm the new password", Name:="ConfirmPassword")>
            Public Overridable Property ConfirmPassword As String

            '''<Summary>
            '''Password Reset Token
            '''</Summary>
            <ApiMember(Description:="Password Reset Token", Name:="Token")>
            Public Overridable Property Token As String

            Public Overridable Property ApplianceId As Guid Implements IPublicServiceModel.ApplianceId
            Public Overridable Property SubdomainName As String Implements IPublicServiceModel.SubdomainName
        End Class

        Public Partial Class PasswordResetResponse
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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>