| POST | /users/passwordreset | Send password reset email to a user. |
|---|
namespace ClubReady.Core.Api.Models
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ApiDtoBase() =
member val ApiKey:String = null with get,set
member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<AllowNullLiteral>]
type PasswordResetRequestDto() =
inherit ApiDtoBase()
member val Email:String = null with get,set
member val Username:String = null with get,set
member val Filter:Int32 = new Int32() with get,set
type RestrictedResourceType =
| Store = 0
| Chain = 1
| User = 2
| Undefined = 3
[<AllowNullLiteral>]
type PasswordResetRequest() =
inherit PasswordResetRequestDto()
///<summary>
///Api Key - grants access to resources
///</summary>
[<ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")>]
member val ApiKey:String = null with get,set
///<summary>
///ClubReady Club ID (StoreID internally)
///</summary>
[<ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", Name="StoreId", ParameterType="query")>]
member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///StoreId OR ChainId is required
///</summary>
[<ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")>]
member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///ClubReady username
///</summary>
[<ApiMember(DataType="string", Description="ClubReady username", Name="UserName", ParameterType="query")>]
member val Username:String = null with get,set
///<summary>
///User's email address.
///</summary>
[<ApiMember(DataType="string", Description="User's email address.", Name="Email", ParameterType="query")>]
member val Email:String = null with get,set
///<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")>]
member val Filter:Int32 = new Int32() with get,set
member val RestrictedId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val RestrictedResourceType:RestrictedResourceType = new RestrictedResourceType() with get,set
[<AllowNullLiteral>]
type ApiResponseBase() =
member val Success:Boolean = new Boolean() with get,set
member val Message:String = null with get,set
[<AllowNullLiteral>]
type PasswordResetResponseDto() =
inherit ApiResponseBase()
[<AllowNullLiteral>]
type PasswordResetResponse() =
inherit PasswordResetResponseDto()
member val Success:Boolean = new Boolean() with get,set
member val Message:String = null with get,set
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
}