ClubReady Api

UserFindByLoginRequest

The following routes are available for this service:
GET	/users/find/login-details	Verify a user's login details.

**UserFindByLoginRequest** Parameters:
Name	Parameter	Data Type	Required	Description
XForwardedFor	header	string	No	IP address of the end user
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	Yes	ClubReady username
Password	query	string	Yes	ClubReady password
RestrictedId	query	int?	No
RestrictedResourceType	query	RestrictedResourceType	No

**UserFindByLoginRequestDto** Parameters:
Name	Parameter	Data Type	Required
UserId	form	int	No
UserName	form	string	No
Password	form	string	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

**UserFindByLoginResponse** Parameters:
Name	Parameter	Data Type	Required
AuthenticationResult	form	AuthenticationResult	No
HomeStoreId	form	int?	No
UserId	form	int	No

**UserFindByLoginResponseDto** Parameters:
Name	Parameter	Data Type	Required	Description
HomeStoreId	form	int?	No
UserId	form	int	No

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

**AuthenticationResult** Enum:
Name	Value
InvalidPassword	0
SuccessExpired	11
SuccessChangePassword	12
SuccessWeakPassword	21
Success	31
CryptographicError	-100
Disabled	-22
Locked	-21
FailedPasswordHistory	-15
FailedWeakPassword	-12
InvalidConfirmation	-11
Error	-1

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.

GET /users/find/login-details HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserFindByLoginResponse 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>
  <HomeStoreId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</HomeStoreId>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</UserId>
  <AuthenticationResult>InvalidPassword</AuthenticationResult>
</UserFindByLoginResponse>