ClubReady Api

ClubVisitHistoryRequest

The following routes are available for this service:
GET	/club/visit-history	Return list of club visits, by club or entire chain.

**ClubVisitHistoryRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	query	string	Yes	Api Key - grants access to resources
StoreId	query	integer	No	Either StoreId or ChainId is required
ChainId	query	integer	No	Either StoreId or ChainId is required
FromDate	query	date	Yes	UTC Format
ToDate	query	date	Yes	Max 24 Hours (UTC Format)
RestrictedId	query	int?	No
RestrictedResourceType	query	RestrictedResourceType	No

**ClubVisitHistoryRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
FromDate	form	DateTime	No
ToDate	form	DateTime	No

**ApiDtoBase** Parameters:
Name	Parameter	Data Type	Required
ApiKey	form	string	No
StoreId	form	int?	No
ChainId	form	int?	No

**RestrictedResourceType** Enum:
Store
Chain
User
Undefined

**ClubVisitHistoryResponse** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
Message	form	string	No
TotalVisits	form	int	No
Visits	form	List<ClubVisitHistoryItem>	No

**ClubVisitHistoryResponseDto** Parameters:
Name	Parameter	Data Type	Required	Description
TotalVisits	form	int	No
Visits	form	List<ClubVisitHistoryItem>	No

**ApiResponseBase** Parameters:
Name	Parameter	Data Type	Required	Description
Success	form	bool	No
Message	form	string	No

**ClubVisitHistoryItem** Parameters:
Name	Parameter	Data Type	Required
CheckinLogId	form	int	No
UserId	form	int	No
FirstName	form	string	No
LastName	form	string	No
CheckinStoreId	form	int	No
CheckinLocationName	form	string	No
HomeStoreId	form	int	No
HomeStoreLocationName	form	string	No
UtcTime	form	DateTime	No

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

HTTP + XML

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: clubready.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ClubVisitHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.ClubAccess.Model">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
  <TotalVisits xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</TotalVisits>
  <Visits xmlns:d2p1="http://schemas.datacontract.org/2004/07/ClubReady.Core.Clubs.Models" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
    <d2p1:ClubVisitHistoryItem>
      <d2p1:CheckinLocationName>String</d2p1:CheckinLocationName>
      <d2p1:CheckinLogId>0</d2p1:CheckinLogId>
      <d2p1:CheckinStoreId>0</d2p1:CheckinStoreId>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:HomeStoreId>0</d2p1:HomeStoreId>
      <d2p1:HomeStoreLocationName>String</d2p1:HomeStoreLocationName>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:UserId>0</d2p1:UserId>
      <d2p1:UtcTime>0001-01-01T00:00:00</d2p1:UtcTime>
    </d2p1:ClubVisitHistoryItem>
  </Visits>
</ClubVisitHistoryResponse>