ClubReady Api

<back to all web services

UserFindByLoginRequest

The following routes are available for this service:
GET/users/find/login-detailsVerify a user's login details.
UserFindByLoginRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdqueryintegerNoClubReady Club ID (StoreID internally)
ChainIdqueryintegerNoStoreId OR ChainId is required
UserNamequerystringYesClubReady username
PasswordquerystringYesClubReady password
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
UserFindByLoginRequestDto Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
UserNameformstringNo
PasswordformstringNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
UserFindByLoginResponse Parameters:
NameParameterData TypeRequiredDescription
HomeStoreIdformint?No
UserIdformintNo
UserFindByLoginResponseDto Parameters:
NameParameterData TypeRequiredDescription
HomeStoreIdformint?No
UserIdformintNo
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.

GET /users/find/login-details HTTP/1.1 
Host: clubready.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	HomeStoreId: 0,
	UserId: 0,
	Success: False,
	Message: String
}