ClubReady Api

PasswordResetRequest

The following routes are available for this service:
POST	/users/passwordreset	Send password reset email to a user.

**PasswordResetRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	query	string	Yes	Api Key - grants access to resources
StoreId	query	integer	No	ClubReady Club ID (StoreID internally)
ChainId	query	integer	No	StoreId OR ChainId is required
Username	query	string	No	ClubReady username
Email	query	string	No	User's email address.
Filter	query	integer	No	0 = All, 1 = Prospects, 2 = Active, 3 = Inactive, 4 = All Members, 5 = Past Due
RestrictedId	body	int?	No
RestrictedResourceType	body	RestrictedResourceType	No

**PasswordResetRequestDto** Parameters:
Name	Parameter	Data Type	Required
Email	form	string	No
Username	form	string	No
Filter	form	int	No

**ApiDtoBase** Parameters:
Name	Parameter	Data Type	Required
ApiKey	form	string	No
StoreId	form	int?	No
ChainId	form	int?	No

**RestrictedResourceType** Enum:
Store
Chain
User
Undefined

**PasswordResetResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Success	form	bool	No
Message	form	string	No

**ApiResponseBase** Parameters:
Name	Parameter	Data Type	Required	Description
Success	form	bool	No
Message	form	string	No

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 /users/passwordreset HTTP/1.1 
Host: clubready.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PasswordResetRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Members.Model">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</ApiKey>
  <ChainId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</ChainId>
  <StoreId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</StoreId>
  <Email xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Email>
  <Filter xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</Filter>
  <Username xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Username>
</PasswordResetRequest>

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/ClubReady.Web.Api.Members.Model">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
</PasswordResetResponse>