| POST | /users/checkin | Check User Into Club |
|---|
| 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 |
| Barcode | query | string | Yes | User barcode |
| StoreId | query | integer | Yes | ClubReady StoreId required |
| UserId | query | integer | No | UserId to check into club |
| RestrictedId | body | int? | No | |
| RestrictedResourceType | body | RestrictedResourceType | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Barcode | form | string | No | |
| UserId | form | int? | No | |
| UtcTimeStamp | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | No | |
| StoreId | form | int? | No | |
| ChainId | form | int? | No |
| Store | |
| Chain | |
| User | |
| Undefined |
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.
POST /users/checkin HTTP/1.1
Host: www.clubready.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"XForwardedFor":"String","ApiKey":"String","Barcode":"String","StoreId":0,"UserId":0,"RestrictedId":0,"RestrictedResourceType":"Store","UtcTimeStamp":"0001-01-01T00:00:00.0000000","ChainId":0}