| POST | /users/passwordreset | Send password reset email to a user. |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubReady.Web.Api.Members.Model
Imports ClubReady.Core.Api.Models
Imports ClubReady.Web.Api
Namespace Global
Namespace ClubReady.Core.Api.Models
Public Partial Class ApiDtoBase
Public Overridable Property ApiKey As String
Public Overridable Property StoreId As Nullable(Of Integer)
Public Overridable Property ChainId As Nullable(Of Integer)
End Class
Public Partial Class ApiResponseBase
Public Overridable Property Success As Boolean
Public Overridable Property Message As String
End Class
Public Partial Class PasswordResetRequestDto
Inherits ApiDtoBase
Public Overridable Property Email As String
Public Overridable Property Username As String
Public Overridable Property Filter As Integer
End Class
Public Partial Class PasswordResetResponseDto
Inherits ApiResponseBase
End Class
End Namespace
Namespace ClubReady.Web.Api
Public Enum RestrictedResourceType
Store
Chain
User
Undefined
End Enum
End Namespace
Namespace ClubReady.Web.Api.Members.Model
Public Partial Class PasswordResetRequest
Inherits PasswordResetRequestDto
Implements IRestrictedApiRequest
'''<Summary>
'''Api Key - grants access to resources
'''</Summary>
<ApiMember(DataType:="string", Description:="Api Key - grants access to resources", IsRequired:=true, Name:="ApiKey", ParameterType:="query")>
Public Overridable Property ApiKey As String
'''<Summary>
'''ClubReady Club ID (StoreID internally)
'''</Summary>
<ApiMember(DataType:="integer", Description:="ClubReady Club ID (StoreID internally)", Name:="StoreId", ParameterType:="query")>
Public Overridable Property StoreId As Nullable(Of Integer)
'''<Summary>
'''StoreId OR ChainId is required
'''</Summary>
<ApiMember(DataType:="integer", Description:="StoreId OR ChainId is required", Name:="ChainId", ParameterType:="query")>
Public Overridable Property ChainId As Nullable(Of Integer)
'''<Summary>
'''ClubReady username
'''</Summary>
<ApiMember(DataType:="string", Description:="ClubReady username", Name:="UserName", ParameterType:="query")>
Public Overridable Property Username As String
'''<Summary>
'''User's email address.
'''</Summary>
<ApiMember(DataType:="string", Description:="User's email address.", Name:="Email", ParameterType:="query")>
Public Overridable Property Email As String
'''<Summary>
'''0 = All, 1 = Prospects, 2 = Active, 3 = Inactive, 4 = All Members, 5 = Past Due
'''</Summary>
<ApiMember(DataType:="integer", Description:="0 = All, 1 = Prospects, 2 = Active, 3 = Inactive, 4 = All Members, 5 = Past Due", Name:="Filter", ParameterType:="query")>
Public Overridable Property Filter As Integer
Public Overridable Property RestrictedId As Nullable(Of Integer)
Public Overridable Property RestrictedResourceType As RestrictedResourceType
End Class
Public Partial Class PasswordResetResponse
Inherits PasswordResetResponseDto
Public Overridable Property Success As Boolean
Public Overridable Property Message As String
End Class
End Namespace
End Namespace
VB.NET PasswordResetRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /users/passwordreset HTTP/1.1
Host: clubready.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ApiKey: String,
StoreId: 0,
ChainId: 0,
Username: String,
Email: String,
Filter: 0,
RestrictedId: 0,
RestrictedResourceType: Chain
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Success: False,
Message: String
}