GET | /users/find/login-details | Verify a user's login details. |
---|
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 | Yes | ClubReady username |
Password | query | string | Yes | ClubReady password |
RestrictedId | query | int? | No | |
RestrictedResourceType | query | RestrictedResourceType | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserId | form | int | No | |
UserName | form | string | No | |
Password | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ApiKey | form | string | No | |
StoreId | form | int? | No | |
ChainId | form | int? | No |
Store | |
Chain | |
User | |
Undefined |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
HomeStoreId | form | int? | No | |
UserId | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
HomeStoreId | form | int? | No | |
UserId | form | int | No |
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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"HomeStoreId":0,"UserId":0,"Success":false,"Message":"String"}