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.

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubReady.Web.Api.ClubAccess.Model;
using ClubReady.Core.Api.Models;
using ClubReady.Web.Api;
using ClubReady.Core.Clubs.Models;

namespace ClubReady.Core.Api.Models
{
    public partial class ApiDtoBase
    {
        public virtual string ApiKey { get; set; }
        public virtual int? StoreId { get; set; }
        public virtual int? ChainId { get; set; }
    }

    public partial class ApiResponseBase
    {
        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class ClubVisitHistoryRequestDto
        : ApiDtoBase
    {
        public virtual DateTime FromDate { get; set; }
        public virtual DateTime ToDate { get; set; }
    }

    public partial class ClubVisitHistoryResponseDto
        : ApiResponseBase
    {
        public ClubVisitHistoryResponseDto()
        {
            Visits = new List<ClubVisitHistoryItem>{};
        }

        public virtual int TotalVisits { get; set; }
        public virtual List<ClubVisitHistoryItem> Visits { get; set; }
    }

}

namespace ClubReady.Core.Clubs.Models
{
    public partial class ClubVisitHistoryItem
    {
        public virtual int CheckinLogId { get; set; }
        public virtual int UserId { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual int CheckinStoreId { get; set; }
        public virtual string CheckinLocationName { get; set; }
        public virtual int HomeStoreId { get; set; }
        public virtual string HomeStoreLocationName { get; set; }
        public virtual DateTime UtcTime { get; set; }
    }

}

namespace ClubReady.Web.Api
{
    public enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined,
    }

}

namespace ClubReady.Web.Api.ClubAccess.Model
{
    public partial class ClubVisitHistoryRequest
        : ClubVisitHistoryRequestDto, IRestrictedApiRequest
    {
        ///<summary>
        ///Api Key - grants access to resources
        ///</summary>
        [ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///Either StoreId or ChainId is required
        ///</summary>
        [ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")]
        public virtual int? StoreId { get; set; }

        ///<summary>
        ///Either StoreId or ChainId is required
        ///</summary>
        [ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")]
        public virtual int? ChainId { get; set; }

        ///<summary>
        ///UTC Format
        ///</summary>
        [ApiMember(DataType="date", Description="UTC Format", IsRequired=true, Name="FromDate", ParameterType="query")]
        public virtual DateTime FromDate { get; set; }

        ///<summary>
        ///Max 24 Hours (UTC Format)
        ///</summary>
        [ApiMember(DataType="date", Description="Max 24 Hours (UTC Format)", IsRequired=true, Name="ToDate", ParameterType="query")]
        public virtual DateTime ToDate { get; set; }

        public virtual int? RestrictedId { get; set; }
        public virtual RestrictedResourceType RestrictedResourceType { get; set; }
    }

    public partial class ClubVisitHistoryResponse
        : ClubVisitHistoryResponseDto
    {
        public ClubVisitHistoryResponse()
        {
            Visits = new List<ClubVisitHistoryItem>{};
        }

        public virtual bool Success { get; set; }
        public virtual string Message { get; set; }
        public virtual int TotalVisits { get; set; }
        public virtual List<ClubVisitHistoryItem> Visits { get; set; }
    }

}

C# ClubVisitHistoryRequest DTOs

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>