ClubReady Api

<back to all web services

PasswordResetRequest

The following routes are available for this service:
POST/users/passwordresetSend password reset email to a user.
PasswordResetRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdqueryintegerNoClubReady Club ID (StoreID internally)
ChainIdqueryintegerNoStoreId OR ChainId is required
UsernamequerystringNoClubReady username
EmailquerystringNoUser's email address.
FilterqueryintegerNo0 = All, 1 = Prospects, 2 = Active, 3 = Inactive, 4 = All Members, 5 = Past Due
RestrictedIdbodyint?No
RestrictedResourceTypebodyRestrictedResourceTypeNo
PasswordResetRequestDto Parameters:
NameParameterData TypeRequiredDescription
EmailformstringNo
UsernameformstringNo
FilterformintNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
PasswordResetResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
ApiResponseBase Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo

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

HTTP + 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: www.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
}