ClubReady Api

<back to all web services

DoCheckInRequest

Check a user into a club

The following routes are available for this service:
POST/users/checkinCheck User Into Club
DoCheckInRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
BarcodequerystringYesUser barcode
StoreIdqueryintegerYesClubReady StoreId required
UserIdqueryintegerNoUserId to check into club
RestrictedIdbodyint?No
RestrictedResourceTypebodyRestrictedResourceTypeNo
DoCheckInRequestDto Parameters:
NameParameterData TypeRequiredDescription
BarcodeformstringNo
UserIdformint?No
UtcTimeStampformDateTimeNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined

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.

POST /users/checkin HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: String,
	Barcode: String,
	StoreId: 0,
	UserId: 0,
	RestrictedId: 0,
	RestrictedResourceType: Store,
	UtcTimeStamp: 0001-01-01,
	ChainId: 0
}