ClubReady Api

<back to all web services

ClubVisitHistoryRequest

The following routes are available for this service:
GET/club/visit-historyReturn list of club visits, by club or entire chain.
ClubVisitHistoryRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyquerystringYesApi Key - grants access to resources
StoreIdqueryintegerNoEither StoreId or ChainId is required
ChainIdqueryintegerNoEither StoreId or ChainId is required
FromDatequerydateYesUTC Format
ToDatequerydateYesMax 24 Hours (UTC Format)
RestrictedIdqueryint?No
RestrictedResourceTypequeryRestrictedResourceTypeNo
ClubVisitHistoryRequestDto Parameters:
NameParameterData TypeRequiredDescription
FromDateformDateTimeNo
ToDateformDateTimeNo
ApiDtoBase Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringNo
StoreIdformint?No
ChainIdformint?No
RestrictedResourceType Enum:
Store
Chain
User
Undefined
ClubVisitHistoryResponse Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
TotalVisitsformintNo
VisitsformList<ClubVisitHistoryItem>No
ClubVisitHistoryResponseDto Parameters:
NameParameterData TypeRequiredDescription
TotalVisitsformintNo
VisitsformList<ClubVisitHistoryItem>No
ApiResponseBase Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
MessageformstringNo
ClubVisitHistoryItem Parameters:
NameParameterData TypeRequiredDescription
CheckinLogIdformintNo
UserIdformintNo
FirstNameformstringNo
LastNameformstringNo
CheckinStoreIdformintNo
CheckinLocationNameformstringNo
HomeStoreIdformintNo
HomeStoreLocationNameformstringNo
UtcTimeformDateTimeNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /club/visit-history HTTP/1.1 
Host: www.clubready.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Success":false,"Message":"String","TotalVisits":0,"Visits":[{"CheckinLogId":0,"UserId":0,"FirstName":"String","LastName":"String","CheckinStoreId":0,"CheckinLocationName":"String","HomeStoreId":0,"HomeStoreLocationName":"String","UtcTime":"0001-01-01T00:00:00.0000000"}]}