Platform API

<back to all web services

GetResetPasswordToken

Generate password reset token and send email

The following routes are available for this service:
All Verbs/api/account/{UserName}/passwordresettoken
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>
        '''Generate password reset token and send email
        '''</Summary>
        <Api(Description:="Generate password reset token and send email")>
        Public Partial Class GetResetPasswordToken
            Implements IPublicServiceModel
            '''<Summary>
            '''Get password reset token for the specified user name
            '''</Summary>
            <ApiMember(Description:="Get password reset token for the specified user name", Name:="UserName")>
            Public Overridable Property UserName As String

            Public Overridable Property ApplianceId As Guid Implements IPublicServiceModel.ApplianceId
            Public Overridable Property SubdomainName As String Implements IPublicServiceModel.SubdomainName
            Public Overridable Property SuiteId As Guid
            '''<Summary>
            '''Appliance Url for the appliance
            '''</Summary>
            <ApiMember(Description:="Appliance Url for the appliance", Name:="ApplianceLoginUrl")>
            Public Overridable Property ApplianceLoginUrl As String
        End Class

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

VB.NET GetResetPasswordToken DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/account/{UserName}/passwordresettoken HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"UserName":"String","ApplianceId":"00000000-0000-0000-0000-000000000000","SubdomainName":"String","SuiteId":"00000000-0000-0000-0000-000000000000","ApplianceLoginUrl":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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